Std.App.OpenApi

answerInt -> Str -> Option[Std.App.OpenApi.Schema] -> Std.App.OpenApi.Answer
A response.
fn
Answer
One possible response. A 4xx or 5xx answer with no body is described as
type
Describing
Building a document reads top to bottom:
trait
documentStr -> Str -> Std.App.OpenApi.Document
A document with no operations.
fn
Document
A whole API description.
type
DocumentStd.App.Config.Source
A whole API description.
type
fieldStr -> Std.App.OpenApi.Schema -> Std.App.OpenApi.Property
A required property.
fn
Location
Where a parameter is read from.
type
operationStd.Http.Method -> Str -> Str -> Std.App.OpenApi.Operation
An operation whose :name path segments are required text parameters
fn
Operation
One route, described. path uses the router's :name segments.
type
optionalStr -> Std.App.OpenApi.Schema -> Std.App.OpenApi.Property
An optional property.
fn
parameterStr -> Std.App.OpenApi.Location -> Std.App.OpenApi.Schema -> Std.App.OpenApi.Parameter
A parameter; path parameters are required, others optional.
fn
Parameter
A parameter of an operation.
type
PROBLEM_SCHEMAStr
The name the problem-body schema is published under.
const
problems&Std.App.OpenApi.Document -> Array[Str]
What is inconsistent in a document: repeated operation ids, a Named
fn
Property
A member of a Record schema.
type
route&Std.App.OpenApi.Document -> Str -> Std.Http.Server.Route.Route
A route serving the document as JSON at path.
fn
Schema
The shape of a value in a request or response.
type
SPEC_VERSIONStr
The document version this module writes.
const
toJson&Std.App.OpenApi.Document -> Std.Json.Json
The document as an OpenAPI 3.1 object.
fn
undocumented&Std.App.OpenApi.Document -> &Std.Http.Server.Route.Router -> (Array[Str], Array[Str])
Routes the router serves that the document does not describe, and
fn