api.serve_openapi_invalid: An API's serve_openapi: setting holds something other than true or false

An API's serve_openapi: setting holds something other than true or false.

Area 7, HTTP; not declinable; the next step is usually the agent's.

Why Jadpo refuses it

serve_openapi: says whether the API serves its OpenAPI document, the description of its routes that other apps read to call it, at <prefix>/openapi.json. The setting has only two answers. Any other value is a mistake, and Jadpo won't guess whether "no" or 0 meant off.

What it looks like

app.jadpo:

example

application {    apis: {        admin: {            prefix: /admin            serve_openapi: "no"        }    }}

jadpo checkcheck failed: 1 error, 1 file

error "no" isn't true or false

--> app.jadpo:5:28

  |5 |             serve_openapi: "no"  |                            ^^^^ not a `Bool`

reason: serve_openapi: says whether the API serves its OpenAPI document at <prefix>/openapi.json: false turns it off, and true, the default, can be left out.
next: Write serve_openapi: false, or leave serve_openapi: out (agent)
rule: api.serve_openapi_invalid
help: https://jadpo.dev/docs/errors/api.serve_openapi_invalid

(agent) at the end of the next: line means your coding agent can make the fix itself.

How to fix it

If the API shouldn't serve its document, write false. In app.jadpo:

example

            serve_openapi: false

The API stops serving /admin/openapi.json, and the route that served it leaves the API's record and jadpo routes.

If it should, delete the serve_openapi: line, since serving the document is the default. app.jadpo becomes:

example

application {    apis: {        admin: {            prefix: /admin        }    }}

The API serves its document at /admin/openapi.json.

Why Jadpo refuses it

What it looks like

How to fix it

Related