oas - v7.2.0

oas

Types

Components

</>

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

pub type Components {
  Components(
    schemas: dict.Dict(String, json_schema.Schema),
    responses: dict.Dict(String, json_schema.Ref(Response)),
    parameters: dict.Dict(String, json_schema.Ref(Parameter)),
    request_bodies: dict.Dict(
      String,
      json_schema.Ref(RequestBody),
    ),
  )
}

Constructors

Contact

</>

Contact information for the exposed API.

pub type Contact {
  Contact(
    name: option.Option(String),
    url: option.Option(String),
    email: option.Option(String),
  )
}

Constructors

Document

</>

This is the root object of the OpenAPI document.

pub type Document {
  Document(
    openapi: String,
    info: Info,
    json_schema_dialect: option.Option(String),
    servers: List(Server),
    paths: dict.Dict(String, PathItem),
    components: Components,
  )
}

Constructors

</> 
pub type Header {
  Header(
    description: option.Option(String),
    required: Bool,
    schema: json_schema.Schema,
  )
}

Constructors

Info

</>

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

pub type Info {
  Info(
    title: String,
    summary: option.Option(String),
    description: option.Option(String),
    terms_of_service: option.Option(String),
    contact: option.Option(Contact),
    license: option.Option(Licence),
    version: String,
  )
}

Constructors

Licence

</>

License information for the exposed API.

pub type Licence {
  Licence(
    name: String,
    identifier: option.Option(String),
    url: option.Option(String),
  )
}

Constructors

MediaType

</>

Each Media Type Object provides schema and examples for the media type identified by its key.

pub type MediaType {
  MediaType(
    schema: option.Option(json_schema.Ref(json_schema.Schema)),
  )
}

Constructors

Operation

</>

Describes a single API operation on a path.

pub type Operation {
  Operation(
    tags: List(String),
    summary: option.Option(String),
    description: option.Option(String),
    operation_id: String,
    parameters: List(json_schema.Ref(Parameter)),
    request_body: option.Option(json_schema.Ref(RequestBody)),
    responses: dict.Dict(Status, json_schema.Ref(Response)),
  )
}

Constructors

Parameter

</>

Describes a single operation parameter.

There are four possible parameter locations specified by the in field: path, query, header and cookie. A unique parameter is defined by a combination of a name and location.

pub type Parameter {
  QueryParameter(
    name: String,
    description: option.Option(String),
    required: Bool,
    schema: json_schema.Ref(json_schema.Schema),
  )
  PathParameter(
    name: String,
    schema: json_schema.Ref(json_schema.Schema),
  )
  HeaderParameter(
    name: String,
    description: option.Option(String),
    required: Bool,
    schema: json_schema.Ref(json_schema.Schema),
  )
  CookieParameter(
    name: String,
    description: option.Option(String),
    required: Bool,
    schema: json_schema.Ref(json_schema.Schema),
  )
}

Constructors

PathItem

</>

Describes the operations available on a single path.

pub type PathItem {
  PathItem(
    summary: option.Option(String),
    description: option.Option(String),
    parameters: List(json_schema.Ref(Parameter)),
    operations: List(#(http.Method, Operation)),
  )
}

Constructors

RequestBody

</>

Describes a single request body.

pub type RequestBody {
  RequestBody(
    description: option.Option(String),
    content: dict.Dict(String, MediaType),
    required: Bool,
  )
}

Constructors

Response

</>

Describes a single response from an API Operation

pub type Response {
  Response(
    description: option.Option(String),
    headers: dict.Dict(String, json_schema.Ref(Header)),
    content: dict.Dict(String, MediaType),
  )
}

Constructors

Segment

</> 
pub type Segment {
  FixedSegment(content: String)
  MatchSegment(name: String, schema: json_schema.Schema)
}

Constructors

Server

</>

An object representing a Server.

pub type Server {
  Server(
    url: String,
    description: option.Option(String),
    variables: dict.Dict(String, ServerVariable),
  )
}

Constructors

ServerVariable

</>

An object representing a Server Variable for server URL template substitution.

pub type ServerVariable {
  ServerVariable(
    enum: option.Option(non_empty_list.NonEmptyList(String)),
    default: String,
    description: option.Option(String),
  )
}

Constructors

Status

</> 
pub type Status {
  Default
  Status(Int)
}

Constructors 

  • Default
  • Status(Int)

Values

decoder

</> 
pub fn decoder() -> decode.Decoder(Document)

fetch_parameter

</> 
pub fn fetch_parameter(
  ref: json_schema.Ref(a),
  parameters: dict.Dict(String, json_schema.Ref(a)),
) -> a

fetch_request_body

</> 
pub fn fetch_request_body(
  ref: json_schema.Ref(a),
  request_bodies: dict.Dict(String, json_schema.Ref(a)),
) -> a

fetch_response

</> 
pub fn fetch_response(
  ref: json_schema.Ref(a),
  responses: dict.Dict(String, json_schema.Ref(a)),
) -> a

fetch_schema

</> 
pub fn fetch_schema(
  ref: json_schema.Ref(a),
  schemas: dict.Dict(String, a),
) -> a

gather_match

</> 
pub fn gather_match(
  pattern: String,
  parameters: List(Parameter),
  components: Components,
) -> Result(List(Segment), String)

query_parameters

</> 
pub fn query_parameters(
  parameters: List(Parameter),
) -> List(#(String, Bool, json_schema.Ref(json_schema.Schema)))
✨ Search Document