gilly - v0.1.7

gilly/openapi/operation

Types

MediaType

</> 
pub type MediaType {
  MediaType(schema: option.Option(schema.Schema))
}

Constructors

Operation

</> 
pub type Operation {
  Operation(
    operation_id: option.Option(String),
    summary: option.Option(String),
    description: option.Option(String),
    tags: List(String),
    parameters: List(Parameter),
    request_body: option.Option(RequestBody),
    responses: List(#(String, Response)),
  )
}

Constructors

Parameter

</> 
pub type Parameter {
  Parameter(
    name: String,
    in_: ParameterLocation,
    description: option.Option(String),
    required: Bool,
    schema: option.Option(schema.Schema),
  )
}

Constructors

ParameterLocation

</> 
pub type ParameterLocation {
  Query
  Path
  Header
  Cookie
}

Constructors 

  • Query
  • Path
  • Header
  • Cookie

RequestBody

</> 
pub type RequestBody {
  RequestBody(
    description: option.Option(String),
    required: Bool,
    content: List(#(String, MediaType)),
  )
}

Constructors

Response

</> 
pub type Response {
  Response(
    description: String,
    content: List(#(String, MediaType)),
  )
}

Constructors 

  • Response(
  description: String,
  content: List(#(String, MediaType)),
)

Values

operation_decoder

</> 
pub fn operation_decoder() -> decode.Decoder(Operation)
✨ Search Document