Expand description
Machine-readable service description (specification section 9).
The same route registry is rendered twice: once as the native Links Notation
description served at /.well-known/lino-api, and once as an OpenAPI 3.1
document served at /.well-known/openapi.json, so that existing tooling keeps
working against a Links Notation API.
Structs§
- Service
Info - Title, version and optional prose description of a service.
Constants§
- LINO_
API_ DESCRIPTION_ VERSION - Version of the description document this package emits.
Functions§
- info_
object - Render the
infomember shared by both description documents. - openapi_
document - Build an OpenAPI 3.1 document describing the service.
- path_
parameters - Extract the path parameters of a path pattern.
- service_
description - Build the native service description.
- to_
openapi_ path - Convert a
:parameterpath to the OpenAPI template syntax.