wolfadex / elm-open-api / OpenApi.Reference

Corresponds to the Reference Object in the OpenAPI specification.

Types


type alias Reference =
OpenApi.Types.Reference


type alias ReferenceOr a =
OpenApi.Types.ReferenceOr a

Many values in the OpenAPI Specification may have concrete values, or they may have a Reference to a value elsewhere. This type is a wrapper around the possibility of the value being either of these 2.

Decoding / Encoding

decode : Json.Decode.Decoder Reference

encode : Reference -> Json.Encode.Value

Querying

toConcrete : ReferenceOr a -> Maybe a

toReference : ReferenceOr a -> Maybe Reference

description : Reference -> Maybe String

ref : Reference -> String

The URI location of the actual value

summary : Reference -> Maybe String