Ir al contenido
#0736
Exec

The prospect asks for API docs; you send a URL you never wrote

Tuesday, 4:12 PM. An enterprise prospect replies: "Looks good: can you send API documentation?" You never wrote any. Your API is a folder of exec scripts; the docs would just be that folder, described.

So that's what you generate. POST /api/v1/exec/user-openapi/generate walks your scripts and writes an OpenAPI spec. /merge folds in the descriptions you keep by hand. The result serves at /api/v1/exec/user-openapi/spec: a URL, like everything else on the box.

You paste that URL into the reply at 4:19. Seven minutes, and most of that was the coffee. The prospect loads it into their client generator and starts integrating that afternoon.

The spec was read off the deployment, so it can't describe anything that isn't there.