Skip to main content

Module openapi

Module openapi 

Source
Expand description

OpenAPI spec generation from a ServiceManifest.

This module is used by both the platform (server-side) and the CLI (local generation without deployment).

Structs§

OpenApiError
A manifest whose docs cannot form a spec.

Enums§

PathStyle
Where a spec’s paths are rooted.

Functions§

default_style
Server-relative once the service documents itself (openapi options or any route doc), absolute otherwise.
generate_openapi
The service’s OpenAPI 3.1 document.
service_spec
The spec a deployed or local service is served with: in its default_style.
validate
Check a documented manifest: operation ids unique across its published custom and CRUD operations, no two published routes documenting the same method and path, path = T naming exactly the route’s path parameters, query and path parameters that are scalars or arrays, security schemes the document defines, and no DTO sharing a table schema’s name. An undocumented manifest passes: its spec is today’s.