Holmusk/swagger-decoder/1.0.0

Swagger.Types

This module defines the types that make up a swagger schema

{ info : Info
, host : Maybe String
, basePath : Maybe String
, schemes : List Scheme
, consumes : List String
, produces : List String
, paths : Paths
}
type alias Info =
{ title : String
, description : Maybe String
, termsOfService : Maybe String
, contact : Maybe Contact
, license : Maybe License
, version : String
}
type alias Contact =
{ name : Maybe String
, url : Maybe String
, email : Maybe String
}
type alias License =
{ name : String
, url : Maybe String
}
It seems that Scheme(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.
type alias Paths =
Dict String PathItem
type alias PathItem =
{ ref : Maybe String
, get : Maybe Operation
, put : Maybe Operation
, post : Maybe Operation
, delete : Maybe Operation
, options : Maybe Operation
, head : Maybe Operation
, patch : Maybe Operation
, parameters : Maybe (Either Parameter Reference)
}
type alias Operation =
{ tags : List String
, summary : Maybe String
, description : Maybe String
, externalDocs : Maybe ExternalDocs
, operationId : Maybe String
, consumes : List String
, produces : List String
, parameters : Maybe (Either Parameter Reference)
, responses : Responses
, schemes : List Scheme
, deprecated : Bool
, security : Maybe SecurityRequirement
}
type alias ExternalDocs =
{ description : Maybe String
, url : String
}
type alias Parameter =
{ name : String
, in_ : ParameterIn
, description : Maybe String
, required : Bool
, parameterBody : ParameterBody
}
It seems that ParameterIn(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.It seems that ParameterBody(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.
{ type_ : String
, format : Maybe String
, allowEmptyValue : Bool
, items : Maybe Items
, collectionFormat : CollectionFormat
}
It seems that Items(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.
type alias ItemsBody =
{ type_ : String
, format : Maybe String
, items : Maybe Items
, collectionFormat : CollectionFormat
}
It seems that CollectionFormat(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.It seems that Schema(..) does not have any docs. The module's documentation names it in an @docs line, but the package does not expose it.
type alias Reference =
{ ref : String }
type alias Responses =
{ default : Maybe (Either Response Reference)
, get : Maybe (Either Response Reference)
, put : Maybe (Either Response Reference)
, post : Maybe (Either Response Reference)
, delete : Maybe (Either Response Reference)
, options : Maybe (Either Response Reference)
, head : Maybe (Either Response Reference)
, patch : Maybe (Either Response Reference)
}
type alias Response =
{ description : String
, schema : Maybe Schema
, headers : Maybe Headers
, examples : Maybe Example
}
type alias Headers =
Dict String Header
type alias Example =
Dict String Value
type alias SecurityRequirement =
Dict String (List String)