wolfadex / elm-open-api / OpenApi.Operation

Corresponds to the Operation Object in the OpenAPI specification.

Types


type alias Operation =
OpenApi.Types.Operation

Decoding / Encoding

decode : Json.Decode.Decoder Operation

encode : Operation -> Json.Encode.Value

Querying

callbacks : Operation -> Dict String (OpenApi.Reference.ReferenceOr OpenApi.Types.Callback)

deprecated : Operation -> Basics.Bool

description : Operation -> Maybe String

externalDocs : Operation -> Maybe OpenApi.ExternalDocumentation.ExternalDocumentation

operationId : Operation -> Maybe String

parameters : Operation -> List (OpenApi.Reference.ReferenceOr OpenApi.Types.Parameter)

requestBody : Operation -> Maybe (OpenApi.Reference.ReferenceOr OpenApi.RequestBody.RequestBody)

responses : Operation -> Dict String (OpenApi.Reference.ReferenceOr OpenApi.Response.Response)

security : Operation -> List OpenApi.Types.SecurityRequirement

servers : Operation -> List OpenApi.Server.Server

summary : Operation -> Maybe String

tags : Operation -> List String