Module

PuduLangDocgen.Rest.Pages

HTTP interface reference pages with linked schemas

Functions

Name	Description
`page`	The page of a service and the identities of its operations and schemas. The service's own identity is `uid`; operations are `uid.operationId` and schemas `uid.schemas.Name`.
`split`	A service spread over several pages: an overview holding servers and schemas, a page per tag when `byTag`, and a page per operation when `byOperation`. Sub-pages live in a folder named after the overview page.

page

fn page(service: &OpenApi.Service, uid: Str, context: &Phrase.Scope) -> (Docgen.Page, Array[Docgen.Reference], Array[Docgen.Diagnostic])

The page of a service and the identities of its operations and schemas. The service's own identity is uid; operations are uid.operationId and schemas uid.schemas.Name.

Parameters

service: &OpenApi.Service
uid: Str
context: &Phrase.Scope

Returns

(Docgen.Page, Array[Docgen.Reference], Array[Docgen.Diagnostic])

View source

split

fn split(service: &OpenApi.Service, uid: Str, context: &Phrase.Scope, byTag: Bool, byOperation: Bool) -> (Array[Docgen.Page], Array[Docgen.Reference], Array[Docgen.Diagnostic])

A service spread over several pages: an overview holding servers and schemas, a page per tag when byTag, and a page per operation when byOperation. Sub-pages live in a folder named after the overview page.

Parameters

service: &OpenApi.Service
uid: Str
context: &Phrase.Scope
byTag: Bool
byOperation: Bool

Returns

(Array[Docgen.Page], Array[Docgen.Reference], Array[Docgen.Diagnostic])

View source