openapi-hs-4.0.0: src/Data/OpenApi/Internal.hs
{-# LANGUAGE CPP #-}
{-# OPTIONS_GHC -Wno-orphans #-}
-- |
-- Module: Data.OpenApi.Internal
-- Maintainer: Nadeem Bitar <nadeem@gmail.com>
-- Stability: experimental
--
-- Internal module defining the OpenAPI 3.1 data model and its JSON instances.
-- No API stability guarantees — import "Data.OpenApi" instead.
module Data.OpenApi.Internal where
import Control.Applicative
import Control.Lens ((&), (.~), (?~))
import Data.Aeson hiding (Encoding)
import Prelude.Compat
import Prelude ()
#if MIN_VERSION_aeson(2,0,0)
import qualified Data.Aeson.KeyMap as KeyMap
#endif
import Control.Monad (unless)
import Data.Aeson.Types qualified as JSON
import Data.Data
( Constr,
Data (..),
DataType,
Fixity (..),
Typeable,
constrIndex,
mkConstr,
mkDataType,
)
import Data.HashMap.Strict qualified as HashMap
import Data.HashMap.Strict.InsOrd.Compat (InsOrdHashMap)
import Data.HashMap.Strict.InsOrd.Compat qualified as InsOrdHashMap
import Data.HashSet.InsOrd (InsOrdHashSet)
import Data.Hashable (Hashable (..))
import Data.Map (Map)
import Data.Map qualified as Map
import Data.Monoid (Monoid (..))
import Data.OpenApi.Aeson.Compat (deleteKey)
import Data.OpenApi.Internal.AesonUtils
( AesonDefaultValue (..),
HasOpenApiAesonOptions (..),
applyKeyRenamesParseJSON,
applyKeyRenamesToJSON,
mkOpenApiAesonOptions,
saoAdditionalPairs,
saoSubObject,
sopOpenApiGenericParseJSON,
sopOpenApiGenericToEncoding,
sopOpenApiGenericToJSON,
sopOpenApiGenericToJSONWithOpts,
)
import Data.OpenApi.Internal.Utils
import Data.Scientific (Scientific)
import Data.Semigroup.Compat (Semigroup (..))
import Data.String (IsString (..))
import Data.Text (Text)
import Data.Text qualified as Text
import Data.Text.Encoding (encodeUtf8)
import Data.Version
import GHC.Generics (Generic)
import Generics.SOP.TH (deriveGeneric)
import Network.HTTP.Media
( MediaType,
mainType,
parameters,
parseAccept,
subType,
(//),
(/:),
)
import Text.ParserCombinators.ReadP (readP_to_S)
import Text.Read (readMaybe)
-- $setup
-- >>> :seti -XDataKinds
-- >>> import Data.Aeson
-- >>> import Data.ByteString.Lazy.Char8 as BSL
-- >>> import Data.OpenApi.Internal.Utils
-- | A list of definitions that can be used in references.
type Definitions = InsOrdHashMap Text
-- | This is the root document object for the API specification.
data OpenApi = OpenApi
{ -- | Provides metadata about the API.
-- The metadata can be used by the clients if needed.
_openApiInfo :: Info,
-- | An array of Server Objects, which provide connectivity information
-- to a target server. If the servers property is not provided, or is an empty array,
-- the default value would be a 'Server' object with a url value of @/@.
_openApiServers :: [Server],
-- | The available paths and operations for the API.
_openApiPaths :: InsOrdHashMap FilePath PathItem,
-- | The incoming webhooks that MAY be received as part of this API,
-- and that the API consumer MAY choose to implement. (OpenAPI 3.1)
-- Each value is a Path Item Object or a Reference Object.
_openApiWebhooks :: InsOrdHashMap Text (Referenced PathItem),
-- | An element to hold various schemas for the specification.
_openApiComponents :: Components,
-- | A declaration of which security mechanisms can be used across the API.
-- The list of values includes alternative security requirement objects that can be used.
-- Only one of the security requirement objects need to be satisfied to authorize a request.
-- Individual operations can override this definition.
-- To make security optional, an empty security requirement can be included in the array.
_openApiSecurity :: [SecurityRequirement],
-- | A list of tags used by the specification with additional metadata.
-- The order of the tags can be used to reflect on their order by the parsing tools.
-- Not all tags that are used by the 'Operation' Object must be declared.
-- The tags that are not declared MAY be organized randomly or based on the tools' logic.
-- Each tag name in the list MUST be unique.
_openApiTags :: InsOrdHashSet Tag,
-- | Additional external documentation.
_openApiExternalDocs :: Maybe ExternalDocs,
-- | The spec of OpenApi this spec adheres to. Must be between 'lowerOpenApiSpecVersion' and 'upperOpenApiSpecVersion'
_openApiOpenapi :: OpenApiSpecVersion
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | This is the lower version of the OpenApi Spec this library can parse or produce
lowerOpenApiSpecVersion :: Version
lowerOpenApiSpecVersion = makeVersion [3, 1, 0]
-- | This is the upper version of the OpenApi Spec this library can parse or produce
upperOpenApiSpecVersion :: Version
upperOpenApiSpecVersion = makeVersion [3, 1, 1]
-- | Coarse major version of an OpenAPI document, used to route a parsed document
-- to the appropriate decoder (e.g. EP-7's @Value@-layer 3.0→3.1 migration helpers).
-- This is NOT stored on any type and does not keep two representations alive; it
-- only tells a reader which migration path to take.
data OpenApiMajorVersion = OpenApi30 | OpenApi31
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Classify an 'OpenApiSpecVersion' as 3.0.x or 3.1.x (anything @>= 3.1@ is treated
-- as 3.1).
detectVersion :: OpenApiSpecVersion -> OpenApiMajorVersion
detectVersion v
| versionBranch (getVersion v) >= [3, 1] = OpenApi31
| otherwise = OpenApi30
-- | The object provides metadata about the API.
-- The metadata MAY be used by the clients if needed,
-- and MAY be presented in editing or documentation generation tools for convenience.
data Info = Info
{ -- | The title of the API.
_infoTitle :: Text,
-- | A short summary of the API. (OpenAPI 3.1)
_infoSummary :: Maybe Text,
-- | A short description of the API.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_infoDescription :: Maybe Text,
-- | A URL to the Terms of Service for the API. MUST be in the format of a URL.
_infoTermsOfService :: Maybe Text,
-- | The contact information for the exposed API.
_infoContact :: Maybe Contact,
-- | The license information for the exposed API.
_infoLicense :: Maybe License,
-- | The version of the OpenAPI document (which is distinct from the
-- OpenAPI Specification version or the API implementation version).
_infoVersion :: Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Contact information for the exposed API.
data Contact = Contact
{ -- | The identifying name of the contact person/organization.
_contactName :: Maybe Text,
-- | The URL pointing to the contact information.
_contactUrl :: Maybe URL,
-- | The email address of the contact person/organization.
_contactEmail :: Maybe Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | License information for the exposed API.
data License = License
{ -- | The license name used for the API.
_licenseName :: Text,
-- | An [SPDX](https://spdx.org/licenses/) license expression for the API,
-- e.g. @"MIT"@ or @"Apache-2.0"@. (OpenAPI 3.1)
--
-- The OpenAPI 3.1 specification states that @identifier@ and '_licenseUrl'
-- are mutually exclusive: a license is identified by /either/ an SPDX
-- identifier /or/ a URL, never both. This library does not enforce that
-- constraint at decode time (see EP-5 Decision Log); it round-trips
-- whatever is present.
_licenseIdentifier :: Maybe Text,
-- | A URL to the license used for the API.
_licenseUrl :: Maybe URL
}
deriving stock (Eq, Show, Generic, Data, Typeable)
instance IsString License where
fromString s = License (fromString s) Nothing Nothing
-- | An object representing a Server.
data Server = Server
{ -- | A URL to the target host. This URL supports Server Variables and MAY be relative,
-- to indicate that the host location is relative to the location where
-- the OpenAPI document is being served. Variable substitutions will be made when
-- a variable is named in @{brackets}@.
_serverUrl :: Text,
-- | An optional string describing the host designated by the URL.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_serverDescription :: Maybe Text,
-- | A map between a variable name and its value.
-- The value is used for substitution in the server's URL template.
_serverVariables :: InsOrdHashMap Text ServerVariable
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A variable substituted into a 'Server' URL template, as described by the
-- OpenAPI Server Variable Object.
data ServerVariable = ServerVariable
{ -- | An enumeration of string values to be used if the substitution options
-- are from a limited set. The array SHOULD NOT be empty.
_serverVariableEnum :: Maybe (InsOrdHashSet Text), -- TODO NonEmpty
-- | The default value to use for substitution, which SHALL be sent if an alternate value
-- is not supplied. Note this behavior is different than the 'Schema\ Object's treatment
-- of default values, because in those cases parameter values are optional.
-- If the '_serverVariableEnum' is defined, the value SHOULD exist in the enum's values.
_serverVariableDefault :: Text,
-- | An optional description for the server variable.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_serverVariableDescription :: Maybe Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
instance IsString Server where
fromString s = Server (fromString s) Nothing mempty
-- | Holds a set of reusable objects for different aspects of the OAS.
-- All objects defined within the components object will have no effect on the API
-- unless they are explicitly referenced from properties outside the components object.
data Components = Components
{ _componentsSchemas :: Definitions Schema,
_componentsResponses :: Definitions Response,
_componentsParameters :: Definitions Param,
_componentsExamples :: Definitions Example,
_componentsRequestBodies :: Definitions RequestBody,
_componentsHeaders :: Definitions Header,
_componentsSecuritySchemes :: SecurityDefinitions,
_componentsLinks :: Definitions Link,
_componentsCallbacks :: Definitions Callback
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Describes the operations available on a single path.
-- A @'PathItem'@ may be empty, due to ACL constraints.
-- The path itself is still exposed to the documentation viewer
-- but they will not know which operations and parameters are available.
data PathItem = PathItem
{ -- | A reference (@$ref@) to an externally-defined Path Item Object,
-- whose definition replaces this one, with @summary@ and @description@
-- providing optional overrides. (OpenAPI 3.1)
_pathItemRef :: Maybe Text,
-- | An optional, string summary, intended to apply to all operations in this path.
_pathItemSummary :: Maybe Text,
-- | An optional, string description, intended to apply to all operations in this path.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_pathItemDescription :: Maybe Text,
-- | A definition of a GET operation on this path.
_pathItemGet :: Maybe Operation,
-- | A definition of a PUT operation on this path.
_pathItemPut :: Maybe Operation,
-- | A definition of a POST operation on this path.
_pathItemPost :: Maybe Operation,
-- | A definition of a DELETE operation on this path.
_pathItemDelete :: Maybe Operation,
-- | A definition of a OPTIONS operation on this path.
_pathItemOptions :: Maybe Operation,
-- | A definition of a HEAD operation on this path.
_pathItemHead :: Maybe Operation,
-- | A definition of a PATCH operation on this path.
_pathItemPatch :: Maybe Operation,
-- | A definition of a TRACE operation on this path.
_pathItemTrace :: Maybe Operation,
-- | An alternative server array to service all operations in this path.
_pathItemServers :: [Server],
-- | A list of parameters that are applicable for all the operations described under this path.
-- These parameters can be overridden at the operation level, but cannot be removed there.
-- The list MUST NOT include duplicated parameters.
-- A unique parameter is defined by a combination of a name and location.
_pathItemParameters :: [Referenced Param]
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Describes a single API operation on a path.
data Operation = Operation
{ -- | A list of tags for API documentation control.
-- Tags can be used for logical grouping of operations by resources or any other qualifier.
_operationTags :: InsOrdHashSet TagName,
-- | A short summary of what the operation does.
-- For maximum readability in rendering tools, this field SHOULD be less than 120 characters.
_operationSummary :: Maybe Text,
-- | A verbose explanation of the operation behavior.
-- [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation.
_operationDescription :: Maybe Text,
-- | Additional external documentation for this operation.
_operationExternalDocs :: Maybe ExternalDocs,
-- | Unique string used to identify the operation.
-- The id MUST be unique among all operations described in the API.
-- The operationId value is **case-sensitive**.
-- Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,
-- it is RECOMMENDED to follow common programming naming conventions.
_operationOperationId :: Maybe Text,
-- | A list of parameters that are applicable for this operation.
-- If a parameter is already defined at the @'PathItem'@,
-- the new definition will override it, but can never remove it.
-- The list MUST NOT include duplicated parameters.
-- A unique parameter is defined by a combination of a name and location.
_operationParameters :: [Referenced Param],
-- | The request body applicable for this operation.
-- The requestBody is only supported in HTTP methods where the HTTP 1.1
-- specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1)
-- has explicitly defined semantics for request bodies.
-- In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
_operationRequestBody :: Maybe (Referenced RequestBody),
-- | The list of possible responses as they are returned from executing this operation.
_operationResponses :: Responses,
-- | A map of possible out-of band callbacks related to the parent operation.
-- The key is a unique identifier for the 'Callback' Object.
-- Each value in the map is a 'Callback' Object that describes a request
-- that may be initiated by the API provider and the expected responses.
_operationCallbacks :: InsOrdHashMap Text (Referenced Callback),
-- | Declares this operation to be deprecated.
-- Usage of the declared operation should be refrained.
-- Default value is @False@.
_operationDeprecated :: Maybe Bool,
-- | A declaration of which security schemes are applied for this operation.
-- The list of values describes alternative security schemes that can be used
-- (that is, there is a logical OR between the security requirements).
-- This definition overrides any declared top-level security.
-- To remove a top-level security declaration, @Just []@ can be used.
_operationSecurity :: [SecurityRequirement],
-- | An alternative server array to service this operation.
-- If an alternative server object is specified at the 'PathItem' Object or Root level,
-- it will be overridden by this value.
_operationServers :: [Server]
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- This instance should be in @http-media@.
instance Data MediaType where
gunfold k z c = case constrIndex c of
1 -> k (k (k (z (\main sub params -> foldl (/:) (main // sub) (Map.toList params)))))
_ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MediaType."
toConstr _ = mediaTypeConstr
dataTypeOf _ = mediaTypeData
mediaTypeConstr :: Constr
mediaTypeConstr = mkConstr mediaTypeData "MediaType" [] Prefix
mediaTypeData :: DataType
mediaTypeData = mkDataType "MediaType" [mediaTypeConstr]
instance Hashable MediaType where
hashWithSalt salt mt = salt `hashWithSalt` show mt
-- | Describes a single request body.
data RequestBody = RequestBody
{ -- | A brief description of the request body. This could contain examples of use.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_requestBodyDescription :: Maybe Text,
-- | The content of the request body.
-- The key is a media type or media type range and the value describes it.
-- For requests that match multiple keys, only the most specific key is applicable.
-- e.g. @text/plain@ overrides @text/\*@
_requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject,
-- | Determines if the request body is required in the request.
-- Defaults to 'False'.
_requestBodyRequired :: Maybe Bool
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Each Media Type Object provides schema and examples for the media type identified by its key.
data MediaTypeObject = MediaTypeObject
{ _mediaTypeObjectSchema :: Maybe (Referenced Schema),
-- | Example of the media type.
-- The example object SHOULD be in the correct format as specified by the media type.
_mediaTypeObjectExample :: Maybe Value,
-- | Examples of the media type.
-- Each example object SHOULD match the media type and specified schema if present.
_mediaTypeObjectExamples :: InsOrdHashMap Text (Referenced Example),
-- | A map between a property name and its encoding information.
-- The key, being the property name, MUST exist in the schema as a property.
-- The encoding object SHALL only apply to 'RequestBody' objects when the media type
-- is @multipart@ or @application/x-www-form-urlencoded@.
_mediaTypeObjectEncoding :: InsOrdHashMap Text Encoding
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | In order to support common ways of serializing simple parameters, a set of style values are defined.
data Style
= -- | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
StyleMatrix
| -- | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
StyleLabel
| -- | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
-- This option replaces @collectionFormat@ with a @csv@ (when @explode@ is false) or @multi@
-- (when explode is true) value from OpenAPI 2.0.
StyleForm
| -- | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7).
-- This option replaces @collectionFormat@ with a @csv@ value from OpenAPI 2.0.
StyleSimple
| -- | Space separated array values.
-- This option replaces @collectionFormat@ equal to @ssv@ from OpenAPI 2.0.
StyleSpaceDelimited
| -- | Pipe separated array values.
-- This option replaces @collectionFormat@ equal to @pipes@ from OpenAPI 2.0.
StylePipeDelimited
| -- | Provides a simple way of rendering nested objects using form parameters.
StyleDeepObject
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A single encoding definition applied to a request-body property, as
-- described by the OpenAPI Encoding Object (used inside 'MediaTypeObject').
data Encoding = Encoding
{ -- | The Content-Type for encoding a specific property.
-- Default value depends on the property type: for @string@
-- with format being @binary@ – @application/octet-stream@;
-- for other primitive types – @text/plain@; for object - @application/json@;
-- for array – the default is defined based on the inner type.
-- The value can be a specific media type (e.g. @application/json@),
-- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
_encodingContentType :: Maybe MediaType,
-- | A map allowing additional information to be provided as headers,
-- for example @Content-Disposition@. @Content-Type@ is described separately
-- and SHALL be ignored in this section.
-- This property SHALL be ignored if the request body media type is not a @multipart@.
_encodingHeaders :: InsOrdHashMap Text (Referenced Header),
-- | Describes how a specific property value will be serialized depending on its type.
-- See 'Param' Object for details on the style property.
-- The behavior follows the same values as query parameters, including default values.
-- This property SHALL be ignored if the request body media type
-- is not @application/x-www-form-urlencoded@.
_encodingStyle :: Maybe Style,
-- | When this is true, property values of type @array@ or @object@ generate
-- separate parameters for each value of the array,
-- or key-value-pair of the map.
-- For other types of properties this property has no effect.
-- When style is form, the default value is @true@. For all other styles,
-- the default value is @false@. This property SHALL be ignored
-- if the request body media type is not @application/x-www-form-urlencoded@.
_encodingExplode :: Maybe Bool,
-- | Determines whether the parameter value SHOULD allow reserved characters,
-- as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
-- @:/?#[]@!$&'()*+,;=@ to be included without percent-encoding.
-- The default value is @false@. This property SHALL be ignored if the request body media type
-- is not @application/x-www-form-urlencoded@.
_encodingAllowReserved :: Maybe Bool
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A list of media types, used wherever the spec lists @produces@/@consumes@-style
-- content types.
newtype MimeList = MimeList {getMimeList :: [MediaType]}
deriving stock (Eq, Show, Typeable)
deriving newtype (Semigroup, Monoid)
mimeListConstr :: Constr
mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
mimeListDataType :: DataType
mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
instance Data MimeList where
gunfold k z c = case constrIndex c of
1 -> k (z (MimeList . map fromString))
_ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
toConstr (MimeList _) = mimeListConstr
dataTypeOf _ = mimeListDataType
-- | Describes a single operation parameter.
-- A unique parameter is defined by a combination of a name and location.
data Param = Param
{ -- | The name of the parameter.
-- Parameter names are case sensitive.
_paramName :: Text,
-- | A brief description of the parameter.
-- This could contain examples of use.
-- CommonMark syntax MAY be used for rich text representation.
_paramDescription :: Maybe Text,
-- | Determines whether this parameter is mandatory.
-- If the parameter is in "path", this property is required and its value MUST be true.
-- Otherwise, the property MAY be included and its default value is @False@.
_paramRequired :: Maybe Bool,
-- | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
-- Default value is @false@.
_paramDeprecated :: Maybe Bool,
-- | The location of the parameter.
_paramIn :: ParamLocation,
-- | Sets the ability to pass empty-valued parameters.
-- This is valid only for 'ParamQuery' parameters and allows sending
-- a parameter with an empty value. Default value is @false@.
_paramAllowEmptyValue :: Maybe Bool,
-- | Determines whether the parameter value SHOULD allow reserved characters,
-- as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
-- @:/?#[]@!$&'()*+,;=@ to be included without percent-encoding.
-- This property only applies to parameters with an '_paramIn' value of 'ParamQuery'.
-- The default value is 'False'.
_paramAllowReserved :: Maybe Bool,
-- | Parameter schema.
_paramSchema :: Maybe (Referenced Schema),
-- | Describes how the parameter value will be serialized depending
-- on the type of the parameter value. Default values (based on value of '_paramIn'):
-- for 'ParamQuery' - 'StyleForm'; for 'ParamPath' - 'StyleSimple'; for 'ParamHeader' - 'StyleSimple';
-- for 'ParamCookie' - 'StyleForm'.
_paramStyle :: Maybe Style,
-- | When this is true, parameter values of type @array@ or @object@
-- generate separate parameters for each value of the array or key-value pair of the map.
-- For other types of parameters this property has no effect.
-- When style is @form@, the default value is true. For all other styles, the default value is false.
_paramExplode :: Maybe Bool,
-- | Example of the parameter's potential value.
-- The example SHOULD match the specified schema and encoding properties if present.
-- The '_paramExample' field is mutually exclusive of the '_paramExamples' field.
-- Furthermore, if referencing a schema that contains an example, the example value
-- SHALL override the example provided by the schema. To represent examples of media types
-- that cannot naturally be represented in JSON or YAML, a string value can contain
-- the example with escaping where necessary.
_paramExample :: Maybe Value,
-- | Examples of the parameter's potential value.
-- Each example SHOULD contain a value in the correct format as specified
-- in the parameter encoding. The '_paramExamples' field is mutually exclusive of the '_paramExample' field.
-- Furthermore, if referencing a schema that contains an example,
-- the examples value SHALL override the example provided by the schema.
_paramExamples :: InsOrdHashMap Text (Referenced Example)
-- TODO
-- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
-- should be singleton. mutually exclusive with _paramSchema.
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | An example value for a media type, parameter, or header, as described by
-- the OpenAPI Example Object.
data Example = Example
{ -- | Short description for the example.
_exampleSummary :: Maybe Text,
-- | Long description for the example.
-- CommonMark syntax MAY be used for rich text representation.
_exampleDescription :: Maybe Text,
-- | Embedded literal example.
-- The '_exampleValue' field and '_exampleExternalValue' field are mutually exclusive.
--
-- To represent examples of media types that cannot naturally represented in JSON or YAML,
-- use a string value to contain the example, escaping where necessary.
_exampleValue :: Maybe Value,
-- | A URL that points to the literal example.
-- This provides the capability to reference examples that cannot easily be included
-- in JSON or YAML documents. The '_exampleValue' field
-- and '_exampleExternalValue' field are mutually exclusive.
_exampleExternalValue :: Maybe URL
}
deriving stock (Eq, Show, Generic, Typeable, Data)
data ExpressionOrValue
= Expression Text
| Value Value
deriving stock (Eq, Show, Generic, Typeable, Data)
-- | The Link object represents a possible design-time link for a response.
-- The presence of a link does not guarantee the caller's ability to successfully invoke it,
-- rather it provides a known relationship and traversal mechanism between responses and other operations.
data Link = Link
{ -- | A relative or absolute URI reference to an OAS operation.
-- This field is mutually exclusive of the '_linkOperationId' field,
-- and MUST point to an 'Operation' Object. Relative '_linkOperationRef'
-- values MAY be used to locate an existing 'Operation' Object in the OpenAPI definition.
_linkOperationRef :: Maybe Text,
-- | The name of an /existing/, resolvable OAS operation, as defined with a unique
-- '_operationOperationId'. This field is mutually exclusive of the '_linkOperationRef' field.
_linkOperationId :: Maybe Text,
-- | A map representing parameters to pass to an operation as specified with '_linkOperationId'
-- or identified via '_linkOperationRef'. The key is the parameter name to be used, whereas
-- the value can be a constant or an expression to be evaluated and passed to the linked operation.
-- The parameter name can be qualified using the parameter location @[{in}.]{name}@
-- for operations that use the same parameter name in different locations (e.g. path.id).
_linkParameters :: InsOrdHashMap Text ExpressionOrValue,
-- | A literal value or @{expression}@ to use as a request body when calling the target operation.
_linkRequestBody :: Maybe ExpressionOrValue,
-- | A description of the link.
_linkDescription :: Maybe Text,
-- | A server object to be used by the target operation.
_linkServer :: Maybe Server
}
deriving stock (Eq, Show, Generic, Typeable, Data)
-- | The @items@ keyword. In OpenAPI 3.1 / JSON Schema 2020-12, @items@ is a single
-- schema or a boolean (@items: false@ means "no additional array items are allowed").
--
-- @'OpenApiItemsObject'@ specifies the schema every array element must satisfy.
--
-- @'OpenApiItemsBoolean'@ specifies @items: true@ or @items: false@.
--
-- Tuple validation (the old @items: [schema, ...]@ array form) is expressed via the
-- separate @_schemaPrefixItems@ field (positional schemas) together with @items: false@.
data OpenApiItems where
OpenApiItemsObject :: Referenced Schema -> OpenApiItems
OpenApiItemsBoolean :: Bool -> OpenApiItems
deriving stock (Eq, Show, Typeable, Data)
-- | A single JSON Schema primitive type, i.e. one element of a schema's @type@
-- keyword. Note 3.1 adds @"null"@ ('OpenApiNull'), used in type arrays to
-- express nullability.
data OpenApiType where
OpenApiString :: OpenApiType
OpenApiNumber :: OpenApiType
OpenApiInteger :: OpenApiType
OpenApiBoolean :: OpenApiType
OpenApiArray :: OpenApiType
OpenApiNull :: OpenApiType
OpenApiObject :: OpenApiType
deriving stock (Eq, Show, Typeable, Generic, Data)
-- | The value of a schema's @type@ keyword. In OpenAPI 3.1 / JSON Schema 2020-12,
-- @type@ may be a single type (@"string"@) or an array of types (@["string","null"]@,
-- the 3.1 way to express nullability — there is no @nullable@ keyword any more).
data OpenApiTypeValue
= OpenApiTypeSingle OpenApiType
| OpenApiTypeArray [OpenApiType]
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Extract a single type if the @type@ value is a single type (not an array).
-- Returns 'Nothing' for a type array.
singleType :: OpenApiTypeValue -> Maybe OpenApiType
singleType (OpenApiTypeSingle t) = Just t
singleType (OpenApiTypeArray _) = Nothing
-- | The location (@in@) of a 'Param': query string, header, path, or cookie.
data ParamLocation
= -- | Parameters that are appended to the URL.
-- For example, in @/items?id=###@, the query parameter is @id@.
ParamQuery
| -- | Custom headers that are expected as part of the request.
ParamHeader
| -- | Used together with Path Templating, where the parameter value is actually part of the operation's URL.
-- This does not include the host or base path of the API.
-- For example, in @/items/{itemId}@, the path parameter is @itemId@.
ParamPath
| -- | Used to pass a specific cookie value to the API.
ParamCookie
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The @format@ modifier of a schema or parameter (e.g. @"date-time"@,
-- @"int64"@). Open-ended free-form text per JSON Schema.
type Format = Text
-- | The name of a 'Param' or a required property of a 'Schema'.
type ParamName = Text
-- | An OpenAPI 3.1 Schema Object: a JSON Schema 2020-12 document describing the
-- shape of a JSON value. This is the central type of the library.
data Schema = Schema
{ _schemaTitle :: Maybe Text,
_schemaDescription :: Maybe Text,
_schemaRequired :: [ParamName],
_schemaAllOf :: Maybe [Referenced Schema],
_schemaOneOf :: Maybe [Referenced Schema],
_schemaNot :: Maybe (Referenced Schema),
_schemaAnyOf :: Maybe [Referenced Schema],
_schemaProperties :: InsOrdHashMap Text (Referenced Schema),
_schemaAdditionalProperties :: Maybe AdditionalProperties,
_schemaDiscriminator :: Maybe Discriminator,
_schemaReadOnly :: Maybe Bool,
_schemaWriteOnly :: Maybe Bool,
_schemaXml :: Maybe Xml,
_schemaExternalDocs :: Maybe ExternalDocs,
_schemaExample :: Maybe Value,
_schemaDeprecated :: Maybe Bool,
_schemaMaxProperties :: Maybe Integer,
_schemaMinProperties :: Maybe Integer,
-- | Declares the value of the parameter that the server will use if none is provided,
-- for example a @"count"@ to control the number of results per page might default to @100@
-- if not supplied by the client in the request.
-- (Note: "default" has no meaning for required parameters.)
-- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
_schemaDefault :: Maybe Value,
_schemaType :: Maybe OpenApiTypeValue,
_schemaFormat :: Maybe Format,
_schemaItems :: Maybe OpenApiItems,
_schemaMaximum :: Maybe Scientific,
_schemaExclusiveMaximum :: Maybe Scientific,
_schemaMinimum :: Maybe Scientific,
_schemaExclusiveMinimum :: Maybe Scientific,
_schemaMaxLength :: Maybe Integer,
_schemaMinLength :: Maybe Integer,
_schemaPattern :: Maybe Pattern,
_schemaMaxItems :: Maybe Integer,
_schemaMinItems :: Maybe Integer,
_schemaUniqueItems :: Maybe Bool,
_schemaEnum :: Maybe [Value],
_schemaMultipleOf :: Maybe Scientific,
-- JSON Schema 2020-12 additions (OpenAPI 3.1) — EP-4
_schemaConst :: Maybe Value,
_schemaPrefixItems :: Maybe [Referenced Schema],
_schemaContains :: Maybe (Referenced Schema),
_schemaMinContains :: Maybe Integer,
_schemaMaxContains :: Maybe Integer,
_schemaIf :: Maybe (Referenced Schema),
_schemaThen :: Maybe (Referenced Schema),
_schemaElse :: Maybe (Referenced Schema),
_schemaDependentSchemas :: Maybe (InsOrdHashMap Text (Referenced Schema)),
_schemaDependentRequired :: Maybe (InsOrdHashMap Text [Text]),
_schemaUnevaluatedProperties :: Maybe AdditionalProperties,
_schemaUnevaluatedItems :: Maybe (Referenced Schema),
_schemaPropertyNames :: Maybe (Referenced Schema),
_schemaContentEncoding :: Maybe Text,
_schemaContentMediaType :: Maybe Text,
_schemaContentSchema :: Maybe (Referenced Schema),
_schemaExamples :: Maybe [Value],
-- JSON Schema 2020-12 identification / reference keywords ($-prefixed) — EP-4
_schemaId :: Maybe Text,
_schemaAnchor :: Maybe Text,
_schemaDefs :: Maybe (InsOrdHashMap Text (Referenced Schema)),
_schemaRef :: Maybe Text,
-- \$ref (siblings allowed; see Decision Log)
_schemaDynamicRef :: Maybe Text,
_schemaDynamicAnchor :: Maybe Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
{-# DEPRECATED _schemaExample "Use _schemaExamples (JSON Schema examples) in OpenAPI 3.1" #-}
-- | Regex pattern for @string@ type.
type Pattern = Text
-- | Adds support for polymorphism via the OpenAPI Discriminator Object: names
-- the payload property that selects which schema (of an @oneOf@/@anyOf@) a value
-- conforms to.
data Discriminator = Discriminator
{ -- | The name of the property in the payload that will hold the discriminator value.
_discriminatorPropertyName :: Text,
-- | An object to hold mappings between payload values and schema names or references.
_discriminatorMapping :: InsOrdHashMap Text Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A @'Schema'@ with an optional name.
-- This name can be used in references.
data NamedSchema = NamedSchema
{ _namedSchemaName :: Maybe Text,
_namedSchemaSchema :: Schema
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Metadata for fine-tuning the XML representation of a schema, as described
-- by the OpenAPI XML Object.
data Xml = Xml
{ -- | Replaces the name of the element/attribute used for the described schema property.
-- When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list.
-- When defined alongside type being array (outside the items),
-- it will affect the wrapping element and only if wrapped is true.
-- If wrapped is false, it will be ignored.
_xmlName :: Maybe Text,
-- | The URL of the namespace definition.
-- Value SHOULD be in the form of a URL.
_xmlNamespace :: Maybe Text,
-- | The prefix to be used for the name.
_xmlPrefix :: Maybe Text,
-- | Declares whether the property definition translates to an attribute instead of an element.
-- Default value is @False@.
_xmlAttribute :: Maybe Bool,
-- | MAY be used only for an array definition.
-- Signifies whether the array is wrapped
-- (for example, @\<books\>\<book/\>\<book/\>\</books\>@)
-- or unwrapped (@\<book/\>\<book/\>@).
-- Default value is @False@.
-- The definition takes effect only when defined alongside type being array (outside the items).
_xmlWrapped :: Maybe Bool
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A container for the expected responses of an operation.
-- The container maps a HTTP response code to the expected response.
-- It is not expected from the documentation to necessarily cover all possible HTTP response codes,
-- since they may not be known in advance.
-- However, it is expected from the documentation to cover a successful operation response and any known errors.
data Responses = Responses
{ -- | The documentation of responses other than the ones declared for specific HTTP response codes.
-- It can be used to cover undeclared responses.
_responsesDefault :: Maybe (Referenced Response),
-- | Any HTTP status code can be used as the property name (one property per HTTP status code).
-- Describes the expected response for those HTTP status codes.
_responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | An HTTP status code keying an entry in 'Responses' (e.g. @200@, @404@).
type HttpStatusCode = Int
-- | Describes a single response from an API Operation.
data Response = Response
{ -- | A short description of the response.
-- [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation.
_responseDescription :: Text,
-- | A map containing descriptions of potential response payloads.
-- The key is a media type or media type range and the value describes it.
-- For responses that match multiple keys, only the most specific key is applicable.
-- e.g. @text/plain@ overrides @text/\*@.
_responseContent :: InsOrdHashMap MediaType MediaTypeObject,
-- | Maps a header name to its definition.
_responseHeaders :: InsOrdHashMap HeaderName (Referenced Header),
-- | A map of operations links that can be followed from the response.
-- The key of the map is a short name for the link, following the naming
-- constraints of the names for @'Components'@ Objects.
_responseLinks :: InsOrdHashMap Text (Referenced Link)
}
deriving stock (Eq, Show, Generic, Data, Typeable)
instance IsString Response where
fromString s = Response (fromString s) mempty mempty mempty
-- | A map of possible out-of band callbacks related to the parent operation.
-- Each value in the map is a 'PathItem' Object that describes a set of requests that
-- may be initiated by the API provider and the expected responses.
-- The key value used to identify the path item object is an expression, evaluated at runtime,
-- that identifies a URL to use for the callback operation.
newtype Callback = Callback (InsOrdHashMap Text PathItem)
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The name of a response 'Header'.
type HeaderName = Text
-- | Header fields have the same meaning as for 'Param'.
--
-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
data Header = Header
{ -- | A short description of the header.
_headerDescription :: Maybe HeaderName,
_headerRequired :: Maybe Bool,
_headerDeprecated :: Maybe Bool,
_headerAllowEmptyValue :: Maybe Bool,
_headerExplode :: Maybe Bool,
_headerExample :: Maybe Value,
_headerExamples :: InsOrdHashMap Text (Referenced Example),
_headerSchema :: Maybe (Referenced Schema)
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The location of the API key.
data ApiKeyLocation
= ApiKeyQuery
| ApiKeyHeader
| ApiKeyCookie
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Configuration for an @apiKey@ 'SecurityScheme': the name and location of
-- the key.
data ApiKeyParams = ApiKeyParams
{ -- | The name of the header or query parameter to be used.
_apiKeyName :: Text,
-- | The location of the API key.
_apiKeyIn :: ApiKeyLocation
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The authorization URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
type AuthorizationURL = Text
-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
type TokenURL = Text
-- | Flow-specific parameters for the OAuth2 implicit flow.
newtype OAuth2ImplicitFlow
= OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Flow-specific parameters for the OAuth2 resource-owner password flow.
newtype OAuth2PasswordFlow
= OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Flow-specific parameters for the OAuth2 client-credentials flow.
newtype OAuth2ClientCredentialsFlow
= OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Flow-specific parameters for the OAuth2 authorization-code flow.
data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
{ _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL,
_oAuth2AuthorizationCodeFlowTokenUrl :: TokenURL
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | A single OAuth2 flow, as described by the OpenAPI OAuth Flow Object. The
-- flow-specific parameters @p@ are one of the @OAuth2*Flow@ types above.
data OAuth2Flow p = OAuth2Flow
{ _oAuth2Params :: p,
-- | The URL to be used for obtaining refresh tokens.
_oAath2RefreshUrl :: Maybe URL,
-- | The available scopes for the OAuth2 security scheme.
-- A map between the scope name and a short description for it.
-- The map MAY be empty.
_oAuth2Scopes :: InsOrdHashMap Text Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The set of OAuth2 flows supported by a 'SecurityScheme', as described by
-- the OpenAPI OAuth Flows Object. Each flow is optional.
data OAuth2Flows = OAuth2Flows
{ -- | Configuration for the OAuth Implicit flow
_oAuth2FlowsImplicit :: Maybe (OAuth2Flow OAuth2ImplicitFlow),
-- | Configuration for the OAuth Resource Owner Password flow
_oAuth2FlowsPassword :: Maybe (OAuth2Flow OAuth2PasswordFlow),
-- | Configuration for the OAuth Client Credentials flow
_oAuth2FlowsClientCredentials :: Maybe (OAuth2Flow OAuth2ClientCredentialsFlow),
-- | Configuration for the OAuth Authorization Code flow
_oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
}
deriving stock (Eq, Show, Generic, Data, Typeable)
type BearerFormat = Text
-- | The scheme of an @http@ 'SecurityScheme' (an [IANA HTTP auth scheme](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml)):
-- @bearer@ (with an optional @bearerFormat@), @basic@, or a custom scheme name.
data HttpSchemeType
= HttpSchemeBearer (Maybe BearerFormat)
| HttpSchemeBasic
| HttpSchemeCustom Text
deriving stock (Eq, Show, Generic, Data, Typeable)
-- |
--
-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing))
-- {
-- "scheme": "bearer",
-- "type": "http"
-- }
--
-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
-- {
-- "bearerFormat": "jwt",
-- "scheme": "bearer",
-- "type": "http"
-- }
--
-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic)
-- {
-- "scheme": "basic",
-- "type": "http"
-- }
--
-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
-- {
-- "scheme": "CANARY",
-- "type": "http"
-- }
--
-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
-- {
-- "in": "cookie",
-- "name": "id",
-- "type": "apiKey"
-- }
data SecuritySchemeType
= SecuritySchemeHttp HttpSchemeType
| SecuritySchemeApiKey ApiKeyParams
| SecuritySchemeOAuth2 OAuth2Flows
| SecuritySchemeOpenIdConnect URL
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Defines a security scheme that can be used by an operation, as described by
-- the OpenAPI Security Scheme Object.
data SecurityScheme = SecurityScheme
{ -- | The type of the security scheme.
_securitySchemeType :: SecuritySchemeType,
-- | A short description for security scheme.
_securitySchemeDescription :: Maybe Text
}
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | The named 'SecurityScheme' definitions held under @components.securitySchemes@.
newtype SecurityDefinitions
= SecurityDefinitions (Definitions SecurityScheme)
deriving stock (Eq, Show, Generic, Data, Typeable)
-- | Lists the required security schemes to execute this operation.
-- The object can have multiple security schemes declared in it which are all required
-- (that is, there is a logical AND between the schemes).
newtype SecurityRequirement = SecurityRequirement
{ getSecurityRequirement :: InsOrdHashMap Text [Text]
}
deriving stock (Eq, Read, Show, Data, Typeable)
deriving newtype (Semigroup, Monoid, ToJSON, FromJSON)
-- | Tag name.
type TagName = Text
-- | Allows adding meta data to a single tag that is used by @Operation@.
-- It is not mandatory to have a @Tag@ per tag used there.
data Tag = Tag
{ -- | The name of the tag.
_tagName :: TagName,
-- | A short description for the tag.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_tagDescription :: Maybe Text,
-- | Additional external documentation for this tag.
_tagExternalDocs :: Maybe ExternalDocs
}
deriving stock (Eq, Ord, Show, Generic, Data, Typeable)
instance Hashable Tag
instance IsString Tag where
fromString s = Tag (fromString s) Nothing Nothing
-- | Allows referencing an external resource for extended documentation.
data ExternalDocs = ExternalDocs
{ -- | A short description of the target documentation.
-- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
_externalDocsDescription :: Maybe Text,
-- | The URL for the target documentation.
_externalDocsUrl :: URL
}
deriving stock (Eq, Ord, Show, Generic, Data, Typeable)
instance Hashable ExternalDocs
-- | A simple object to allow referencing other definitions in the specification.
-- It can be used to reference parameters and responses that are defined at the top level for reuse.
newtype Reference = Reference {getReference :: Text}
deriving stock (Eq, Show, Data, Typeable)
-- | Either an inline value of type @a@ or a 'Reference' to one declared
-- elsewhere (e.g. under @components@). Most spec fields that may be reused are
-- @'Referenced' a@.
data Referenced a
= Ref Reference
| Inline a
deriving stock (Eq, Show, Functor, Data, Typeable)
instance (IsString a) => IsString (Referenced a) where
fromString = Inline . fromString
-- | A URL string, used for links, terms of service, external docs, and the like.
newtype URL = URL {getUrl :: Text}
deriving stock (Eq, Ord, Show, Data, Typeable)
deriving newtype (Hashable, ToJSON, FromJSON)
-- | A schema's @additionalProperties@: either a boolean allowing or forbidding
-- properties beyond those listed, or a 'Schema' every additional property must
-- satisfy.
data AdditionalProperties
= AdditionalPropertiesAllowed Bool
| AdditionalPropertiesSchema (Referenced Schema)
deriving stock (Eq, Show, Data, Typeable)
newtype OpenApiSpecVersion = OpenApiSpecVersion {getVersion :: Version} deriving stock (Eq, Show, Generic, Data, Typeable)
-------------------------------------------------------------------------------
-- Generic instances
-------------------------------------------------------------------------------
deriveGeneric ''Server
deriveGeneric ''Components
deriveGeneric ''Header
deriveGeneric ''OAuth2Flow
deriveGeneric ''OAuth2Flows
deriveGeneric ''Operation
deriveGeneric ''Param
deriveGeneric ''PathItem
deriveGeneric ''Response
deriveGeneric ''RequestBody
deriveGeneric ''MediaTypeObject
deriveGeneric ''Responses
deriveGeneric ''SecurityScheme
deriveGeneric ''Schema
deriveGeneric ''OpenApi
deriveGeneric ''Example
deriveGeneric ''Encoding
deriveGeneric ''Link
deriveGeneric ''OpenApiSpecVersion
-- =======================================================================
-- Monoid instances
-- =======================================================================
instance Semigroup OpenApiSpecVersion where
(<>) (OpenApiSpecVersion a) (OpenApiSpecVersion b) = OpenApiSpecVersion $ max a b
instance Monoid OpenApiSpecVersion where
mempty = OpenApiSpecVersion (makeVersion [3, 1, 0])
mappend = (<>)
instance Semigroup OpenApi where
(<>) = genericMappend
instance Monoid OpenApi where
mempty = genericMempty
mappend = (<>)
instance Semigroup Info where
(<>) = genericMappend
instance Monoid Info where
mempty = genericMempty
mappend = (<>)
instance Semigroup Contact where
(<>) = genericMappend
instance Monoid Contact where
mempty = genericMempty
mappend = (<>)
instance Semigroup Components where
(<>) = genericMappend
instance Monoid Components where
mempty = genericMempty
mappend = (<>)
instance Semigroup PathItem where
(<>) = genericMappend
instance Monoid PathItem where
mempty = genericMempty
mappend = (<>)
instance Semigroup Schema where
(<>) = genericMappend
instance Monoid Schema where
mempty = genericMempty
mappend = (<>)
instance Semigroup Param where
(<>) = genericMappend
instance Monoid Param where
mempty = genericMempty
mappend = (<>)
instance Semigroup Header where
(<>) = genericMappend
instance Monoid Header where
mempty = genericMempty
mappend = (<>)
instance Semigroup Responses where
(<>) = genericMappend
instance Monoid Responses where
mempty = genericMempty
mappend = (<>)
instance Semigroup Response where
(<>) = genericMappend
instance Monoid Response where
mempty = genericMempty
mappend = (<>)
instance Semigroup MediaTypeObject where
(<>) = genericMappend
instance Monoid MediaTypeObject where
mempty = genericMempty
mappend = (<>)
instance Semigroup Encoding where
(<>) = genericMappend
instance Monoid Encoding where
mempty = genericMempty
mappend = (<>)
instance Semigroup ExternalDocs where
(<>) = genericMappend
instance Monoid ExternalDocs where
mempty = genericMempty
mappend = (<>)
instance Semigroup Operation where
(<>) = genericMappend
instance Monoid Operation where
mempty = genericMempty
mappend = (<>)
instance Semigroup (OAuth2Flow p) where
l@OAuth2Flow {_oAath2RefreshUrl = lUrl, _oAuth2Scopes = lScopes}
<> OAuth2Flow {_oAath2RefreshUrl = rUrl, _oAuth2Scopes = rScopes} =
l {_oAath2RefreshUrl = openApiMappend lUrl rUrl, _oAuth2Scopes = lScopes <> rScopes}
-- openApiMappend has First-like semantics, and here we need mappend'ing under Maybes.
instance Semigroup OAuth2Flows where
l <> r =
OAuth2Flows
{ _oAuth2FlowsImplicit = _oAuth2FlowsImplicit l <> _oAuth2FlowsImplicit r,
_oAuth2FlowsPassword = _oAuth2FlowsPassword l <> _oAuth2FlowsPassword r,
_oAuth2FlowsClientCredentials = _oAuth2FlowsClientCredentials l <> _oAuth2FlowsClientCredentials r,
_oAuth2FlowsAuthorizationCode = _oAuth2FlowsAuthorizationCode l <> _oAuth2FlowsAuthorizationCode r
}
instance Monoid OAuth2Flows where
mempty = genericMempty
mappend = (<>)
instance Semigroup SecurityScheme where
SecurityScheme (SecuritySchemeOAuth2 lFlows) lDesc
<> SecurityScheme (SecuritySchemeOAuth2 rFlows) rDesc =
SecurityScheme (SecuritySchemeOAuth2 $ lFlows <> rFlows) (openApiMappend lDesc rDesc)
l <> _ = l
instance Semigroup SecurityDefinitions where
(SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
instance Monoid SecurityDefinitions where
mempty = SecurityDefinitions InsOrdHashMap.empty
mappend = (<>)
instance Semigroup RequestBody where
(<>) = genericMappend
instance Monoid RequestBody where
mempty = genericMempty
mappend = (<>)
-- =======================================================================
-- OpenApiMonoid helper instances
-- =======================================================================
instance OpenApiMonoid Info
instance OpenApiMonoid Components
instance OpenApiMonoid PathItem
instance OpenApiMonoid Schema
instance OpenApiMonoid Param
instance OpenApiMonoid Responses
instance OpenApiMonoid Response
instance OpenApiMonoid ExternalDocs
instance OpenApiMonoid Operation
instance (Eq a, Hashable a) => OpenApiMonoid (InsOrdHashSet a)
instance OpenApiMonoid SecurityDefinitions
instance OpenApiMonoid OpenApiSpecVersion
instance OpenApiMonoid MimeList
deriving newtype instance OpenApiMonoid URL
instance OpenApiMonoid OpenApiType where
openApiMempty = OpenApiString
openApiMappend _ y = y
instance OpenApiMonoid OpenApiTypeValue where
openApiMempty = OpenApiTypeSingle OpenApiString
openApiMappend _ y = y
instance OpenApiMonoid ParamLocation where
openApiMempty = ParamQuery
openApiMappend _ y = y
instance {-# OVERLAPPING #-} OpenApiMonoid (InsOrdHashMap FilePath PathItem) where
openApiMempty = InsOrdHashMap.empty
openApiMappend = InsOrdHashMap.unionWith mappend
instance (Monoid a) => OpenApiMonoid (Referenced a) where
openApiMempty = Inline mempty
openApiMappend (Inline x) (Inline y) = Inline (mappend x y)
openApiMappend _ y = y
-- =======================================================================
-- Simple Generic-based ToJSON instances
-- =======================================================================
instance ToJSON Style where
toJSON = genericToJSON (jsonPrefix "Style")
instance ToJSON OpenApiType where
toJSON = genericToJSON (jsonPrefix "OpenApi")
instance ToJSON ParamLocation where
toJSON = genericToJSON (jsonPrefix "Param")
instance ToJSON Info where
toJSON = genericToJSON (jsonPrefix "Info")
instance ToJSON Contact where
toJSON = genericToJSON (jsonPrefix "Contact")
instance ToJSON License where
toJSON = genericToJSON (jsonPrefix "License")
instance ToJSON ServerVariable where
toJSON = genericToJSON (jsonPrefix "ServerVariable")
instance ToJSON ApiKeyLocation where
toJSON = genericToJSON (jsonPrefix "ApiKey")
instance ToJSON ApiKeyParams where
toJSON = genericToJSON (jsonPrefix "apiKey")
instance ToJSON Tag where
toJSON = genericToJSON (jsonPrefix "Tag")
instance ToJSON ExternalDocs where
toJSON = genericToJSON (jsonPrefix "ExternalDocs")
instance ToJSON Xml where
toJSON = genericToJSON (jsonPrefix "Xml")
instance ToJSON Discriminator where
toJSON = genericToJSON (jsonPrefix "Discriminator")
instance ToJSON OAuth2ImplicitFlow where
toJSON = genericToJSON (jsonPrefix "OAuth2ImplicitFlow")
instance ToJSON OAuth2PasswordFlow where
toJSON = genericToJSON (jsonPrefix "OAuth2PasswordFlow")
instance ToJSON OAuth2ClientCredentialsFlow where
toJSON = genericToJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
instance ToJSON OAuth2AuthorizationCodeFlow where
toJSON = genericToJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
-- =======================================================================
-- Simple Generic-based FromJSON instances
-- =======================================================================
instance FromJSON Style where
parseJSON = genericParseJSON (jsonPrefix "Style")
instance FromJSON OpenApiType where
parseJSON = genericParseJSON (jsonPrefix "OpenApi")
instance ToJSON OpenApiTypeValue where
toJSON (OpenApiTypeSingle t) = toJSON t -- reuses ToJSON OpenApiType -> a JSON string
toJSON (OpenApiTypeArray ts) = toJSON ts -- a JSON array of strings
instance FromJSON OpenApiTypeValue where
parseJSON v@(String _) = OpenApiTypeSingle <$> parseJSON v
parseJSON v@(Array _) = OpenApiTypeArray <$> parseJSON v
parseJSON _ = fail "type must be a string or an array of strings"
instance FromJSON ParamLocation where
parseJSON = genericParseJSON (jsonPrefix "Param")
instance FromJSON Info where
parseJSON = genericParseJSON (jsonPrefix "Info")
instance FromJSON Contact where
parseJSON = genericParseJSON (jsonPrefix "Contact")
instance FromJSON License where
parseJSON = genericParseJSON (jsonPrefix "License")
instance FromJSON ServerVariable where
parseJSON = genericParseJSON (jsonPrefix "ServerVariable")
instance FromJSON ApiKeyLocation where
parseJSON = genericParseJSON (jsonPrefix "ApiKey")
instance FromJSON ApiKeyParams where
parseJSON = genericParseJSON (jsonPrefix "apiKey")
instance FromJSON Tag where
parseJSON = genericParseJSON (jsonPrefix "Tag")
instance FromJSON ExternalDocs where
parseJSON = genericParseJSON (jsonPrefix "ExternalDocs")
instance FromJSON Discriminator where
parseJSON = genericParseJSON (jsonPrefix "Discriminator")
instance FromJSON OAuth2ImplicitFlow where
parseJSON = genericParseJSON (jsonPrefix "OAuth2ImplicitFlow")
instance FromJSON OAuth2PasswordFlow where
parseJSON = genericParseJSON (jsonPrefix "OAuth2PasswordFlow")
instance FromJSON OAuth2ClientCredentialsFlow where
parseJSON = genericParseJSON (jsonPrefix "OAuth2ClientCredentialsFlow")
instance FromJSON OAuth2AuthorizationCodeFlow where
parseJSON = genericParseJSON (jsonPrefix "OAuth2AuthorizationCodeFlow")
-- =======================================================================
-- Manual ToJSON instances
-- =======================================================================
instance ToJSON OpenApiSpecVersion where
toJSON (OpenApiSpecVersion v) = toJSON . showVersion $ v
instance ToJSON MediaType where
toJSON = toJSON . show
toEncoding = toEncoding . show
instance ToJSONKey MediaType where
toJSONKey = JSON.toJSONKeyText (Text.pack . show)
instance (Eq p, ToJSON p, AesonDefaultValue p) => ToJSON (OAuth2Flow p) where
toJSON a =
sopOpenApiGenericToJSON a
& if InsOrdHashMap.null (_oAuth2Scopes a)
then (<+> object ["scopes" .= object []])
else id
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON OAuth2Flows where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON SecuritySchemeType where
toJSON (SecuritySchemeHttp ty) = case ty of
HttpSchemeBearer mFmt ->
object
$ [ "type" .= ("http" :: Text),
"scheme" .= ("bearer" :: Text)
]
<> maybe [] (\t -> ["bearerFormat" .= t]) mFmt
HttpSchemeBasic ->
object
[ "type" .= ("http" :: Text),
"scheme" .= ("basic" :: Text)
]
HttpSchemeCustom t ->
object
[ "type" .= ("http" :: Text),
"scheme" .= t
]
toJSON (SecuritySchemeApiKey params) =
toJSON params
<+> object ["type" .= ("apiKey" :: Text)]
toJSON (SecuritySchemeOAuth2 params) =
object
[ "type" .= ("oauth2" :: Text),
"flows" .= toJSON params
]
toJSON (SecuritySchemeOpenIdConnect url) =
object
[ "type" .= ("openIdConnect" :: Text),
"openIdConnectUrl" .= url
]
instance ToJSON OpenApi where
toJSON a =
sopOpenApiGenericToJSON a
& if InsOrdHashMap.null (_openApiPaths a)
then (<+> object ["paths" .= object []])
else id
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Server where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON SecurityScheme where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
-- | The canonical rename table mapping the plain keys produced by the generic
-- field-name rule to their JSON Schema 2020-12 @$@-prefixed spellings. Owned by
-- EP-4 (Integration Point IP-3); EP-5 imports the helpers and supplies its own table.
schemaDollarKeyRenames :: [(Text, Text)]
schemaDollarKeyRenames =
[ ("id", "$id"),
("anchor", "$anchor"),
("defs", "$defs"),
("ref", "$ref"),
("dynamicRef", "$dynamicRef"),
("dynamicAnchor", "$dynamicAnchor")
]
instance ToJSON Schema where
toJSON =
applyKeyRenamesToJSON schemaDollarKeyRenames
. sopOpenApiGenericToJSONWithOpts
(mkOpenApiAesonOptions "schema" & saoSubObject ?~ "items")
instance ToJSON Header where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
-- | Both cases wrap the value in a single @"items"@ key. The @ToJSON Schema@
-- instance uses @saoSubObject ?~ "items"@, which lifts that single key up into the
-- parent schema object — so an object emits @"items": {..}@ and a boolean emits
-- @"items": true|false@.
instance ToJSON OpenApiItems where
toJSON (OpenApiItemsObject x) = object ["items" .= x]
toJSON (OpenApiItemsBoolean b) = object ["items" .= b]
instance ToJSON Components where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON MimeList where
toJSON (MimeList xs) = toJSON (map show xs)
instance ToJSON Param where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Responses where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Response where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Operation where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
-- | @PathItem@'s only @$@-prefixed key. Reuses EP-4's shared helper (IP-3).
pathItemDollarKeyRenames :: [(Text, Text)]
pathItemDollarKeyRenames = [("ref", "$ref")]
instance ToJSON PathItem where
toJSON = applyKeyRenamesToJSON pathItemDollarKeyRenames . sopOpenApiGenericToJSON
-- No hand-rolled toEncoding: it would bypass the $ref rename pass; let aeson
-- derive toEncoding from toJSON so the rename always runs.
instance ToJSON RequestBody where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON MediaTypeObject where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Example where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Encoding where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON Link where
toJSON = sopOpenApiGenericToJSON
toEncoding = sopOpenApiGenericToEncoding
instance ToJSON SecurityDefinitions where
toJSON (SecurityDefinitions sd) = toJSON sd
instance ToJSON Reference where
toJSON (Reference ref) = object ["$ref" .= ref]
referencedToJSON :: (ToJSON a) => Text -> Referenced a -> Value
referencedToJSON prefix (Ref (Reference ref)) = object ["$ref" .= (prefix <> ref)]
referencedToJSON _ (Inline x) = toJSON x
instance ToJSON (Referenced Schema) where toJSON = referencedToJSON "#/components/schemas/"
instance ToJSON (Referenced Param) where toJSON = referencedToJSON "#/components/parameters/"
instance ToJSON (Referenced Response) where toJSON = referencedToJSON "#/components/responses/"
instance ToJSON (Referenced RequestBody) where toJSON = referencedToJSON "#/components/requestBodies/"
instance ToJSON (Referenced Example) where toJSON = referencedToJSON "#/components/examples/"
instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/components/headers/"
instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
instance ToJSON (Referenced PathItem) where toJSON = referencedToJSON "#/components/pathItems/"
instance ToJSON AdditionalProperties where
toJSON (AdditionalPropertiesAllowed b) = toJSON b
toJSON (AdditionalPropertiesSchema s) = toJSON s
instance ToJSON ExpressionOrValue where
toJSON (Expression expr) = toJSON expr
toJSON (Value val) = toJSON val
instance ToJSON Callback where
toJSON (Callback ps) = toJSON ps
-- =======================================================================
-- Manual FromJSON instances
-- =======================================================================
instance FromJSON OpenApiSpecVersion where
parseJSON = withText "OpenApiSpecVersion" $ \str ->
let validatedVersion :: Either String Version
validatedVersion = do
parsedVersion <- readVersion str
unless ((parsedVersion >= lowerOpenApiSpecVersion) && (parsedVersion <= upperOpenApiSpecVersion))
$ Left ("The provided version " <> showVersion parsedVersion <> " is out of the allowed range >=" <> showVersion lowerOpenApiSpecVersion <> " && <=" <> showVersion upperOpenApiSpecVersion)
return parsedVersion
in either fail (return . OpenApiSpecVersion) validatedVersion
where
readVersion :: Text -> Either String Version
readVersion v = case readP_to_S parseVersion (Text.unpack v) of
[] -> Left $ "Failed to parse as a version string " <> Text.unpack v
solutions -> Right (fst . last $ solutions)
instance FromJSON MediaType where
parseJSON = withText "MediaType" $ \str ->
maybe (fail $ "Invalid media type literal " <> Text.unpack str) pure $ parseAccept $ encodeUtf8 str
instance FromJSONKey MediaType where
fromJSONKey = FromJSONKeyTextParser (parseJSON . String)
instance (Eq p, FromJSON p, AesonDefaultValue p) => FromJSON (OAuth2Flow p) where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON OAuth2Flows where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON SecuritySchemeType where
parseJSON js@(Object o) = do
(t :: Text) <- o .: "type"
case t of
"http" -> do
scheme <- o .: "scheme"
SecuritySchemeHttp <$> case scheme of
"bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
"basic" -> pure HttpSchemeBasic
t -> pure $ HttpSchemeCustom t
"apiKey" -> SecuritySchemeApiKey <$> parseJSON js
"oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
"openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
_ -> empty
parseJSON _ = empty
instance FromJSON OpenApi where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Server where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON SecurityScheme where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Schema where
parseJSON = withObject "Schema" $ \o ->
sopOpenApiGenericParseJSON (Object (applyKeyRenamesParseJSON schemaDollarKeyRenames o))
instance FromJSON Header where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON OpenApiItems where
parseJSON (Bool b) = pure (OpenApiItemsBoolean b)
parseJSON js@(Object _) = OpenApiItemsObject <$> parseJSON js
parseJSON _ = fail "items must be a schema object or a boolean"
instance FromJSON Components where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON MimeList where
parseJSON js = MimeList . map fromString <$> parseJSON js
instance FromJSON Param where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Responses where
parseJSON (Object o) =
Responses
<$> o .:? "default"
<*> parseJSON (Object (deleteKey "default" o))
parseJSON _ = empty
instance FromJSON Example where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Response where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Operation where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON PathItem where
parseJSON = withObject "PathItem" $ \o ->
sopOpenApiGenericParseJSON (Object (applyKeyRenamesParseJSON pathItemDollarKeyRenames o))
instance FromJSON SecurityDefinitions where
parseJSON js = SecurityDefinitions <$> parseJSON js
instance FromJSON RequestBody where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON MediaTypeObject where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Encoding where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Link where
parseJSON = sopOpenApiGenericParseJSON
instance FromJSON Reference where
parseJSON (Object o) = Reference <$> o .: "$ref"
parseJSON _ = empty
referencedParseJSON :: (FromJSON a) => Text -> Value -> JSON.Parser (Referenced a)
referencedParseJSON prefix js@(Object o) = do
ms <- o .:? "$ref"
case ms of
Nothing -> Inline <$> parseJSON js
Just s -> case Text.stripPrefix prefix s of
-- Pure component reference (sole @$ref@ key, value under the component
-- prefix) stays a 'Ref'. Anything else — siblings present, or a @$ref@ that
-- does not target a component (e.g. @#/$defs/A@) — is a JSON Schema 2020-12
-- inline schema that carries @$ref@ alongside other keywords (see Decision Log).
Just suffix | KeyMap.size o == 1 -> pure (Ref (Reference suffix))
_ -> Inline <$> parseJSON js
-- JSON Schema 2020-12 boolean schemas: @true@ accepts everything, @false@ rejects
-- everything. Decode them to canonical inline schemas (see Decision Log).
referencedParseJSON _ (Bool True) = Inline <$> parseJSON (Object mempty)
referencedParseJSON _ (Bool False) = Inline <$> parseJSON (object ["not" .= object []])
referencedParseJSON _ _ = fail "referenceParseJSON: not an object or boolean"
instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/components/schemas/"
instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/components/parameters/"
instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#/components/responses/"
instance FromJSON (Referenced RequestBody) where parseJSON = referencedParseJSON "#/components/requestBodies/"
instance FromJSON (Referenced Example) where parseJSON = referencedParseJSON "#/components/examples/"
instance FromJSON (Referenced Header) where parseJSON = referencedParseJSON "#/components/headers/"
instance FromJSON (Referenced Link) where parseJSON = referencedParseJSON "#/components/links/"
instance FromJSON (Referenced Callback) where parseJSON = referencedParseJSON "#/components/callbacks/"
instance FromJSON (Referenced PathItem) where parseJSON = referencedParseJSON "#/components/pathItems/"
instance FromJSON Xml where
parseJSON = genericParseJSON (jsonPrefix "xml")
instance FromJSON AdditionalProperties where
parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
-- | All strings are parsed as expressions
instance FromJSON ExpressionOrValue where
parseJSON (String expr) = pure $ Expression expr
parseJSON v = pure $ Value v
instance FromJSON Callback where
parseJSON = fmap Callback . parseJSON
instance HasOpenApiAesonOptions Server where
openApiAesonOptions _ = mkOpenApiAesonOptions "server"
instance HasOpenApiAesonOptions Components where
openApiAesonOptions _ = mkOpenApiAesonOptions "components"
instance HasOpenApiAesonOptions Header where
openApiAesonOptions _ = mkOpenApiAesonOptions "header"
instance (AesonDefaultValue p) => HasOpenApiAesonOptions (OAuth2Flow p) where
openApiAesonOptions _ = mkOpenApiAesonOptions "oauth2" & saoSubObject ?~ "params"
instance HasOpenApiAesonOptions OAuth2Flows where
openApiAesonOptions _ = mkOpenApiAesonOptions "oauth2Flows"
instance HasOpenApiAesonOptions Operation where
openApiAesonOptions _ = mkOpenApiAesonOptions "operation"
instance HasOpenApiAesonOptions Param where
openApiAesonOptions _ = mkOpenApiAesonOptions "param"
instance HasOpenApiAesonOptions PathItem where
openApiAesonOptions _ = mkOpenApiAesonOptions "pathItem"
instance HasOpenApiAesonOptions Response where
openApiAesonOptions _ = mkOpenApiAesonOptions "response"
instance HasOpenApiAesonOptions RequestBody where
openApiAesonOptions _ = mkOpenApiAesonOptions "requestBody"
instance HasOpenApiAesonOptions MediaTypeObject where
openApiAesonOptions _ = mkOpenApiAesonOptions "mediaTypeObject"
instance HasOpenApiAesonOptions Responses where
openApiAesonOptions _ = mkOpenApiAesonOptions "responses" & saoSubObject ?~ "responses"
instance HasOpenApiAesonOptions SecurityScheme where
openApiAesonOptions _ = mkOpenApiAesonOptions "securityScheme" & saoSubObject ?~ "type"
instance HasOpenApiAesonOptions Schema where
openApiAesonOptions _ = mkOpenApiAesonOptions "schema" & saoSubObject ?~ "paramSchema"
instance HasOpenApiAesonOptions OpenApiSpecVersion where
openApiAesonOptions _ = mkOpenApiAesonOptions "openapi"
instance HasOpenApiAesonOptions OpenApi where
openApiAesonOptions _ = mkOpenApiAesonOptions "openApi"
instance HasOpenApiAesonOptions Example where
openApiAesonOptions _ = mkOpenApiAesonOptions "example"
instance HasOpenApiAesonOptions Encoding where
openApiAesonOptions _ = mkOpenApiAesonOptions "encoding"
instance HasOpenApiAesonOptions Link where
openApiAesonOptions _ = mkOpenApiAesonOptions "link"
instance AesonDefaultValue Version where
defaultValue = Just (makeVersion [3, 1, 0])
instance AesonDefaultValue OpenApiSpecVersion
instance AesonDefaultValue Server
instance AesonDefaultValue Components
instance AesonDefaultValue OAuth2ImplicitFlow
instance AesonDefaultValue OAuth2PasswordFlow
instance AesonDefaultValue OAuth2ClientCredentialsFlow
instance AesonDefaultValue OAuth2AuthorizationCodeFlow
instance (AesonDefaultValue p) => AesonDefaultValue (OAuth2Flow p)
instance AesonDefaultValue Responses
instance AesonDefaultValue SecuritySchemeType
instance AesonDefaultValue OpenApiType
instance AesonDefaultValue MimeList where defaultValue = Just mempty
instance AesonDefaultValue Info
instance AesonDefaultValue ParamLocation
instance AesonDefaultValue Link
instance AesonDefaultValue SecurityDefinitions where
defaultValue = Just mempty