Skip to main content

Module description

Module description 

Source
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§

ServiceInfo
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 info member 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 :parameter path to the OpenAPI template syntax.