Module

PuduLangDocgen.Rest.OpenApi

HTTP interface descriptions read into operations and schemas

Types

Name	Description
`Parameter`	One request parameter and where it is sent
`Payload`	A body for one media type
`Response`	One documented response
`Operation`	One method on one path
`Property`	One property of an object schema
`Schema`	A named schema with its properties or shape
`Service`	A described HTTP interface

Name	Description
`recognizes`	Whether metadata is an HTTP interface description.
`read`	The service a description declares.
`describe`	A short description of a schema's type, naming referenced schemas by name.
`refName`	The schema name at the end of a local reference such as `#/components/schemas/Pet`.

fn recognizes(value: &Docgen.Meta) -> Bool

Whether metadata is an HTTP interface description.

Bool

fn read(value: &Docgen.Meta) -> Result[Service, Str]

The service a description declares.

Result[Service, Str]

fn describe(value: &Docgen.Meta) -> Str

A short description of a schema's type, naming referenced schemas by name.

Str

fn refName(reference: Str) -> Str

The schema name at the end of a local reference such as #/components/schemas/Pet.

Str