docs.json

[{"name":"OpenApi","comment":" Corresponds to the [OpenAPI Object](https://spec.openapis.org/oas/latest#openapi-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs OpenApi\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs components\n@docs externalDocs\n@docs info\n@docs jsonSchemaDialect\n@docs paths\n@docs servers\n@docs tags\n@docs version\n@docs security\n\n","unions":[{"name":"OpenApi","comment":" An OpenAPI Specification (OAS)\n","args":[],"cases":[]}],"aliases":[],"values":[{"name":"components","comment":" ","type":"OpenApi.OpenApi -> Maybe.Maybe OpenApi.Components.Components"},{"name":"decode","comment":" Decodes OpenAPI JSON v3.1\n","type":"Json.Decode.Decoder OpenApi.OpenApi"},{"name":"encode","comment":" Encodes to OpenAPI JSON v3.1\n","type":"OpenApi.OpenApi -> Json.Encode.Value"},{"name":"externalDocs","comment":" ","type":"OpenApi.OpenApi -> Maybe.Maybe OpenApi.ExternalDocumentation.ExternalDocumentation"},{"name":"info","comment":" ","type":"OpenApi.OpenApi -> OpenApi.Info.Info"},{"name":"jsonSchemaDialect","comment":" ","type":"OpenApi.OpenApi -> Maybe.Maybe String.String"},{"name":"paths","comment":" ","type":"OpenApi.OpenApi -> Dict.Dict String.String OpenApi.Types.Path"},{"name":"security","comment":" ","type":"OpenApi.OpenApi -> List.List OpenApi.Types.SecurityRequirement"},{"name":"servers","comment":" ","type":"OpenApi.OpenApi -> List.List OpenApi.Types.Server"},{"name":"tags","comment":" ","type":"OpenApi.OpenApi -> List.List OpenApi.Tag.Tag"},{"name":"version","comment":" ","type":"OpenApi.OpenApi -> Semver.Version"}],"binops":[]},{"name":"OpenApi.Callback","comment":" Corresponds to the [Callback Object](https://spec.openapis.org/oas/latest#callback-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Callback\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs expression\n@docs value\n\n","unions":[],"aliases":[{"name":"Callback","comment":" ","args":[],"type":"OpenApi.Types.Callback"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Callback.Callback"},{"name":"encode","comment":" ","type":"OpenApi.Callback.Callback -> Json.Encode.Value"},{"name":"expression","comment":" ","type":"OpenApi.Callback.Callback -> String.String"},{"name":"value","comment":" ","type":"OpenApi.Callback.Callback -> OpenApi.Types.ReferenceOr OpenApi.Types.Path"}],"binops":[]},{"name":"OpenApi.Components","comment":" Corresponds to the [Components Object](https://spec.openapis.org/oas/latest.html#components-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Components\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs callbacks\n@docs examples\n@docs headers\n@docs links\n@docs parameters\n@docs pathItems\n@docs requestBodies\n@docs responses\n@docs schemas\n@docs securitySchemes\n\n","unions":[{"name":"Components","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"callbacks","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Callback)"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Components.Components"},{"name":"encode","comment":" ","type":"OpenApi.Components.Components -> Json.Encode.Value"},{"name":"examples","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Example)"},{"name":"headers","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Header)"},{"name":"links","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Link)"},{"name":"parameters","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Parameter)"},{"name":"pathItems","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Path)"},{"name":"requestBodies","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.RequestBody)"},{"name":"responses","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Response)"},{"name":"schemas","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String OpenApi.Types.Schema"},{"name":"securitySchemes","comment":" ","type":"OpenApi.Components.Components -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.SecurityScheme.SecurityScheme)"}],"binops":[]},{"name":"OpenApi.Contact","comment":" Corresponds to the [Contact Object](https://spec.openapis.org/oas/latest#contact-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Contact\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs email\n@docs name\n@docs url\n\n","unions":[{"name":"Contact","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Contact.Contact"},{"name":"email","comment":" ","type":"OpenApi.Contact.Contact -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Contact.Contact -> Json.Encode.Value"},{"name":"name","comment":" ","type":"OpenApi.Contact.Contact -> Maybe.Maybe String.String"},{"name":"url","comment":" ","type":"OpenApi.Contact.Contact -> Maybe.Maybe String.String"}],"binops":[]},{"name":"OpenApi.Discriminator","comment":" Corresponds to the [Discriminator Object](https://spec.openapis.org/oas/latest#discriminator-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Discriminator\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs propertyName\n@docs mapping\n\n","unions":[],"aliases":[{"name":"Discriminator","comment":" ","args":[],"type":"OpenApi.Types.Discriminator"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Discriminator.Discriminator"},{"name":"encode","comment":" ","type":"OpenApi.Discriminator.Discriminator -> Json.Encode.Value"},{"name":"mapping","comment":" ","type":"OpenApi.Discriminator.Discriminator -> Dict.Dict String.String String.String"},{"name":"propertyName","comment":" ","type":"OpenApi.Discriminator.Discriminator -> String.String"}],"binops":[]},{"name":"OpenApi.Encoding","comment":" Corresponds to the [Encoding Object](https://spec.openapis.org/oas/latest.html#encoding-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Encoding\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs allowReserved\n@docs contentType\n@docs explode\n@docs headers\n@docs style\n\n","unions":[],"aliases":[{"name":"Encoding","comment":" ","args":[],"type":"OpenApi.Types.Encoding"}],"values":[{"name":"allowReserved","comment":" ","type":"OpenApi.Encoding.Encoding -> Basics.Bool"},{"name":"contentType","comment":" ","type":"OpenApi.Encoding.Encoding -> Maybe.Maybe String.String"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Encoding.Encoding"},{"name":"encode","comment":" ","type":"OpenApi.Encoding.Encoding -> Json.Encode.Value"},{"name":"explode","comment":" ","type":"OpenApi.Encoding.Encoding -> Basics.Bool"},{"name":"headers","comment":" ","type":"OpenApi.Encoding.Encoding -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Header)"},{"name":"style","comment":" ","type":"OpenApi.Encoding.Encoding -> Maybe.Maybe String.String"}],"binops":[]},{"name":"OpenApi.Example","comment":" Corresponds to the [Example Object](https://spec.openapis.org/oas/latest.html#example-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Example\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs externalValue\n@docs summary\n@docs value\n\n","unions":[],"aliases":[{"name":"Example","comment":" ","args":[],"type":"OpenApi.Types.Example"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Example.Example"},{"name":"description","comment":" ","type":"OpenApi.Example.Example -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Example.Example -> Json.Encode.Value"},{"name":"externalValue","comment":" ","type":"OpenApi.Example.Example -> Maybe.Maybe String.String"},{"name":"summary","comment":" ","type":"OpenApi.Example.Example -> Maybe.Maybe String.String"},{"name":"value","comment":" ","type":"OpenApi.Example.Example -> Maybe.Maybe Json.Encode.Value"}],"binops":[]},{"name":"OpenApi.ExternalDocumentation","comment":" Corresponds to the [External Documentation Object](https://spec.openapis.org/oas/latest.html#external-documentation-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs ExternalDocumentation\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs url\n\n","unions":[],"aliases":[{"name":"ExternalDocumentation","comment":" ","args":[],"type":"OpenApi.Types.ExternalDocumentation"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.ExternalDocumentation.ExternalDocumentation"},{"name":"description","comment":" ","type":"OpenApi.ExternalDocumentation.ExternalDocumentation -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.ExternalDocumentation.ExternalDocumentation -> Json.Encode.Value"},{"name":"url","comment":" ","type":"OpenApi.ExternalDocumentation.ExternalDocumentation -> String.String"}],"binops":[]},{"name":"OpenApi.Header","comment":" Corresponds to the [Header Object](https://spec.openapis.org/oas/latest#header-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Header\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs allowEmptyValue\n@docs content\n@docs deprecated\n@docs description\n@docs example\n@docs examples\n@docs explode\n@docs required\n@docs schema\n@docs style\n\n","unions":[],"aliases":[{"name":"Header","comment":" ","args":[],"type":"OpenApi.Types.Header"}],"values":[{"name":"allowEmptyValue","comment":" ","type":"OpenApi.Header.Header -> Basics.Bool"},{"name":"content","comment":" ","type":"OpenApi.Header.Header -> Dict.Dict String.String OpenApi.Types.MediaType"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Header.Header"},{"name":"deprecated","comment":" ","type":"OpenApi.Header.Header -> Basics.Bool"},{"name":"description","comment":" ","type":"OpenApi.Header.Header -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Header.Header -> Json.Encode.Value"},{"name":"example","comment":" ","type":"OpenApi.Header.Header -> Maybe.Maybe Json.Encode.Value"},{"name":"examples","comment":" ","type":"OpenApi.Header.Header -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Example.Example)"},{"name":"explode","comment":" ","type":"OpenApi.Header.Header -> Basics.Bool"},{"name":"required","comment":" ","type":"OpenApi.Header.Header -> Basics.Bool"},{"name":"schema","comment":" ","type":"OpenApi.Header.Header -> Maybe.Maybe OpenApi.Types.Schema"},{"name":"style","comment":" ","type":"OpenApi.Header.Header -> Maybe.Maybe String.String"}],"binops":[]},{"name":"OpenApi.Info","comment":" Corresponds to the [Info Object](https://spec.openapis.org/oas/latest.html#info-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Info\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs contact\n@docs description\n@docs license\n@docs summary\n@docs termsOfService\n@docs title\n@docs version\n\n","unions":[{"name":"Info","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"contact","comment":" ","type":"OpenApi.Info.Info -> Maybe.Maybe OpenApi.Contact.Contact"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Info.Info"},{"name":"description","comment":" ","type":"OpenApi.Info.Info -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Info.Info -> Json.Encode.Value"},{"name":"license","comment":" ","type":"OpenApi.Info.Info -> Maybe.Maybe OpenApi.License.License"},{"name":"summary","comment":" ","type":"OpenApi.Info.Info -> Maybe.Maybe String.String"},{"name":"termsOfService","comment":" ","type":"OpenApi.Info.Info -> Maybe.Maybe String.String"},{"name":"title","comment":" ","type":"OpenApi.Info.Info -> String.String"},{"name":"version","comment":" ","type":"OpenApi.Info.Info -> String.String"}],"binops":[]},{"name":"OpenApi.License","comment":" Corresponds to the [License Object](https://spec.openapis.org/oas/latest.html#license-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs License\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs identifier\n@docs name\n@docs url\n\n","unions":[{"name":"License","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.License.License"},{"name":"encode","comment":" ","type":"OpenApi.License.License -> Json.Encode.Value"},{"name":"identifier","comment":" ","type":"OpenApi.License.License -> Maybe.Maybe String.String"},{"name":"name","comment":" ","type":"OpenApi.License.License -> String.String"},{"name":"url","comment":" ","type":"OpenApi.License.License -> Maybe.Maybe String.String"}],"binops":[]},{"name":"OpenApi.Link","comment":" Corresponds to the [Link Object](https://spec.openapis.org/oas/latest.html#link-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Link\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs operationId\n@docs operationRef\n@docs parameters\n@docs requestBody\n@docs server\n\n","unions":[],"aliases":[{"name":"Link","comment":" ","args":[],"type":"OpenApi.Types.Link"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Link.Link"},{"name":"description","comment":" ","type":"OpenApi.Link.Link -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Link.Link -> Json.Decode.Value"},{"name":"operationId","comment":" ","type":"OpenApi.Link.Link -> Maybe.Maybe String.String"},{"name":"operationRef","comment":" ","type":"OpenApi.Link.Link -> Maybe.Maybe String.String"},{"name":"parameters","comment":" ","type":"OpenApi.Link.Link -> Dict.Dict String.String Json.Decode.Value"},{"name":"requestBody","comment":" ","type":"OpenApi.Link.Link -> Maybe.Maybe Json.Decode.Value"},{"name":"server","comment":" ","type":"OpenApi.Link.Link -> Maybe.Maybe OpenApi.Types.Server"}],"binops":[]},{"name":"OpenApi.MediaType","comment":" Corresponds to the [MediaType Object](https://spec.openapis.org/oas/latest.html#media-type-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs MediaType\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs encoding\n@docs example\n@docs examples\n@docs schema\n\n","unions":[],"aliases":[{"name":"MediaType","comment":" ","args":[],"type":"OpenApi.Types.MediaType"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.MediaType.MediaType"},{"name":"encode","comment":" ","type":"OpenApi.MediaType.MediaType -> Json.Encode.Value"},{"name":"encoding","comment":" ","type":"OpenApi.MediaType.MediaType -> Dict.Dict String.String OpenApi.Types.Encoding"},{"name":"example","comment":" ","type":"OpenApi.MediaType.MediaType -> Maybe.Maybe Json.Decode.Value"},{"name":"examples","comment":" ","type":"OpenApi.MediaType.MediaType -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Example)"},{"name":"schema","comment":" ","type":"OpenApi.MediaType.MediaType -> Maybe.Maybe OpenApi.Schema.Schema"}],"binops":[]},{"name":"OpenApi.OauthFlow","comment":" Corresponds to the [OAuth Flows Object](https://spec.openapis.org/oas/latest.html#oauth-flows-object) in the OpenAPI specification, as well as the [OAuth Flow Object](https://spec.openapis.org/oas/latest.html#oauth-flow-object).\n\n\n# Types\n\n@docs OauthFlows\n@docs ImplicitFlow\n@docs PasswordFlow\n@docs ClientCredentialsFlow\n@docs AuthorizationCodeFlow\n\n\n# Decoding / Encoding\n\n@docs decodeFlows, encodeFlows\n@docs decodeImplicit, encodeImplicit\n@docs decodePassword, encodePassword\n@docs decodeClientCredentials, encodeClientCredentials\n@docs decodeAuthorizationCode, encodeAuthorizationCode\n\n\n# Querying\n\n\n## OAuth Flows\n\n@docs implicit\n@docs password\n@docs clientCredentials\n@docs authorizationCode\n\n\n## Implicit Flows\n\n@docs implicitAuthorizationUrl\n@docs implicitRefreshUrl\n@docs implicitScopes\n\n\n## Password Flows\n\n@docs passwordTokenUrl\n@docs passwordRefreshUrl\n@docs passwordScopes\n\n\n## Client Credential Flows\n\n@docs clientCredentialTokenUrl\n@docs clientCredentialRefreshUrl\n@docs clientCredentialScopes\n\n\n## Authorization Code Flows\n\n@docs authorizationCodeAuthorizationUrl\n@docs authorizationCodeTokenUrl\n@docs authorizationCodeRefreshUrl\n@docs authorizationCodeScopes\n\n","unions":[{"name":"AuthorizationCodeFlow","comment":" ","args":[],"cases":[]},{"name":"ClientCredentialsFlow","comment":" ","args":[],"cases":[]},{"name":"ImplicitFlow","comment":" ","args":[],"cases":[]},{"name":"OauthFlows","comment":" ","args":[],"cases":[]},{"name":"PasswordFlow","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"authorizationCode","comment":" ","type":"OpenApi.OauthFlow.OauthFlows -> Maybe.Maybe OpenApi.OauthFlow.AuthorizationCodeFlow"},{"name":"authorizationCodeAuthorizationUrl","comment":" ","type":"OpenApi.OauthFlow.AuthorizationCodeFlow -> String.String"},{"name":"authorizationCodeRefreshUrl","comment":" ","type":"OpenApi.OauthFlow.AuthorizationCodeFlow -> Maybe.Maybe String.String"},{"name":"authorizationCodeScopes","comment":" ","type":"OpenApi.OauthFlow.AuthorizationCodeFlow -> Dict.Dict String.String String.String"},{"name":"authorizationCodeTokenUrl","comment":" ","type":"OpenApi.OauthFlow.AuthorizationCodeFlow -> String.String"},{"name":"clientCredentialRefreshUrl","comment":" ","type":"OpenApi.OauthFlow.ClientCredentialsFlow -> Maybe.Maybe String.String"},{"name":"clientCredentialScopes","comment":" ","type":"OpenApi.OauthFlow.ClientCredentialsFlow -> Dict.Dict String.String String.String"},{"name":"clientCredentialTokenUrl","comment":" ","type":"OpenApi.OauthFlow.ClientCredentialsFlow -> String.String"},{"name":"clientCredentials","comment":" ","type":"OpenApi.OauthFlow.OauthFlows -> Maybe.Maybe OpenApi.OauthFlow.ClientCredentialsFlow"},{"name":"decodeAuthorizationCode","comment":" ","type":"Json.Decode.Decoder OpenApi.OauthFlow.AuthorizationCodeFlow"},{"name":"decodeClientCredentials","comment":" ","type":"Json.Decode.Decoder OpenApi.OauthFlow.ClientCredentialsFlow"},{"name":"decodeFlows","comment":" ","type":"Json.Decode.Decoder OpenApi.OauthFlow.OauthFlows"},{"name":"decodeImplicit","comment":" ","type":"Json.Decode.Decoder OpenApi.OauthFlow.ImplicitFlow"},{"name":"decodePassword","comment":" ","type":"Json.Decode.Decoder OpenApi.OauthFlow.PasswordFlow"},{"name":"encodeAuthorizationCode","comment":" ","type":"OpenApi.OauthFlow.AuthorizationCodeFlow -> Json.Encode.Value"},{"name":"encodeClientCredentials","comment":" ","type":"OpenApi.OauthFlow.ClientCredentialsFlow -> Json.Encode.Value"},{"name":"encodeFlows","comment":" ","type":"OpenApi.OauthFlow.OauthFlows -> Json.Encode.Value"},{"name":"encodeImplicit","comment":" ","type":"OpenApi.OauthFlow.ImplicitFlow -> Json.Encode.Value"},{"name":"encodePassword","comment":" ","type":"OpenApi.OauthFlow.PasswordFlow -> Json.Encode.Value"},{"name":"implicit","comment":" ","type":"OpenApi.OauthFlow.OauthFlows -> Maybe.Maybe OpenApi.OauthFlow.ImplicitFlow"},{"name":"implicitAuthorizationUrl","comment":" ","type":"OpenApi.OauthFlow.ImplicitFlow -> String.String"},{"name":"implicitRefreshUrl","comment":" ","type":"OpenApi.OauthFlow.ImplicitFlow -> Maybe.Maybe String.String"},{"name":"implicitScopes","comment":" ","type":"OpenApi.OauthFlow.ImplicitFlow -> Dict.Dict String.String String.String"},{"name":"password","comment":" ","type":"OpenApi.OauthFlow.OauthFlows -> Maybe.Maybe OpenApi.OauthFlow.PasswordFlow"},{"name":"passwordRefreshUrl","comment":" ","type":"OpenApi.OauthFlow.PasswordFlow -> Maybe.Maybe String.String"},{"name":"passwordScopes","comment":" ","type":"OpenApi.OauthFlow.PasswordFlow -> Dict.Dict String.String String.String"},{"name":"passwordTokenUrl","comment":" ","type":"OpenApi.OauthFlow.PasswordFlow -> String.String"}],"binops":[]},{"name":"OpenApi.Operation","comment":" Corresponds to the [Operation Object](https://spec.openapis.org/oas/latest#operation-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Operation\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n## Querying\n\n@docs callbacks\n@docs deprecated\n@docs description\n@docs externalDocs\n@docs operationId\n@docs parameters\n@docs requestBody\n@docs responses\n@docs security\n@docs servers\n@docs summary\n@docs tags\n\n","unions":[],"aliases":[{"name":"Operation","comment":" ","args":[],"type":"OpenApi.Types.Operation"}],"values":[{"name":"callbacks","comment":" ","type":"OpenApi.Operation.Operation -> Dict.Dict String.String (OpenApi.Reference.ReferenceOr OpenApi.Types.Callback)"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Operation.Operation"},{"name":"deprecated","comment":" ","type":"OpenApi.Operation.Operation -> Basics.Bool"},{"name":"description","comment":" ","type":"OpenApi.Operation.Operation -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Operation.Operation -> Json.Encode.Value"},{"name":"externalDocs","comment":" ","type":"OpenApi.Operation.Operation -> Maybe.Maybe OpenApi.ExternalDocumentation.ExternalDocumentation"},{"name":"operationId","comment":" ","type":"OpenApi.Operation.Operation -> Maybe.Maybe String.String"},{"name":"parameters","comment":" ","type":"OpenApi.Operation.Operation -> List.List (OpenApi.Reference.ReferenceOr OpenApi.Types.Parameter)"},{"name":"requestBody","comment":" ","type":"OpenApi.Operation.Operation -> Maybe.Maybe (OpenApi.Reference.ReferenceOr OpenApi.RequestBody.RequestBody)"},{"name":"responses","comment":" ","type":"OpenApi.Operation.Operation -> Dict.Dict String.String (OpenApi.Reference.ReferenceOr OpenApi.Response.Response)"},{"name":"security","comment":" ","type":"OpenApi.Operation.Operation -> List.List OpenApi.Types.SecurityRequirement"},{"name":"servers","comment":" ","type":"OpenApi.Operation.Operation -> List.List OpenApi.Server.Server"},{"name":"summary","comment":" ","type":"OpenApi.Operation.Operation -> Maybe.Maybe String.String"},{"name":"tags","comment":" ","type":"OpenApi.Operation.Operation -> List.List String.String"}],"binops":[]},{"name":"OpenApi.Parameter","comment":" Corresponds to the [Parameter Object](https://spec.openapis.org/oas/latest#parameter-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Parameter\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs allowEmptyValue\n@docs allowReserved\n@docs content\n@docs deprecated\n@docs description\n@docs example\n@docs examples\n@docs explode\n@docs in_\n\n@docs name\n@docs required\n@docs schema\n@docs style\n\n","unions":[],"aliases":[{"name":"Parameter","comment":" ","args":[],"type":"OpenApi.Types.Parameter"}],"values":[{"name":"allowEmptyValue","comment":" ","type":"OpenApi.Parameter.Parameter -> Basics.Bool"},{"name":"allowReserved","comment":" ","type":"OpenApi.Parameter.Parameter -> Maybe.Maybe Basics.Bool"},{"name":"content","comment":" ","type":"OpenApi.Parameter.Parameter -> Dict.Dict String.String OpenApi.Types.MediaType"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Parameter.Parameter"},{"name":"deprecated","comment":" ","type":"OpenApi.Parameter.Parameter -> Basics.Bool"},{"name":"description","comment":" ","type":"OpenApi.Parameter.Parameter -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Parameter.Parameter -> Json.Encode.Value"},{"name":"example","comment":" ","type":"OpenApi.Parameter.Parameter -> Maybe.Maybe Json.Encode.Value"},{"name":"examples","comment":" ","type":"OpenApi.Parameter.Parameter -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Example)"},{"name":"explode","comment":" ","type":"OpenApi.Parameter.Parameter -> Basics.Bool"},{"name":"in_","comment":" ","type":"OpenApi.Parameter.Parameter -> String.String"},{"name":"name","comment":" ","type":"OpenApi.Parameter.Parameter -> String.String"},{"name":"required","comment":" ","type":"OpenApi.Parameter.Parameter -> Basics.Bool"},{"name":"schema","comment":" ","type":"OpenApi.Parameter.Parameter -> Maybe.Maybe OpenApi.Types.Schema"},{"name":"style","comment":" ","type":"OpenApi.Parameter.Parameter -> String.String"}],"binops":[]},{"name":"OpenApi.Path","comment":" Corresponds to the [Path Item Object](https://spec.openapis.org/oas/latest#path-item-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Path\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs delete\n@docs description\n@docs get\n@docs head\n@docs options\n@docs parameters\n@docs patch\n@docs post\n@docs put\n@docs servers\n@docs summary\n@docs trace\n\n","unions":[],"aliases":[{"name":"Path","comment":" ","args":[],"type":"OpenApi.Types.Path"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Path.Path"},{"name":"delete","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"description","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Path.Path -> Json.Encode.Value"},{"name":"get","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"head","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"options","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"parameters","comment":" ","type":"OpenApi.Path.Path -> List.List (OpenApi.Types.ReferenceOr OpenApi.Types.Parameter)"},{"name":"patch","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"post","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"put","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"},{"name":"servers","comment":" ","type":"OpenApi.Path.Path -> List.List OpenApi.Types.Server"},{"name":"summary","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe String.String"},{"name":"trace","comment":" ","type":"OpenApi.Path.Path -> Maybe.Maybe OpenApi.Types.Operation"}],"binops":[]},{"name":"OpenApi.Reference","comment":" Corresponds to the [Reference Object](https://spec.openapis.org/oas/latest#reference-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Reference\n@docs ReferenceOr\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs toConcrete\n\n@docs toReference\n@docs description\n@docs ref\n@docs summary\n\n","unions":[],"aliases":[{"name":"Reference","comment":" ","args":[],"type":"OpenApi.Types.Reference"},{"name":"ReferenceOr","comment":" Many values in the OpenAPI Specification may have concrete values, or they may have a [Reference](#Reference) to a value elsewhere.\nThis type is a wrapper around the possibility of the value being either of these 2.\n","args":["a"],"type":"OpenApi.Types.ReferenceOr a"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Reference.Reference"},{"name":"description","comment":" ","type":"OpenApi.Reference.Reference -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Reference.Reference -> Json.Encode.Value"},{"name":"ref","comment":" The URI location of the actual value\n","type":"OpenApi.Reference.Reference -> String.String"},{"name":"summary","comment":" ","type":"OpenApi.Reference.Reference -> Maybe.Maybe String.String"},{"name":"toConcrete","comment":" ","type":"OpenApi.Reference.ReferenceOr a -> Maybe.Maybe a"},{"name":"toReference","comment":" ","type":"OpenApi.Reference.ReferenceOr a -> Maybe.Maybe OpenApi.Reference.Reference"}],"binops":[]},{"name":"OpenApi.RequestBody","comment":" Corresponds to the [RequestBody Object](https://spec.openapis.org/oas/latest#request-body-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs RequestBody\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs content\n@docs description\n@docs required\n\n","unions":[],"aliases":[{"name":"RequestBody","comment":" ","args":[],"type":"OpenApi.Types.RequestBody"}],"values":[{"name":"content","comment":" ","type":"OpenApi.RequestBody.RequestBody -> Dict.Dict String.String OpenApi.MediaType.MediaType"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.RequestBody.RequestBody"},{"name":"description","comment":" ","type":"OpenApi.RequestBody.RequestBody -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.RequestBody.RequestBody -> Json.Encode.Value"},{"name":"required","comment":" ","type":"OpenApi.RequestBody.RequestBody -> Basics.Bool"}],"binops":[]},{"name":"OpenApi.Response","comment":" Corresponds to the [Response Object](https://spec.openapis.org/oas/latest#response-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Response\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs content\n@docs description\n@docs headers\n@docs links\n\n","unions":[],"aliases":[{"name":"Response","comment":" ","args":[],"type":"OpenApi.Types.Response"}],"values":[{"name":"content","comment":" ","type":"OpenApi.Response.Response -> Dict.Dict String.String OpenApi.MediaType.MediaType"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Response.Response"},{"name":"description","comment":" ","type":"OpenApi.Response.Response -> String.String"},{"name":"encode","comment":" ","type":"OpenApi.Response.Response -> Json.Encode.Value"},{"name":"headers","comment":" ","type":"OpenApi.Response.Response -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Types.Header)"},{"name":"links","comment":" ","type":"OpenApi.Response.Response -> Dict.Dict String.String (OpenApi.Types.ReferenceOr OpenApi.Link.Link)"}],"binops":[]},{"name":"OpenApi.Schema","comment":" Corresponds to the [Schema Object](https://spec.openapis.org/oas/latest#schema-object) in the OpenAPI specification which in turn uses the [JSON Schema Specification](https://json-schema.org/specification.html).\n\nSince this is its own separate specification, the package [json-tools/json-schema](https://package.elm-lang.org/packages/json-tools/json-schema/latest/) is used. Please see their docs for accessible values\n\nBecause this modules is a wrapper around a separate package and its types, its interface is slightly different.\nWe still keep the opaque type [Schema](#Schema) and matching [decode](#decode). The primary differnce is around querying.\nInstead of providing querying functions for the JSON Schema spec, I provide a singular [get](#get) function for accessing\nthe wrapped [json-tools/json-schema Json.Schema.Definitions.Schema](https://package.elm-lang.org/packages/json-tools/json-schema/latest/Json-Schema-Definitions#Schema) value.\n\nThis is a little unusal compared to the rest of the package but the hope is that this allows for easier migration to a fully compliant JSON Schema package in a future release.\n\n\n# Types\n\n@docs Schema\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs get\n\n","unions":[],"aliases":[{"name":"Schema","comment":" ","args":[],"type":"OpenApi.Types.Schema"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Schema.Schema"},{"name":"encode","comment":" ","type":"OpenApi.Schema.Schema -> Json.Encode.Value"},{"name":"get","comment":" Given the above [Schema](#Schema) returns a [json-tools/json-schema Json.Schema.Definitions.Schema](https://package.elm-lang.org/packages/json-tools/json-schema/latest/Json-Schema-Definitions#Schema)\n","type":"OpenApi.Schema.Schema -> Json.Schema.Definitions.Schema"}],"binops":[]},{"name":"OpenApi.SecurityRequirement","comment":" Corresponds to the [Security Requirement Object](https://spec.openapis.org/oas/latest#security-requirement-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs SecurityRequirement\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs requirements\n\n","unions":[],"aliases":[{"name":"SecurityRequirement","comment":" ","args":[],"type":"OpenApi.Types.SecurityRequirement"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.SecurityRequirement.SecurityRequirement"},{"name":"encode","comment":" ","type":"OpenApi.SecurityRequirement.SecurityRequirement -> Json.Encode.Value"},{"name":"requirements","comment":" ","type":"OpenApi.SecurityRequirement.SecurityRequirement -> Dict.Dict String.String (List.List String.String)"}],"binops":[]},{"name":"OpenApi.SecurityScheme","comment":" Corresponds to the [Security Scheme Object](https://spec.openapis.org/oas/latest.html#security-scheme-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs SecurityScheme\n@docs SecuritySchemeType\n@docs SecuritySchemeIn\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs type_\n\n","unions":[{"name":"SecurityScheme","comment":" ","args":[],"cases":[]},{"name":"SecuritySchemeIn","comment":" ","args":[],"cases":[["Query",[]],["Header",[]],["Cookie",[]]]},{"name":"SecuritySchemeType","comment":" ","args":[],"cases":[["ApiKey",["{ name : String.String, in_ : OpenApi.SecurityScheme.SecuritySchemeIn }"]],["Http",["{ scheme : String.String, bearerFormat : Maybe.Maybe String.String }"]],["MutualTls",[]],["Oauth2",["{ flows : OpenApi.OauthFlow.OauthFlows }"]],["OpenIdConnect",["{ openIdConnectUrl : String.String }"]]]}],"aliases":[],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.SecurityScheme.SecurityScheme"},{"name":"description","comment":" ","type":"OpenApi.SecurityScheme.SecurityScheme -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.SecurityScheme.SecurityScheme -> Json.Encode.Value"},{"name":"type_","comment":" ","type":"OpenApi.SecurityScheme.SecurityScheme -> OpenApi.SecurityScheme.SecuritySchemeType"}],"binops":[]},{"name":"OpenApi.Server","comment":" Corresponds to the [Server Object](https://spec.openapis.org/oas/latest.html#server-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Server\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs url\n@docs variables\n\n","unions":[],"aliases":[{"name":"Server","comment":" ","args":[],"type":"OpenApi.Types.Server"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Server.Server"},{"name":"description","comment":" ","type":"OpenApi.Server.Server -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Server.Server -> Json.Encode.Value"},{"name":"url","comment":" ","type":"OpenApi.Server.Server -> String.String"},{"name":"variables","comment":" ","type":"OpenApi.Server.Server -> Dict.Dict String.String OpenApi.Server.Variable.Variable"}],"binops":[]},{"name":"OpenApi.Server.Variable","comment":" Corresponds to the [Server Variable Object](https://spec.openapis.org/oas/latest.html#server-variable-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Variable\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs default\n@docs description\n@docs enum\n\n","unions":[],"aliases":[{"name":"Variable","comment":" ","args":[],"type":"OpenApi.Types.Variable"}],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Server.Variable.Variable"},{"name":"default","comment":" ","type":"OpenApi.Server.Variable.Variable -> String.String"},{"name":"description","comment":" ","type":"OpenApi.Server.Variable.Variable -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Server.Variable.Variable -> Json.Encode.Value"},{"name":"enum","comment":" ","type":"OpenApi.Server.Variable.Variable -> List.List String.String"}],"binops":[]},{"name":"OpenApi.Tag","comment":" Corresponds to the [Tag Object](https://spec.openapis.org/oas/latest.html#tag-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Tag\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs description\n@docs externalDocs\n@docs name\n\n","unions":[{"name":"Tag","comment":" ","args":[],"cases":[]}],"aliases":[],"values":[{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Tag.Tag"},{"name":"description","comment":" ","type":"OpenApi.Tag.Tag -> Maybe.Maybe String.String"},{"name":"encode","comment":" ","type":"OpenApi.Tag.Tag -> Json.Encode.Value"},{"name":"externalDocs","comment":" ","type":"OpenApi.Tag.Tag -> Maybe.Maybe OpenApi.Types.ExternalDocumentation"},{"name":"name","comment":" ","type":"OpenApi.Tag.Tag -> String.String"}],"binops":[]},{"name":"OpenApi.Xml","comment":" Corresponds to the [XML Object](https://spec.openapis.org/oas/latest#xml-object) in the OpenAPI specification.\n\n\n# Types\n\n@docs Xml\n\n\n# Decoding / Encoding\n\n@docs decode\n@docs encode\n\n\n# Querying\n\n@docs attribute\n@docs name\n@docs namespace\n@docs prefix\n@docs wrapped\n\n","unions":[],"aliases":[{"name":"Xml","comment":" ","args":[],"type":"OpenApi.Types.Xml"}],"values":[{"name":"attribute","comment":" ","type":"OpenApi.Xml.Xml -> Basics.Bool"},{"name":"decode","comment":" ","type":"Json.Decode.Decoder OpenApi.Xml.Xml"},{"name":"encode","comment":" ","type":"OpenApi.Xml.Xml -> Json.Encode.Value"},{"name":"name","comment":" ","type":"OpenApi.Xml.Xml -> Maybe.Maybe String.String"},{"name":"namespace","comment":" ","type":"OpenApi.Xml.Xml -> Maybe.Maybe String.String"},{"name":"prefix","comment":" ","type":"OpenApi.Xml.Xml -> Maybe.Maybe String.String"},{"name":"wrapped","comment":" ","type":"OpenApi.Xml.Xml -> Basics.Bool"}],"binops":[]}]