overlane api openapi | Overlane Docs

Fetches the OpenAPI document generated from the API route tables and the contracts. By default prints its version and counts; with –full the JSON result carries the whole document. The same document is committed at docs/api/openapi.json and the TypeScript SDK is generated from it.

Usage

overlane api openapi [--service URL] [--full]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--full`	boolean	no		Include the whole document in the JSON result

Examples

overlane api openapi
overlane api openapi --full --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema api openapi.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string"
    },
    "operations": {
      "type": "number"
    },
    "schemas": {
      "type": "number"
    },
    "document": {}
  },
  "required": [
    "version",
    "operations",
    "schemas"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.