wolfadex / elm-open-api / OpenApi

Corresponds to the OpenAPI Object in the OpenAPI specification.

Types


type OpenApi

An OpenAPI Specification (OAS)

Decoding / Encoding

decode : Json.Decode.Decoder OpenApi

Decodes OpenAPI JSON v3.1

encode : OpenApi -> Json.Encode.Value

Encodes to OpenAPI JSON v3.1

Querying

components : OpenApi -> Maybe Components

externalDocs : OpenApi -> Maybe ExternalDocumentation

info : OpenApi -> Info

jsonSchemaDialect : OpenApi -> Maybe String

paths : OpenApi -> Dict String Types.Path

servers : OpenApi -> List Types.Server

tags : OpenApi -> List Tag

version : OpenApi -> Semver.Version