Data.OpenAPI.V3_0_0

Documentation

data Components

Components schemas responses parameters examples requestBodies headers securitySchemes links callbacks x

Constructors

Components

Fields

• _components_schemas :: Maybe (HashMap Text (ReferenceOr Schema))
• _components_responses :: Maybe (HashMap Text (ReferenceOr Response))
• _components_parameters :: Maybe (HashMap Text (ReferenceOr Parameter))
• _components_examples :: Maybe (HashMap Text (ReferenceOr Example))
• _components_requestBodies :: Maybe (HashMap Text (ReferenceOr RequestBody))
• _components_headers :: Maybe (HashMap Text (ReferenceOr Header))
• _components_securitySchemes :: Maybe (HashMap Text SecuritySchema)
• _components_links :: Maybe (HashMap Text (ReferenceOr Link))
• _components_callbacks :: Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))
• _components_x :: Maybe (HashMap Text Value)

Instances

Eq Components

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Components -> Components -> Bool

(/=) :: Components -> Components -> Bool

Show Components

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Components -> ShowS

show :: Components -> String

showList :: [Components] -> ShowS

ToJSON Components

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Components -> Value

toEncoding :: Components -> Encoding

toJSONList :: [Components] -> Value

toEncodingList :: [Components] -> Encoding

FromJSON Components

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Components

parseJSONList :: Value -> Parser [Components]

getSchemaExclusiveMaximum :: Schema -> Maybe BoolInt

setSchemaExclusiveMaximum :: Schema -> Maybe BoolInt -> Schema

eitherSecuritySchemaHTTPSS :: SecuritySchema -> Either SecuritySchema HTTPSecurityScheme

getAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text

setAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme

getOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows

setOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows -> OAuth2SecurityScheme

getServerUrl :: Server -> Text

setServerUrl :: Server -> Text -> Server

getParameterExplode :: Parameter -> Maybe Bool

setParameterExplode :: Parameter -> Maybe Bool -> Parameter

getOpenAPIObjectTags :: OpenAPIObject -> Maybe [Tag]

setOpenAPIObjectTags :: OpenAPIObject -> Maybe [Tag] -> OpenAPIObject

eitherAdditionalBool :: Additionals -> Either Additionals Bool

getSchemaDeprecated :: Schema -> Maybe Bool

setSchemaDeprecated :: Schema -> Maybe Bool -> Schema

getOperationRequestBody :: Operation -> Maybe (ReferenceOr RequestBody)

setOperationRequestBody :: Operation -> Maybe (ReferenceOr RequestBody) -> Operation

getServerDescription :: Server -> Maybe Text

setServerDescription :: Server -> Maybe Text -> Server

data ServerVariable

ServerVariable default enum description x

Constructors

ServerVariable

Fields

• _serverVariable_default :: Text
• _serverVariable_enum :: Maybe [Text]
• _serverVariable_description :: Maybe Text
• _serverVariable_x :: Maybe (HashMap Text Value)

Instances

Eq ServerVariable

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: ServerVariable -> ServerVariable -> Bool

(/=) :: ServerVariable -> ServerVariable -> Bool

Show ServerVariable

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> ServerVariable -> ShowS

show :: ServerVariable -> String

showList :: [ServerVariable] -> ShowS

ToJSON ServerVariable

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: ServerVariable -> Value

toEncoding :: ServerVariable -> Encoding

toJSONList :: [ServerVariable] -> Value

toEncodingList :: [ServerVariable] -> Encoding

FromJSON ServerVariable

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser ServerVariable

parseJSONList :: Value -> Parser [ServerVariable]

getOpenAPIObjectOpenapi :: OpenAPIObject -> Text

setOpenAPIObjectOpenapi :: OpenAPIObject -> Text -> OpenAPIObject

getEncodingHeaders :: Encoding -> Maybe (HashMap Text Header)

setEncodingHeaders :: Encoding -> Maybe (HashMap Text Header) -> Encoding

getOperationDeprecated :: Operation -> Maybe Bool

setOperationDeprecated :: Operation -> Maybe Bool -> Operation

eitherBoolIntBool :: BoolInt -> Either BoolInt Bool

getPathItemPut :: PathItem -> Maybe Operation

setPathItemPut :: PathItem -> Maybe Operation -> PathItem

getLinkParameters :: Link -> Maybe (HashMap Text Value)

setLinkParameters :: Link -> Maybe (HashMap Text Value) -> Link

getPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text

setPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text -> PasswordOAuthFlow

data Schema

Schema title multipleOf maximum exclusiveMaximum minimum exclusiveMinimum maxLength minLength pattern maxItems minItems uniqueItems maxProperties minProperties required enum allOf oneOf anyOf items properties additionalProperties description default nullable discriminator readOnly writeOnly example externalDocs deprecated xml format type not x

Constructors

Schema

Fields

• _schema_title :: Maybe Text
• _schema_multipleOf :: Maybe Double
• _schema_maximum :: Maybe Double
• _schema_exclusiveMaximum :: Maybe BoolInt
• _schema_minimum :: Maybe Double
• _schema_exclusiveMinimum :: Maybe BoolInt
• _schema_maxLength :: Maybe Int
• _schema_minLength :: Maybe Int
• _schema_pattern :: Maybe Text
• _schema_maxItems :: Maybe Int
• _schema_minItems :: Maybe Int
• _schema_uniqueItems :: Maybe Bool
• _schema_maxProperties :: Maybe Int
• _schema_minProperties :: Maybe Int
• _schema_required :: Maybe [Text]
• _schema_enum :: Maybe [Value]
• _schema_allOf :: Maybe [ReferenceOr Schema]
• _schema_oneOf :: Maybe [ReferenceOr Schema]
• _schema_anyOf :: Maybe [ReferenceOr Schema]
• _schema_items :: Maybe Items
• _schema_properties :: Maybe (HashMap Text (ReferenceOr Schema))
• _schema_additionalProperties :: Maybe Additionals
• _schema_description :: Maybe Text
• _schema_default :: Maybe Value
• _schema_nullable :: Maybe Bool
• _schema_discriminator :: Maybe Discriminator
• _schema_readOnly :: Maybe Bool
• _schema_writeOnly :: Maybe Bool
• _schema_example :: Maybe Value
• _schema_externalDocs :: Maybe ExternalDocumentation
• _schema_deprecated :: Maybe Bool
• _schema_xml :: Maybe XML
• _schema_format :: Maybe Text
• _schema_type :: Maybe Text
• _schema_not :: Maybe (ReferenceOr Schema)
• _schema_x :: Maybe (HashMap Text Value)

Instances

Eq Schema

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Schema -> Schema -> Bool

(/=) :: Schema -> Schema -> Bool

Show Schema

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Schema -> ShowS

show :: Schema -> String

showList :: [Schema] -> ShowS

ToJSON Schema

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Schema -> Value

toEncoding :: Schema -> Encoding

toJSONList :: [Schema] -> Value

toEncodingList :: [Schema] -> Encoding

FromJSON Schema

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Schema

parseJSONList :: Value -> Parser [Schema]

getPathItemOptions :: PathItem -> Maybe Operation

setPathItemOptions :: PathItem -> Maybe Operation -> PathItem

getComponentsRequestBodies :: Components -> Maybe (HashMap Text (ReferenceOr RequestBody))

setComponentsRequestBodies :: Components -> Maybe (HashMap Text (ReferenceOr RequestBody)) -> Components

getOAuthFlowsX :: OAuthFlows -> Maybe (HashMap Text Value)

setOAuthFlowsX :: OAuthFlows -> Maybe (HashMap Text Value) -> OAuthFlows

getParameterDescription :: Parameter -> Maybe Text

setParameterDescription :: Parameter -> Maybe Text -> Parameter

getComponentsHeaders :: Components -> Maybe (HashMap Text (ReferenceOr Header))

setComponentsHeaders :: Components -> Maybe (HashMap Text (ReferenceOr Header)) -> Components

getSchemaWriteOnly :: Schema -> Maybe Bool

setSchemaWriteOnly :: Schema -> Maybe Bool -> Schema

getHeaderExamples :: Header -> Maybe (HashMap Text (ReferenceOr Example))

setHeaderExamples :: Header -> Maybe (HashMap Text (ReferenceOr Example)) -> Header

getMediaTypeExamples :: MediaType -> Maybe (HashMap Text (ReferenceOr Example))

setMediaTypeExamples :: MediaType -> Maybe (HashMap Text (ReferenceOr Example)) -> MediaType

getLicenseUrl :: License -> Maybe Text

setLicenseUrl :: License -> Maybe Text -> License

getReferenceRef :: Reference -> Text

setReferenceRef :: Reference -> Text -> Reference

getServerVariables :: Server -> Maybe (HashMap Text ServerVariable)

setServerVariables :: Server -> Maybe (HashMap Text ServerVariable) -> Server

getExampleX :: Example -> Maybe (HashMap Text Value)

setExampleX :: Example -> Maybe (HashMap Text Value) -> Example

getHeaderExample :: Header -> Maybe Value

setHeaderExample :: Header -> Maybe Value -> Header

getSchemaMaxProperties :: Schema -> Maybe Int

setSchemaMaxProperties :: Schema -> Maybe Int -> Schema

getInfoTermsOfService :: Info -> Maybe Text

setInfoTermsOfService :: Info -> Maybe Text -> Info

eitherAdditionalReference :: Additionals -> Either Additionals Reference

data ImplicitOAuthFlow

ImplicitOAuthFlow authorizationUrl scopes refreshUrl x

Constructors

ImplicitOAuthFlow

Fields

• _implicitOAuthFlow_authorizationUrl :: Text
• _implicitOAuthFlow_scopes :: HashMap Text Text
• _implicitOAuthFlow_refreshUrl :: Maybe Text
• _implicitOAuthFlow_x :: Maybe (HashMap Text Value)

Instances

Eq ImplicitOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: ImplicitOAuthFlow -> ImplicitOAuthFlow -> Bool

(/=) :: ImplicitOAuthFlow -> ImplicitOAuthFlow -> Bool

Show ImplicitOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> ImplicitOAuthFlow -> ShowS

show :: ImplicitOAuthFlow -> String

showList :: [ImplicitOAuthFlow] -> ShowS

ToJSON ImplicitOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: ImplicitOAuthFlow -> Value

toEncoding :: ImplicitOAuthFlow -> Encoding

toJSONList :: [ImplicitOAuthFlow] -> Value

toEncodingList :: [ImplicitOAuthFlow] -> Encoding

FromJSON ImplicitOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser ImplicitOAuthFlow

parseJSONList :: Value -> Parser [ImplicitOAuthFlow]

getSchemaMultipleOf :: Schema -> Maybe Double

setSchemaMultipleOf :: Schema -> Maybe Double -> Schema

data ClientCredentialsFlow

ClientCredentialsFlow tokenUrl refreshUrl scopes x

Constructors

ClientCredentialsFlow

Fields

• _clientCredentialsFlow_tokenUrl :: Text
• _clientCredentialsFlow_refreshUrl :: Maybe Text
• _clientCredentialsFlow_scopes :: Maybe (HashMap Text Text)
• _clientCredentialsFlow_x :: Maybe (HashMap Text Value)

Instances

Eq ClientCredentialsFlow

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: ClientCredentialsFlow -> ClientCredentialsFlow -> Bool

(/=) :: ClientCredentialsFlow -> ClientCredentialsFlow -> Bool

Show ClientCredentialsFlow

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> ClientCredentialsFlow -> ShowS

show :: ClientCredentialsFlow -> String

showList :: [ClientCredentialsFlow] -> ShowS

ToJSON ClientCredentialsFlow

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: ClientCredentialsFlow -> Value

toEncoding :: ClientCredentialsFlow -> Encoding

toJSONList :: [ClientCredentialsFlow] -> Value

toEncodingList :: [ClientCredentialsFlow] -> Encoding

FromJSON ClientCredentialsFlow

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser ClientCredentialsFlow

parseJSONList :: Value -> Parser [ClientCredentialsFlow]

getPathItemTrace :: PathItem -> Maybe Operation

setPathItemTrace :: PathItem -> Maybe Operation -> PathItem

eitherSecuritySchemaAPIKeySS :: SecuritySchema -> Either SecuritySchema APIKeySecurityScheme

getExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text

setExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text -> ExternalDocumentation

getPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text

setPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text -> PasswordOAuthFlow

data Reference

Reference $ref x

Constructors

Reference

Fields

• _reference_ref :: Text
• _reference_x :: Maybe (HashMap Text Value)

Instances

Eq Reference

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Reference -> Reference -> Bool

(/=) :: Reference -> Reference -> Bool

Show Reference

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

ToJSON Reference

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Reference -> Value

toEncoding :: Reference -> Encoding

toJSONList :: [Reference] -> Value

toEncodingList :: [Reference] -> Encoding

FromJSON Reference

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Reference

parseJSONList :: Value -> Parser [Reference]

getClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text

setClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text -> ClientCredentialsFlow

getSchemaMaximum :: Schema -> Maybe Double

setSchemaMaximum :: Schema -> Maybe Double -> Schema

getEncodingX :: Encoding -> Maybe (HashMap Text Value)

setEncodingX :: Encoding -> Maybe (HashMap Text Value) -> Encoding

getOperationSummary :: Operation -> Maybe Text

setOperationSummary :: Operation -> Maybe Text -> Operation

getAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text

setAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow

getXMLWrapped :: XML -> Maybe Bool

setXMLWrapped :: XML -> Maybe Bool -> XML

getHTTPSecuritySchemeX :: HTTPSecurityScheme -> Maybe (HashMap Text Value)

setHTTPSecuritySchemeX :: HTTPSecurityScheme -> Maybe (HashMap Text Value) -> HTTPSecurityScheme

data OAuth2SecurityScheme

OAuth2SecurityScheme flows type description x

Constructors

OAuth2SecurityScheme

Fields

• _oAuth2SecurityScheme_flows :: OAuthFlows
• _oAuth2SecurityScheme_type :: Text
• _oAuth2SecurityScheme_description :: Maybe Text
• _oAuth2SecurityScheme_x :: Maybe (HashMap Text Value)

Instances

Eq OAuth2SecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: OAuth2SecurityScheme -> OAuth2SecurityScheme -> Bool

(/=) :: OAuth2SecurityScheme -> OAuth2SecurityScheme -> Bool

Show OAuth2SecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> OAuth2SecurityScheme -> ShowS

show :: OAuth2SecurityScheme -> String

showList :: [OAuth2SecurityScheme] -> ShowS

ToJSON OAuth2SecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: OAuth2SecurityScheme -> Value

toEncoding :: OAuth2SecurityScheme -> Encoding

toJSONList :: [OAuth2SecurityScheme] -> Value

toEncodingList :: [OAuth2SecurityScheme] -> Encoding

FromJSON OAuth2SecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser OAuth2SecurityScheme

parseJSONList :: Value -> Parser [OAuth2SecurityScheme]

data APIKeySecurityScheme

APIKeySecurityScheme name type in description x

Constructors

APIKeySecurityScheme

Fields

• _aPIKeySecurityScheme_name :: Text
• _aPIKeySecurityScheme_type :: Text
• _aPIKeySecurityScheme_in :: Text
• _aPIKeySecurityScheme_description :: Maybe Text
• _aPIKeySecurityScheme_x :: Maybe (HashMap Text Value)

Instances

Eq APIKeySecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: APIKeySecurityScheme -> APIKeySecurityScheme -> Bool

(/=) :: APIKeySecurityScheme -> APIKeySecurityScheme -> Bool

Show APIKeySecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> APIKeySecurityScheme -> ShowS

show :: APIKeySecurityScheme -> String

showList :: [APIKeySecurityScheme] -> ShowS

ToJSON APIKeySecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: APIKeySecurityScheme -> Value

toEncoding :: APIKeySecurityScheme -> Encoding

toJSONList :: [APIKeySecurityScheme] -> Value

toEncodingList :: [APIKeySecurityScheme] -> Encoding

FromJSON APIKeySecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser APIKeySecurityScheme

parseJSONList :: Value -> Parser [APIKeySecurityScheme]

getOperationParameters :: Operation -> Maybe [ReferenceOr Parameter]

setOperationParameters :: Operation -> Maybe [ReferenceOr Parameter] -> Operation

getResponseHeaders :: Response -> Maybe (HashMap Text (ReferenceOr Header))

setResponseHeaders :: Response -> Maybe (HashMap Text (ReferenceOr Header)) -> Response

data Example

Example summary description value externalValue x

Constructors

Example

Fields

• _example_summary :: Maybe Text
• _example_description :: Maybe Text
• _example_value :: Maybe Value
• _example_externalValue :: Maybe Text
• _example_x :: Maybe (HashMap Text Value)

Instances

Eq Example

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Example -> Example -> Bool

(/=) :: Example -> Example -> Bool

Show Example

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Example -> ShowS

show :: Example -> String

showList :: [Example] -> ShowS

ToJSON Example

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Example -> Value

toEncoding :: Example -> Encoding

toJSONList :: [Example] -> Value

toEncodingList :: [Example] -> Encoding

FromJSON Example

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Example

parseJSONList :: Value -> Parser [Example]

data OpenIdConnectSecurityScheme

OpenIdConnectSecurityScheme type openIdConnectUrl description x

Constructors

OpenIdConnectSecurityScheme

Fields

• _openIdConnectSecurityScheme_type :: Text
• _openIdConnectSecurityScheme_openIdConnectUrl :: Text
• _openIdConnectSecurityScheme_description :: Maybe Text
• _openIdConnectSecurityScheme_x :: Maybe (HashMap Text Value)

Instances

Eq OpenIdConnectSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: OpenIdConnectSecurityScheme -> OpenIdConnectSecurityScheme -> Bool

(/=) :: OpenIdConnectSecurityScheme -> OpenIdConnectSecurityScheme -> Bool

Show OpenIdConnectSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> OpenIdConnectSecurityScheme -> ShowS

show :: OpenIdConnectSecurityScheme -> String

showList :: [OpenIdConnectSecurityScheme] -> ShowS

ToJSON OpenIdConnectSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: OpenIdConnectSecurityScheme -> Value

toEncoding :: OpenIdConnectSecurityScheme -> Encoding

toJSONList :: [OpenIdConnectSecurityScheme] -> Value

toEncodingList :: [OpenIdConnectSecurityScheme] -> Encoding

FromJSON OpenIdConnectSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser OpenIdConnectSecurityScheme

parseJSONList :: Value -> Parser [OpenIdConnectSecurityScheme]

getSchemaNullable :: Schema -> Maybe Bool

setSchemaNullable :: Schema -> Maybe Bool -> Schema

getSchemaExample :: Schema -> Maybe Value

setSchemaExample :: Schema -> Maybe Value -> Schema

getSchemaReadOnly :: Schema -> Maybe Bool

setSchemaReadOnly :: Schema -> Maybe Bool -> Schema

getSchemaNot :: Schema -> Maybe (ReferenceOr Schema)

setSchemaNot :: Schema -> Maybe (ReferenceOr Schema) -> Schema

getInfoLicense :: Info -> Maybe License

setInfoLicense :: Info -> Maybe License -> Info

getComponentsParameters :: Components -> Maybe (HashMap Text (ReferenceOr Parameter))

setComponentsParameters :: Components -> Maybe (HashMap Text (ReferenceOr Parameter)) -> Components

eitherBoolIntInt :: BoolInt -> Either BoolInt Int

getSchemaOneOf :: Schema -> Maybe [ReferenceOr Schema]

setSchemaOneOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema

getHeaderAllowReserved :: Header -> Maybe Bool

setHeaderAllowReserved :: Header -> Maybe Bool -> Header

getOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow

setOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow -> OAuthFlows

data License

License name url x

Constructors

License

Fields

• _license_name :: Text
• _license_url :: Maybe Text
• _license_x :: Maybe (HashMap Text Value)

Instances

Eq License

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: License -> License -> Bool

(/=) :: License -> License -> Bool

Show License

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

ToJSON License

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: License -> Value

toEncoding :: License -> Encoding

toJSONList :: [License] -> Value

toEncodingList :: [License] -> Encoding

FromJSON License

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser License

parseJSONList :: Value -> Parser [License]

getSchemaDescription :: Schema -> Maybe Text

setSchemaDescription :: Schema -> Maybe Text -> Schema

getLinkDescription :: Link -> Maybe Text

setLinkDescription :: Link -> Maybe Text -> Link

getComponentsExamples :: Components -> Maybe (HashMap Text (ReferenceOr Example))

setComponentsExamples :: Components -> Maybe (HashMap Text (ReferenceOr Example)) -> Components

eitherItemsSingleItem :: Items -> Either Items Schema

getParameterExample :: Parameter -> Maybe Value

setParameterExample :: Parameter -> Maybe Value -> Parameter

getContactName :: Contact -> Maybe Text

setContactName :: Contact -> Maybe Text -> Contact

eitherItemsSingleItemReference :: Items -> Either Items Reference

getAuthorizationCodeOAuthFlowX :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Value)

setAuthorizationCodeOAuthFlowX :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Value) -> AuthorizationCodeOAuthFlow

getComponentsResponses :: Components -> Maybe (HashMap Text (ReferenceOr Response))

setComponentsResponses :: Components -> Maybe (HashMap Text (ReferenceOr Response)) -> Components

data OpenAPIObject

OpenAPIObject openapi info paths externalDocs servers security tags components x

Constructors

OpenAPIObject

Fields

• _openAPIObject_openapi :: Text
• _openAPIObject_info :: Info
• _openAPIObject_paths :: HashMap Text PathItem
• _openAPIObject_externalDocs :: Maybe ExternalDocumentation
• _openAPIObject_servers :: Maybe [Server]
• _openAPIObject_security :: Maybe [HashMap Text [Text]]
• _openAPIObject_tags :: Maybe [Tag]
• _openAPIObject_components :: Maybe Components
• _openAPIObject_x :: Maybe (HashMap Text Value)

Instances

Eq OpenAPIObject

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: OpenAPIObject -> OpenAPIObject -> Bool

(/=) :: OpenAPIObject -> OpenAPIObject -> Bool

Show OpenAPIObject

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> OpenAPIObject -> ShowS

show :: OpenAPIObject -> String

showList :: [OpenAPIObject] -> ShowS

ToJSON OpenAPIObject

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: OpenAPIObject -> Value

toEncoding :: OpenAPIObject -> Encoding

toJSONList :: [OpenAPIObject] -> Value

toEncodingList :: [OpenAPIObject] -> Encoding

FromJSON OpenAPIObject

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser OpenAPIObject

parseJSONList :: Value -> Parser [OpenAPIObject]

data HTTPSecurityScheme

HTTPSecurityScheme type scheme bearerFormat description x

Constructors

HTTPSecurityScheme

Fields

• _hTTPSecurityScheme_type :: Text
• _hTTPSecurityScheme_scheme :: Text
• _hTTPSecurityScheme_bearerFormat :: Maybe Text
• _hTTPSecurityScheme_description :: Maybe Text
• _hTTPSecurityScheme_x :: Maybe (HashMap Text Value)

Instances

Eq HTTPSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: HTTPSecurityScheme -> HTTPSecurityScheme -> Bool

(/=) :: HTTPSecurityScheme -> HTTPSecurityScheme -> Bool

Show HTTPSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> HTTPSecurityScheme -> ShowS

show :: HTTPSecurityScheme -> String

showList :: [HTTPSecurityScheme] -> ShowS

ToJSON HTTPSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: HTTPSecurityScheme -> Value

toEncoding :: HTTPSecurityScheme -> Encoding

toJSONList :: [HTTPSecurityScheme] -> Value

toEncodingList :: [HTTPSecurityScheme] -> Encoding

FromJSON HTTPSecurityScheme

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser HTTPSecurityScheme

parseJSONList :: Value -> Parser [HTTPSecurityScheme]

getContactEmail :: Contact -> Maybe Text

setContactEmail :: Contact -> Maybe Text -> Contact

getSchemaMinItems :: Schema -> Maybe Int

setSchemaMinItems :: Schema -> Maybe Int -> Schema

eitherSecuritySchemaOAuth2SS :: SecuritySchema -> Either SecuritySchema OAuth2SecurityScheme

getOperationCallbacks :: Operation -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))

setOperationCallbacks :: Operation -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem))) -> Operation

getParameterDeprecated :: Parameter -> Maybe Bool

setParameterDeprecated :: Parameter -> Maybe Bool -> Parameter

getServerX :: Server -> Maybe (HashMap Text Value)

setServerX :: Server -> Maybe (HashMap Text Value) -> Server

getSchemaEnum :: Schema -> Maybe [Value]

setSchemaEnum :: Schema -> Maybe [Value] -> Schema

getLicenseName :: License -> Text

setLicenseName :: License -> Text -> License

getOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components

setOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components -> OpenAPIObject

getAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text

setAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text -> APIKeySecurityScheme

getSchemaTitle :: Schema -> Maybe Text

setSchemaTitle :: Schema -> Maybe Text -> Schema

getResponseContent :: Response -> Maybe (HashMap Text MediaType)

setResponseContent :: Response -> Maybe (HashMap Text MediaType) -> Response

getSchemaX :: Schema -> Maybe (HashMap Text Value)

setSchemaX :: Schema -> Maybe (HashMap Text Value) -> Schema

getOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text

setOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text -> OAuth2SecurityScheme

getEncodingExplode :: Encoding -> Maybe Bool

setEncodingExplode :: Encoding -> Maybe Bool -> Encoding

data AuthorizationCodeOAuthFlow

AuthorizationCodeOAuthFlow tokenUrl authorizationUrl refreshUrl scopes x

Constructors

AuthorizationCodeOAuthFlow

Fields

• _authorizationCodeOAuthFlow_tokenUrl :: Text
• _authorizationCodeOAuthFlow_authorizationUrl :: Text
• _authorizationCodeOAuthFlow_refreshUrl :: Maybe Text
• _authorizationCodeOAuthFlow_scopes :: Maybe (HashMap Text Text)
• _authorizationCodeOAuthFlow_x :: Maybe (HashMap Text Value)

Instances

Eq AuthorizationCodeOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: AuthorizationCodeOAuthFlow -> AuthorizationCodeOAuthFlow -> Bool

(/=) :: AuthorizationCodeOAuthFlow -> AuthorizationCodeOAuthFlow -> Bool

Show AuthorizationCodeOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> AuthorizationCodeOAuthFlow -> ShowS

show :: AuthorizationCodeOAuthFlow -> String

showList :: [AuthorizationCodeOAuthFlow] -> ShowS

ToJSON AuthorizationCodeOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: AuthorizationCodeOAuthFlow -> Value

toEncoding :: AuthorizationCodeOAuthFlow -> Encoding

toJSONList :: [AuthorizationCodeOAuthFlow] -> Value

toEncodingList :: [AuthorizationCodeOAuthFlow] -> Encoding

FromJSON AuthorizationCodeOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser AuthorizationCodeOAuthFlow

parseJSONList :: Value -> Parser [AuthorizationCodeOAuthFlow]

getOperationExternalDocs :: Operation -> Maybe ExternalDocumentation

setOperationExternalDocs :: Operation -> Maybe ExternalDocumentation -> Operation

getAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text

setAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme

getTagName :: Tag -> Text

setTagName :: Tag -> Text -> Tag

getOpenAPIObjectInfo :: OpenAPIObject -> Info

setOpenAPIObjectInfo :: OpenAPIObject -> Info -> OpenAPIObject

getParameterX :: Parameter -> Maybe (HashMap Text Value)

setParameterX :: Parameter -> Maybe (HashMap Text Value) -> Parameter

getOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text

setOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme

getOAuth2SecuritySchemeX :: OAuth2SecurityScheme -> Maybe (HashMap Text Value)

setOAuth2SecuritySchemeX :: OAuth2SecurityScheme -> Maybe (HashMap Text Value) -> OAuth2SecurityScheme

getImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text

setImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text -> ImplicitOAuthFlow

getHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text

setHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme

getSchemaPattern :: Schema -> Maybe Text

setSchemaPattern :: Schema -> Maybe Text -> Schema

getInfoVersion :: Info -> Text

setInfoVersion :: Info -> Text -> Info

getSchemaDiscriminator :: Schema -> Maybe Discriminator

setSchemaDiscriminator :: Schema -> Maybe Discriminator -> Schema

getSchemaType :: Schema -> Maybe Text

setSchemaType :: Schema -> Maybe Text -> Schema

getRequestBodyX :: RequestBody -> Maybe (HashMap Text Value)

setRequestBodyX :: RequestBody -> Maybe (HashMap Text Value) -> RequestBody

getSchemaMaxLength :: Schema -> Maybe Int

setSchemaMaxLength :: Schema -> Maybe Int -> Schema

getParameterAllowEmptyValue :: Parameter -> Maybe Bool

setParameterAllowEmptyValue :: Parameter -> Maybe Bool -> Parameter

getEncodingContentType :: Encoding -> Maybe Text

setEncodingContentType :: Encoding -> Maybe Text -> Encoding

getPathItemDelete :: PathItem -> Maybe Operation

setPathItemDelete :: PathItem -> Maybe Operation -> PathItem

getPasswordOAuthFlowScopes :: PasswordOAuthFlow -> Maybe (HashMap Text Text)

setPasswordOAuthFlowScopes :: PasswordOAuthFlow -> Maybe (HashMap Text Text) -> PasswordOAuthFlow

getXMLX :: XML -> Maybe (HashMap Text Value)

setXMLX :: XML -> Maybe (HashMap Text Value) -> XML

getHeaderRequired :: Header -> Maybe Bool

setHeaderRequired :: Header -> Maybe Bool -> Header

getSchemaRequired :: Schema -> Maybe [Text]

setSchemaRequired :: Schema -> Maybe [Text] -> Schema

getOperationTags :: Operation -> Maybe [Text]

setOperationTags :: Operation -> Maybe [Text] -> Operation

getOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text

setOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text -> OpenIdConnectSecurityScheme

getRequestBodyContent :: RequestBody -> HashMap Text MediaType

setRequestBodyContent :: RequestBody -> HashMap Text MediaType -> RequestBody

getHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text

setHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme

getDiscriminatorMapping :: Discriminator -> Maybe (HashMap Text Text)

setDiscriminatorMapping :: Discriminator -> Maybe (HashMap Text Text) -> Discriminator

getResponseX :: Response -> Maybe (HashMap Text Value)

setResponseX :: Response -> Maybe (HashMap Text Value) -> Response

getHeaderSchema :: Header -> Maybe (ReferenceOr Schema)

setHeaderSchema :: Header -> Maybe (ReferenceOr Schema) -> Header

getHeaderDeprecated :: Header -> Maybe Bool

setHeaderDeprecated :: Header -> Maybe Bool -> Header

data RequestBody

RequestBody content description required x

Constructors

RequestBody

Fields

• _requestBody_content :: HashMap Text MediaType
• _requestBody_description :: Maybe Text
• _requestBody_required :: Maybe Bool
• _requestBody_x :: Maybe (HashMap Text Value)

Instances

Eq RequestBody

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: RequestBody -> RequestBody -> Bool

(/=) :: RequestBody -> RequestBody -> Bool

Show RequestBody

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

ToJSON RequestBody

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: RequestBody -> Value

toEncoding :: RequestBody -> Encoding

toJSONList :: [RequestBody] -> Value

toEncodingList :: [RequestBody] -> Encoding

FromJSON RequestBody

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser RequestBody

parseJSONList :: Value -> Parser [RequestBody]

getExternalDocumentationX :: ExternalDocumentation -> Maybe (HashMap Text Value)

setExternalDocumentationX :: ExternalDocumentation -> Maybe (HashMap Text Value) -> ExternalDocumentation

getOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation

setOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation -> OpenAPIObject

getSchemaProperties :: Schema -> Maybe (HashMap Text (ReferenceOr Schema))

setSchemaProperties :: Schema -> Maybe (HashMap Text (ReferenceOr Schema)) -> Schema

getImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text

setImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text -> ImplicitOAuthFlow

getTagDescription :: Tag -> Maybe Text

setTagDescription :: Tag -> Maybe Text -> Tag

eitherItemsTuple :: Items -> Either Items [ReferenceOr Schema]

data ExternalDocumentation

ExternalDocumentation url description x

Constructors

ExternalDocumentation

Fields

• _externalDocumentation_url :: Text
• _externalDocumentation_description :: Maybe Text
• _externalDocumentation_x :: Maybe (HashMap Text Value)

Instances

Eq ExternalDocumentation

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: ExternalDocumentation -> ExternalDocumentation -> Bool

(/=) :: ExternalDocumentation -> ExternalDocumentation -> Bool

Show ExternalDocumentation

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> ExternalDocumentation -> ShowS

show :: ExternalDocumentation -> String

showList :: [ExternalDocumentation] -> ShowS

ToJSON ExternalDocumentation

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: ExternalDocumentation -> Value

toEncoding :: ExternalDocumentation -> Encoding

toJSONList :: [ExternalDocumentation] -> Value

toEncodingList :: [ExternalDocumentation] -> Encoding

FromJSON ExternalDocumentation

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser ExternalDocumentation

parseJSONList :: Value -> Parser [ExternalDocumentation]

data Items

Constructors

Tuple [ReferenceOr Schema]

SingleItem Schema

SingleItemReference Reference

Instances

Eq Items

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Items -> Items -> Bool

(/=) :: Items -> Items -> Bool

Show Items

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Items -> ShowS

show :: Items -> String

showList :: [Items] -> ShowS

ToJSON Items

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Items -> Value

toEncoding :: Items -> Encoding

toJSONList :: [Items] -> Value

toEncodingList :: [Items] -> Encoding

FromJSON Items

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Items

parseJSONList :: Value -> Parser [Items]

data Parameter

Parameter name in description required deprecated allowEmptyValue style explode allowReserved schema content example examples x

Constructors

Parameter

Fields

• _parameter_name :: Text
• _parameter_in :: Text
• _parameter_description :: Maybe Text
• _parameter_required :: Maybe Bool
• _parameter_deprecated :: Maybe Bool
• _parameter_allowEmptyValue :: Maybe Bool
• _parameter_style :: Maybe Text
• _parameter_explode :: Maybe Bool
• _parameter_allowReserved :: Maybe Bool
• _parameter_schema :: Maybe (ReferenceOr Schema)
• _parameter_content :: Maybe (HashMap Text MediaType)
• _parameter_example :: Maybe Value
• _parameter_examples :: Maybe (HashMap Text (ReferenceOr Example))
• _parameter_x :: Maybe (HashMap Text Value)

Instances

Eq Parameter

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Parameter -> Parameter -> Bool

(/=) :: Parameter -> Parameter -> Bool

Show Parameter

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

ToJSON Parameter

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Parameter -> Value

toEncoding :: Parameter -> Encoding

toJSONList :: [Parameter] -> Value

toEncodingList :: [Parameter] -> Encoding

FromJSON Parameter

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Parameter

parseJSONList :: Value -> Parser [Parameter]

data Link

Link operationId operationRef parameters requestBody description server x

Constructors

Link

Fields

• _link_operationId :: Maybe Text
• _link_operationRef :: Maybe Text
• _link_parameters :: Maybe (HashMap Text Value)
• _link_requestBody :: Maybe Value
• _link_description :: Maybe Text
• _link_server :: Maybe Server
• _link_x :: Maybe (HashMap Text Value)

Instances

Eq Link

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Link -> Link -> Bool

(/=) :: Link -> Link -> Bool

Show Link

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

ToJSON Link

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Link -> Value

toEncoding :: Link -> Encoding

toJSONList :: [Link] -> Value

toEncodingList :: [Link] -> Encoding

FromJSON Link

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Link

parseJSONList :: Value -> Parser [Link]

getParameterAllowReserved :: Parameter -> Maybe Bool

setParameterAllowReserved :: Parameter -> Maybe Bool -> Parameter

getSchemaExclusiveMinimum :: Schema -> Maybe BoolInt

setSchemaExclusiveMinimum :: Schema -> Maybe BoolInt -> Schema

getAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text

setAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme

getOperationX :: Operation -> Maybe (HashMap Text Value)

setOperationX :: Operation -> Maybe (HashMap Text Value) -> Operation

data SecuritySchema

Constructors

APIKeySS APIKeySecurityScheme

HTTPSS HTTPSecurityScheme

OAuth2SS OAuth2SecurityScheme

OpenIdConnectSS OpenIdConnectSecurityScheme

TextSS Text

ReferenceSS Reference

Instances

Eq SecuritySchema

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: SecuritySchema -> SecuritySchema -> Bool

(/=) :: SecuritySchema -> SecuritySchema -> Bool

Show SecuritySchema

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> SecuritySchema -> ShowS

show :: SecuritySchema -> String

showList :: [SecuritySchema] -> ShowS

ToJSON SecuritySchema

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: SecuritySchema -> Value

toEncoding :: SecuritySchema -> Encoding

toJSONList :: [SecuritySchema] -> Value

toEncodingList :: [SecuritySchema] -> Encoding

FromJSON SecuritySchema

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser SecuritySchema

parseJSONList :: Value -> Parser [SecuritySchema]

data Contact

Contact name url email x

Constructors

Contact

Fields

• _contact_name :: Maybe Text
• _contact_url :: Maybe Text
• _contact_email :: Maybe Text
• _contact_x :: Maybe (HashMap Text Value)

Instances

Eq Contact

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Contact -> Contact -> Bool

(/=) :: Contact -> Contact -> Bool

Show Contact

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Contact -> ShowS

show :: Contact -> String

showList :: [Contact] -> ShowS

ToJSON Contact

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Contact -> Value

toEncoding :: Contact -> Encoding

toJSONList :: [Contact] -> Value

toEncodingList :: [Contact] -> Encoding

FromJSON Contact

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Contact

parseJSONList :: Value -> Parser [Contact]

data Additionals

Constructors

AdditionalSchema Schema

AdditionalReference Reference

AdditionalBool Bool

Instances

Eq Additionals

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Additionals -> Additionals -> Bool

(/=) :: Additionals -> Additionals -> Bool

Show Additionals

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Additionals -> ShowS

show :: Additionals -> String

showList :: [Additionals] -> ShowS

ToJSON Additionals

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Additionals -> Value

toEncoding :: Additionals -> Encoding

toJSONList :: [Additionals] -> Value

toEncodingList :: [Additionals] -> Encoding

FromJSON Additionals

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Additionals

parseJSONList :: Value -> Parser [Additionals]

getParameterRequired :: Parameter -> Maybe Bool

setParameterRequired :: Parameter -> Maybe Bool -> Parameter

getSchemaMinProperties :: Schema -> Maybe Int

setSchemaMinProperties :: Schema -> Maybe Int -> Schema

getLicenseX :: License -> Maybe (HashMap Text Value)

setLicenseX :: License -> Maybe (HashMap Text Value) -> License

getComponentsSecuritySchemes :: Components -> Maybe (HashMap Text SecuritySchema)

setComponentsSecuritySchemes :: Components -> Maybe (HashMap Text SecuritySchema) -> Components

getPathItemServers :: PathItem -> Maybe [Server]

setPathItemServers :: PathItem -> Maybe [Server] -> PathItem

getComponentsCallbacks :: Components -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))

setComponentsCallbacks :: Components -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem))) -> Components

getMediaTypeSchema :: MediaType -> Maybe (ReferenceOr Schema)

setMediaTypeSchema :: MediaType -> Maybe (ReferenceOr Schema) -> MediaType

getOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text

setOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text -> OAuth2SecurityScheme

getOpenAPIObjectSecurity :: OpenAPIObject -> Maybe [HashMap Text [Text]]

setOpenAPIObjectSecurity :: OpenAPIObject -> Maybe [HashMap Text [Text]] -> OpenAPIObject

getEncodingStyle :: Encoding -> Maybe Text

setEncodingStyle :: Encoding -> Maybe Text -> Encoding

getResponseDescription :: Response -> Text

setResponseDescription :: Response -> Text -> Response

getServerVariableDescription :: ServerVariable -> Maybe Text

setServerVariableDescription :: ServerVariable -> Maybe Text -> ServerVariable

eitherReferenceOrRef :: ReferenceOr a -> Either (ReferenceOr a) Reference

getPathItemPost :: PathItem -> Maybe Operation

setPathItemPost :: PathItem -> Maybe Operation -> PathItem

data XML

XML name namespace prefix attribute wrapped x

Constructors

XML

Fields

• _xML_name :: Maybe Text
• _xML_namespace :: Maybe Text
• _xML_prefix :: Maybe Text
• _xML_attribute :: Maybe Bool
• _xML_wrapped :: Maybe Bool
• _xML_x :: Maybe (HashMap Text Value)

Instances

Eq XML

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: XML -> XML -> Bool

(/=) :: XML -> XML -> Bool

Show XML

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> XML -> ShowS

show :: XML -> String

showList :: [XML] -> ShowS

ToJSON XML

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: XML -> Value

toEncoding :: XML -> Encoding

toJSONList :: [XML] -> Value

toEncodingList :: [XML] -> Encoding

FromJSON XML

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser XML

parseJSONList :: Value -> Parser [XML]

getXMLAttribute :: XML -> Maybe Bool

setXMLAttribute :: XML -> Maybe Bool -> XML

getLinkOperationId :: Link -> Maybe Text

setLinkOperationId :: Link -> Maybe Text -> Link

getOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow

setOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow -> OAuthFlows

getOperationOperationId :: Operation -> Maybe Text

setOperationOperationId :: Operation -> Maybe Text -> Operation

getSchemaAnyOf :: Schema -> Maybe [ReferenceOr Schema]

setSchemaAnyOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema

getXMLNamespace :: XML -> Maybe Text

setXMLNamespace :: XML -> Maybe Text -> XML

getOperationServers :: Operation -> Maybe [Server]

setOperationServers :: Operation -> Maybe [Server] -> Operation

getOpenAPIObjectX :: OpenAPIObject -> Maybe (HashMap Text Value)

setOpenAPIObjectX :: OpenAPIObject -> Maybe (HashMap Text Value) -> OpenAPIObject

getPathItemHead :: PathItem -> Maybe Operation

setPathItemHead :: PathItem -> Maybe Operation -> PathItem

getImplicitOAuthFlowX :: ImplicitOAuthFlow -> Maybe (HashMap Text Value)

setImplicitOAuthFlowX :: ImplicitOAuthFlow -> Maybe (HashMap Text Value) -> ImplicitOAuthFlow

getInfoX :: Info -> Maybe (HashMap Text Value)

setInfoX :: Info -> Maybe (HashMap Text Value) -> Info

getLinkOperationRef :: Link -> Maybe Text

setLinkOperationRef :: Link -> Maybe Text -> Link

getPathItemGet :: PathItem -> Maybe Operation

setPathItemGet :: PathItem -> Maybe Operation -> PathItem

getExampleExternalValue :: Example -> Maybe Text

setExampleExternalValue :: Example -> Maybe Text -> Example

getSchemaMaxItems :: Schema -> Maybe Int

setSchemaMaxItems :: Schema -> Maybe Int -> Schema

data Header

Header description required deprecated allowEmptyValue style explode allowReserved schema content example examples x

Constructors

Header

Fields

• _header_description :: Maybe Text
• _header_required :: Maybe Bool
• _header_deprecated :: Maybe Bool
• _header_allowEmptyValue :: Maybe Bool
• _header_style :: Maybe Text
• _header_explode :: Maybe Bool
• _header_allowReserved :: Maybe Bool
• _header_schema :: Maybe (ReferenceOr Schema)
• _header_content :: Maybe (HashMap Text MediaType)
• _header_example :: Maybe Value
• _header_examples :: Maybe (HashMap Text (ReferenceOr Example))
• _header_x :: Maybe (HashMap Text Value)

Instances

Eq Header

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Header -> Header -> Bool

(/=) :: Header -> Header -> Bool

Show Header

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

ToJSON Header

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Header -> Value

toEncoding :: Header -> Encoding

toJSONList :: [Header] -> Value

toEncodingList :: [Header] -> Encoding

FromJSON Header

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Header

parseJSONList :: Value -> Parser [Header]

getSchemaMinimum :: Schema -> Maybe Double

setSchemaMinimum :: Schema -> Maybe Double -> Schema

getSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation

setSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation -> Schema

data Info

Info title version description termsOfService contact license x

Constructors

Info

Fields

• _info_title :: Text
• _info_version :: Text
• _info_description :: Maybe Text
• _info_termsOfService :: Maybe Text
• _info_contact :: Maybe Contact
• _info_license :: Maybe License
• _info_x :: Maybe (HashMap Text Value)

Instances

Eq Info

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Info -> Info -> Bool

(/=) :: Info -> Info -> Bool

Show Info

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Info -> ShowS

show :: Info -> String

showList :: [Info] -> ShowS

ToJSON Info

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Info -> Value

toEncoding :: Info -> Encoding

toJSONList :: [Info] -> Value

toEncodingList :: [Info] -> Encoding

FromJSON Info

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Info

parseJSONList :: Value -> Parser [Info]

getSchemaItems :: Schema -> Maybe Items

setSchemaItems :: Schema -> Maybe Items -> Schema

getClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text

setClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text -> ClientCredentialsFlow

getPathItemX :: PathItem -> Maybe (HashMap Text Value)

setPathItemX :: PathItem -> Maybe (HashMap Text Value) -> PathItem

getPasswordOAuthFlowX :: PasswordOAuthFlow -> Maybe (HashMap Text Value)

setPasswordOAuthFlowX :: PasswordOAuthFlow -> Maybe (HashMap Text Value) -> PasswordOAuthFlow

data OAuthFlows

OAuthFlows implicit password clientCredentials authorizationCode x

Constructors

OAuthFlows

Fields

• _oAuthFlows_implicit :: Maybe ImplicitOAuthFlow
• _oAuthFlows_password :: Maybe PasswordOAuthFlow
• _oAuthFlows_clientCredentials :: Maybe ClientCredentialsFlow
• _oAuthFlows_authorizationCode :: Maybe AuthorizationCodeOAuthFlow
• _oAuthFlows_x :: Maybe (HashMap Text Value)

Instances

Eq OAuthFlows

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: OAuthFlows -> OAuthFlows -> Bool

(/=) :: OAuthFlows -> OAuthFlows -> Bool

Show OAuthFlows

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> OAuthFlows -> ShowS

show :: OAuthFlows -> String

showList :: [OAuthFlows] -> ShowS

ToJSON OAuthFlows

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: OAuthFlows -> Value

toEncoding :: OAuthFlows -> Encoding

toJSONList :: [OAuthFlows] -> Value

toEncodingList :: [OAuthFlows] -> Encoding

FromJSON OAuthFlows

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser OAuthFlows

parseJSONList :: Value -> Parser [OAuthFlows]

getParameterStyle :: Parameter -> Maybe Text

setParameterStyle :: Parameter -> Maybe Text -> Parameter

getHeaderAllowEmptyValue :: Header -> Maybe Bool

setHeaderAllowEmptyValue :: Header -> Maybe Bool -> Header

getAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text

setAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text -> AuthorizationCodeOAuthFlow

getReferenceX :: Reference -> Maybe (HashMap Text Value)

setReferenceX :: Reference -> Maybe (HashMap Text Value) -> Reference

getServerVariableEnum :: ServerVariable -> Maybe [Text]

setServerVariableEnum :: ServerVariable -> Maybe [Text] -> ServerVariable

data Operation

Operation responses tags summary description externalDocs operationId parameters requestBody callbacks deprecated security servers x

Constructors

Operation

Fields

• _operation_responses :: HashMap Text (ReferenceOr Response)
• _operation_tags :: Maybe [Text]
• _operation_summary :: Maybe Text
• _operation_description :: Maybe Text
• _operation_externalDocs :: Maybe ExternalDocumentation
• _operation_operationId :: Maybe Text
• _operation_parameters :: Maybe [ReferenceOr Parameter]
• _operation_requestBody :: Maybe (ReferenceOr RequestBody)
• _operation_callbacks :: Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))
• _operation_deprecated :: Maybe Bool
• _operation_security :: Maybe [HashMap Text [Text]]
• _operation_servers :: Maybe [Server]
• _operation_x :: Maybe (HashMap Text Value)

Instances

Eq Operation

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Operation -> Operation -> Bool

(/=) :: Operation -> Operation -> Bool

Show Operation

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

ToJSON Operation

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

FromJSON Operation

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Operation

parseJSONList :: Value -> Parser [Operation]

getSchemaUniqueItems :: Schema -> Maybe Bool

setSchemaUniqueItems :: Schema -> Maybe Bool -> Schema

getResponseLinks :: Response -> Maybe (HashMap Text (ReferenceOr Link))

setResponseLinks :: Response -> Maybe (HashMap Text (ReferenceOr Link)) -> Response

getTagX :: Tag -> Maybe (HashMap Text Value)

setTagX :: Tag -> Maybe (HashMap Text Value) -> Tag

data ReferenceOr a

Constructors

Ref Reference

RealDeal a

Instances

Eq a => Eq (ReferenceOr a)

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: ReferenceOr a -> ReferenceOr a -> Bool

(/=) :: ReferenceOr a -> ReferenceOr a -> Bool

Show a => Show (ReferenceOr a)

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> ReferenceOr a -> ShowS

show :: ReferenceOr a -> String

showList :: [ReferenceOr a] -> ShowS

ToJSON a => ToJSON (ReferenceOr a)

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: ReferenceOr a -> Value

toEncoding :: ReferenceOr a -> Encoding

toJSONList :: [ReferenceOr a] -> Value

toEncodingList :: [ReferenceOr a] -> Encoding

FromJSON a => FromJSON (ReferenceOr a)

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser (ReferenceOr a)

parseJSONList :: Value -> Parser [ReferenceOr a]

getComponentsX :: Components -> Maybe (HashMap Text Value)

setComponentsX :: Components -> Maybe (HashMap Text Value) -> Components

data PasswordOAuthFlow

PasswordOAuthFlow tokenUrl refreshUrl scopes x

Constructors

PasswordOAuthFlow

Fields

• _passwordOAuthFlow_tokenUrl :: Text
• _passwordOAuthFlow_refreshUrl :: Maybe Text
• _passwordOAuthFlow_scopes :: Maybe (HashMap Text Text)
• _passwordOAuthFlow_x :: Maybe (HashMap Text Value)

Instances

Eq PasswordOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: PasswordOAuthFlow -> PasswordOAuthFlow -> Bool

(/=) :: PasswordOAuthFlow -> PasswordOAuthFlow -> Bool

Show PasswordOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> PasswordOAuthFlow -> ShowS

show :: PasswordOAuthFlow -> String

showList :: [PasswordOAuthFlow] -> ShowS

ToJSON PasswordOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: PasswordOAuthFlow -> Value

toEncoding :: PasswordOAuthFlow -> Encoding

toJSONList :: [PasswordOAuthFlow] -> Value

toEncodingList :: [PasswordOAuthFlow] -> Encoding

FromJSON PasswordOAuthFlow

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser PasswordOAuthFlow

parseJSONList :: Value -> Parser [PasswordOAuthFlow]

getDiscriminatorX :: Discriminator -> Maybe (HashMap Text Value)

setDiscriminatorX :: Discriminator -> Maybe (HashMap Text Value) -> Discriminator

getMediaTypeX :: MediaType -> Maybe (HashMap Text Value)

setMediaTypeX :: MediaType -> Maybe (HashMap Text Value) -> MediaType

getRequestBodyRequired :: RequestBody -> Maybe Bool

setRequestBodyRequired :: RequestBody -> Maybe Bool -> RequestBody

getOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow

setOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow -> OAuthFlows

eitherSecuritySchemaOpenIdConnectSS :: SecuritySchema -> Either SecuritySchema OpenIdConnectSecurityScheme

getInfoContact :: Info -> Maybe Contact

setInfoContact :: Info -> Maybe Contact -> Info

eitherAdditionalSchema :: Additionals -> Either Additionals Schema

getSchemaAdditionalProperties :: Schema -> Maybe Additionals

setSchemaAdditionalProperties :: Schema -> Maybe Additionals -> Schema

getHeaderContent :: Header -> Maybe (HashMap Text MediaType)

setHeaderContent :: Header -> Maybe (HashMap Text MediaType) -> Header

getRequestBodyDescription :: RequestBody -> Maybe Text

setRequestBodyDescription :: RequestBody -> Maybe Text -> RequestBody

getClientCredentialsFlowScopes :: ClientCredentialsFlow -> Maybe (HashMap Text Text)

setClientCredentialsFlowScopes :: ClientCredentialsFlow -> Maybe (HashMap Text Text) -> ClientCredentialsFlow

getAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text

setAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow

getHeaderStyle :: Header -> Maybe Text

setHeaderStyle :: Header -> Maybe Text -> Header

getContactUrl :: Contact -> Maybe Text

setContactUrl :: Contact -> Maybe Text -> Contact

data Encoding

Encoding contentType headers style explode allowReserved x

Constructors

Encoding

Fields

• _encoding_contentType :: Maybe Text
• _encoding_headers :: Maybe (HashMap Text Header)
• _encoding_style :: Maybe Text
• _encoding_explode :: Maybe Bool
• _encoding_allowReserved :: Maybe Bool
• _encoding_x :: Maybe (HashMap Text Value)

Instances

Eq Encoding

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Encoding -> Encoding -> Bool

(/=) :: Encoding -> Encoding -> Bool

Show Encoding

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

ToJSON Encoding

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Encoding -> Value

toEncoding :: Encoding -> Encoding0

toJSONList :: [Encoding] -> Value

toEncodingList :: [Encoding] -> Encoding0

FromJSON Encoding

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Encoding

parseJSONList :: Value -> Parser [Encoding]

data PathItem

PathItem summary description servers parameters get put post delete options head patch trace $ref x

Constructors

PathItem

Fields

• _pathItem_summary :: Maybe Text
• _pathItem_description :: Maybe Text
• _pathItem_servers :: Maybe [Server]
• _pathItem_parameters :: Maybe [ReferenceOr Parameter]
• _pathItem_get :: Maybe Operation
• _pathItem_put :: Maybe Operation
• _pathItem_post :: Maybe Operation
• _pathItem_delete :: Maybe Operation
• _pathItem_options :: Maybe Operation
• _pathItem_head :: Maybe Operation
• _pathItem_patch :: Maybe Operation
• _pathItem_trace :: Maybe Operation
• _pathItem_ref :: Maybe Text
• _pathItem_x :: Maybe (HashMap Text Value)

Instances

Eq PathItem

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: PathItem -> PathItem -> Bool

(/=) :: PathItem -> PathItem -> Bool

Show PathItem

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> PathItem -> ShowS

show :: PathItem -> String

showList :: [PathItem] -> ShowS

ToJSON PathItem

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: PathItem -> Value

toEncoding :: PathItem -> Encoding

toJSONList :: [PathItem] -> Value

toEncodingList :: [PathItem] -> Encoding

FromJSON PathItem

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser PathItem

parseJSONList :: Value -> Parser [PathItem]

getHeaderDescription :: Header -> Maybe Text

setHeaderDescription :: Header -> Maybe Text -> Header

getExternalDocumentationUrl :: ExternalDocumentation -> Text

setExternalDocumentationUrl :: ExternalDocumentation -> Text -> ExternalDocumentation

getAuthorizationCodeOAuthFlowScopes :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Text)

setAuthorizationCodeOAuthFlowScopes :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Text) -> AuthorizationCodeOAuthFlow

getOperationDescription :: Operation -> Maybe Text

setOperationDescription :: Operation -> Maybe Text -> Operation

getServerVariableDefault :: ServerVariable -> Text

setServerVariableDefault :: ServerVariable -> Text -> ServerVariable

getComponentsLinks :: Components -> Maybe (HashMap Text (ReferenceOr Link))

setComponentsLinks :: Components -> Maybe (HashMap Text (ReferenceOr Link)) -> Components

getOpenAPIObjectPaths :: OpenAPIObject -> HashMap Text PathItem

setOpenAPIObjectPaths :: OpenAPIObject -> HashMap Text PathItem -> OpenAPIObject

getHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text

setHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme

getInfoTitle :: Info -> Text

setInfoTitle :: Info -> Text -> Info

getImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text

setImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text -> ImplicitOAuthFlow

getPathItemSummary :: PathItem -> Maybe Text

setPathItemSummary :: PathItem -> Maybe Text -> PathItem

getOpenIdConnectSecuritySchemeX :: OpenIdConnectSecurityScheme -> Maybe (HashMap Text Value)

setOpenIdConnectSecuritySchemeX :: OpenIdConnectSecurityScheme -> Maybe (HashMap Text Value) -> OpenIdConnectSecurityScheme

getPathItemParameters :: PathItem -> Maybe [ReferenceOr Parameter]

setPathItemParameters :: PathItem -> Maybe [ReferenceOr Parameter] -> PathItem

getSchemaDefault :: Schema -> Maybe Value

setSchemaDefault :: Schema -> Maybe Value -> Schema

getMediaTypeExample :: MediaType -> Maybe Value

setMediaTypeExample :: MediaType -> Maybe Value -> MediaType

getInfoDescription :: Info -> Maybe Text

setInfoDescription :: Info -> Maybe Text -> Info

getPathItemDescription :: PathItem -> Maybe Text

setPathItemDescription :: PathItem -> Maybe Text -> PathItem

getOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow

setOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow -> OAuthFlows

getParameterIn :: Parameter -> Text

setParameterIn :: Parameter -> Text -> Parameter

getXMLName :: XML -> Maybe Text

setXMLName :: XML -> Maybe Text -> XML

getMediaTypeEncoding :: MediaType -> Maybe (HashMap Text Encoding)

setMediaTypeEncoding :: MediaType -> Maybe (HashMap Text Encoding) -> MediaType

data BoolInt

Constructors

ABool Bool

AnInt Int

Instances

Eq BoolInt

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: BoolInt -> BoolInt -> Bool

(/=) :: BoolInt -> BoolInt -> Bool

Show BoolInt

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> BoolInt -> ShowS

show :: BoolInt -> String

showList :: [BoolInt] -> ShowS

ToJSON BoolInt

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: BoolInt -> Value

toEncoding :: BoolInt -> Encoding

toJSONList :: [BoolInt] -> Value

toEncodingList :: [BoolInt] -> Encoding

FromJSON BoolInt

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser BoolInt

parseJSONList :: Value -> Parser [BoolInt]

getSchemaFormat :: Schema -> Maybe Text

setSchemaFormat :: Schema -> Maybe Text -> Schema

getHeaderX :: Header -> Maybe (HashMap Text Value)

setHeaderX :: Header -> Maybe (HashMap Text Value) -> Header

getExampleSummary :: Example -> Maybe Text

setExampleSummary :: Example -> Maybe Text -> Example

data Server

Server url description variables x

Constructors

Server

Fields

• _server_url :: Text
• _server_description :: Maybe Text
• _server_variables :: Maybe (HashMap Text ServerVariable)
• _server_x :: Maybe (HashMap Text Value)

Instances

Eq Server

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Server -> Server -> Bool

(/=) :: Server -> Server -> Bool

Show Server

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Server -> ShowS

show :: Server -> String

showList :: [Server] -> ShowS

ToJSON Server

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Server -> Value

toEncoding :: Server -> Encoding

toJSONList :: [Server] -> Value

toEncodingList :: [Server] -> Encoding

FromJSON Server

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Server

parseJSONList :: Value -> Parser [Server]

getParameterName :: Parameter -> Text

setParameterName :: Parameter -> Text -> Parameter

getParameterContent :: Parameter -> Maybe (HashMap Text MediaType)

setParameterContent :: Parameter -> Maybe (HashMap Text MediaType) -> Parameter

data Tag

Tag name description externalDocs x

Constructors

Tag

Fields

• _tag_name :: Text
• _tag_description :: Maybe Text
• _tag_externalDocs :: Maybe ExternalDocumentation
• _tag_x :: Maybe (HashMap Text Value)

Instances

Eq Tag

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Show Tag

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

ToJSON Tag

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

FromJSON Tag

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

getPathItemRef :: PathItem -> Maybe Text

setPathItemRef :: PathItem -> Maybe Text -> PathItem

getSchemaMinLength :: Schema -> Maybe Int

setSchemaMinLength :: Schema -> Maybe Int -> Schema

getParameterSchema :: Parameter -> Maybe (ReferenceOr Schema)

setParameterSchema :: Parameter -> Maybe (ReferenceOr Schema) -> Parameter

getOperationResponses :: Operation -> HashMap Text (ReferenceOr Response)

setOperationResponses :: Operation -> HashMap Text (ReferenceOr Response) -> Operation

getSchemaAllOf :: Schema -> Maybe [ReferenceOr Schema]

setSchemaAllOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema

getLinkX :: Link -> Maybe (HashMap Text Value)

setLinkX :: Link -> Maybe (HashMap Text Value) -> Link

data Discriminator

Discriminator propertyName mapping x

Constructors

Discriminator

Fields

• _discriminator_propertyName :: Text
• _discriminator_mapping :: Maybe (HashMap Text Text)
• _discriminator_x :: Maybe (HashMap Text Value)

Instances

Eq Discriminator

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Discriminator -> Discriminator -> Bool

(/=) :: Discriminator -> Discriminator -> Bool

Show Discriminator

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Discriminator -> ShowS

show :: Discriminator -> String

showList :: [Discriminator] -> ShowS

ToJSON Discriminator

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Discriminator -> Value

toEncoding :: Discriminator -> Encoding

toJSONList :: [Discriminator] -> Value

toEncodingList :: [Discriminator] -> Encoding

FromJSON Discriminator

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Discriminator

parseJSONList :: Value -> Parser [Discriminator]

getOperationSecurity :: Operation -> Maybe [HashMap Text [Text]]

setOperationSecurity :: Operation -> Maybe [HashMap Text [Text]] -> Operation

getHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text

setHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme

data MediaType

MediaType schema example examples encoding x

Constructors

MediaType

Fields

• _mediaType_schema :: Maybe (ReferenceOr Schema)
• _mediaType_example :: Maybe Value
• _mediaType_examples :: Maybe (HashMap Text (ReferenceOr Example))
• _mediaType_encoding :: Maybe (HashMap Text Encoding)
• _mediaType_x :: Maybe (HashMap Text Value)

Instances

Eq MediaType

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: MediaType -> MediaType -> Bool

(/=) :: MediaType -> MediaType -> Bool

Show MediaType

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> MediaType -> ShowS

show :: MediaType -> String

showList :: [MediaType] -> ShowS

ToJSON MediaType

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: MediaType -> Value

toEncoding :: MediaType -> Encoding

toJSONList :: [MediaType] -> Value

toEncodingList :: [MediaType] -> Encoding

FromJSON MediaType

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser MediaType

parseJSONList :: Value -> Parser [MediaType]

getExampleValue :: Example -> Maybe Value

setExampleValue :: Example -> Maybe Value -> Example

getXMLPrefix :: XML -> Maybe Text

setXMLPrefix :: XML -> Maybe Text -> XML

getDiscriminatorPropertyName :: Discriminator -> Text

setDiscriminatorPropertyName :: Discriminator -> Text -> Discriminator

getSchemaXml :: Schema -> Maybe XML

setSchemaXml :: Schema -> Maybe XML -> Schema

getHeaderExplode :: Header -> Maybe Bool

setHeaderExplode :: Header -> Maybe Bool -> Header

getServerVariableX :: ServerVariable -> Maybe (HashMap Text Value)

setServerVariableX :: ServerVariable -> Maybe (HashMap Text Value) -> ServerVariable

getPathItemPatch :: PathItem -> Maybe Operation

setPathItemPatch :: PathItem -> Maybe Operation -> PathItem

getAPIKeySecuritySchemeX :: APIKeySecurityScheme -> Maybe (HashMap Text Value)

setAPIKeySecuritySchemeX :: APIKeySecurityScheme -> Maybe (HashMap Text Value) -> APIKeySecurityScheme

getLinkRequestBody :: Link -> Maybe Value

setLinkRequestBody :: Link -> Maybe Value -> Link

getExampleDescription :: Example -> Maybe Text

setExampleDescription :: Example -> Maybe Text -> Example

getComponentsSchemas :: Components -> Maybe (HashMap Text (ReferenceOr Schema))

setComponentsSchemas :: Components -> Maybe (HashMap Text (ReferenceOr Schema)) -> Components

data Response

Response description headers content links x

Constructors

Response

Fields

• _response_description :: Text
• _response_headers :: Maybe (HashMap Text (ReferenceOr Header))
• _response_content :: Maybe (HashMap Text MediaType)
• _response_links :: Maybe (HashMap Text (ReferenceOr Link))
• _response_x :: Maybe (HashMap Text Value)

Instances

Eq Response

Defined in Data.OpenAPI.V3_0_0

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Show Response

Defined in Data.OpenAPI.V3_0_0

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

ToJSON Response

Defined in Data.OpenAPI.V3_0_0

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

FromJSON Response

Defined in Data.OpenAPI.V3_0_0

Methods

parseJSON :: Value -> Parser Response

parseJSONList :: Value -> Parser [Response]

getClientCredentialsFlowX :: ClientCredentialsFlow -> Maybe (HashMap Text Value)

setClientCredentialsFlowX :: ClientCredentialsFlow -> Maybe (HashMap Text Value) -> ClientCredentialsFlow

getOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text

setOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme

getParameterExamples :: Parameter -> Maybe (HashMap Text (ReferenceOr Example))

setParameterExamples :: Parameter -> Maybe (HashMap Text (ReferenceOr Example)) -> Parameter

eitherReferenceOrRealDeal :: ReferenceOr a -> Either (ReferenceOr a) a

getTagExternalDocs :: Tag -> Maybe ExternalDocumentation

setTagExternalDocs :: Tag -> Maybe ExternalDocumentation -> Tag

getEncodingAllowReserved :: Encoding -> Maybe Bool

setEncodingAllowReserved :: Encoding -> Maybe Bool -> Encoding

getContactX :: Contact -> Maybe (HashMap Text Value)

setContactX :: Contact -> Maybe (HashMap Text Value) -> Contact

getLinkServer :: Link -> Maybe Server

setLinkServer :: Link -> Maybe Server -> Link

getOpenAPIObjectServers :: OpenAPIObject -> Maybe [Server]

setOpenAPIObjectServers :: OpenAPIObject -> Maybe [Server] -> OpenAPIObject