Safe Haskell	None
Language	Haskell2010

Data.OpenAPI.V3_0_0

Synopsis

getLinkRequestBody :: Link -> Maybe Value
setLinkRequestBody :: Link -> Maybe Value -> Link
data ImplicitOAuthFlow = ImplicitOAuthFlow {
- _ImplicitOAuthFlow_authorizationUrl :: Text
- _ImplicitOAuthFlow_scopes :: HashMap Text Text
- _ImplicitOAuthFlow_refreshUrl :: Maybe Text
- _ImplicitOAuthFlow_x :: Maybe (HashMap Text Value)
}
getImplicitOAuthFlowX :: ImplicitOAuthFlow -> Maybe (HashMap Text Value)
setImplicitOAuthFlowX :: ImplicitOAuthFlow -> Maybe (HashMap Text Value) -> ImplicitOAuthFlow
getContactX :: Contact -> Maybe (HashMap Text Value)
setContactX :: Contact -> Maybe (HashMap Text Value) -> Contact
getPasswordOAuthFlowX :: PasswordOAuthFlow -> Maybe (HashMap Text Value)
setPasswordOAuthFlowX :: PasswordOAuthFlow -> Maybe (HashMap Text Value) -> PasswordOAuthFlow
getOperationOperationId :: Operation -> Maybe Text
setOperationOperationId :: Operation -> Maybe Text -> Operation
getPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text
setPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text -> PasswordOAuthFlow
getServerVariableX :: ServerVariable -> Maybe (HashMap Text Value)
setServerVariableX :: ServerVariable -> Maybe (HashMap Text Value) -> ServerVariable
getInfoTermsOfService :: Info -> Maybe Text
setInfoTermsOfService :: Info -> Maybe Text -> Info
getHeaderExplode :: Header -> Maybe Bool
setHeaderExplode :: Header -> Maybe Bool -> Header
getSchemaRequired :: Schema -> Maybe [Text]
setSchemaRequired :: Schema -> Maybe [Text] -> Schema
getPathItemTrace :: PathItem -> Maybe Operation
setPathItemTrace :: PathItem -> Maybe Operation -> PathItem
getContactEmail :: Contact -> Maybe Text
setContactEmail :: Contact -> Maybe Text -> Contact
getParameterAllowEmptyValue :: Parameter -> Maybe Bool
setParameterAllowEmptyValue :: Parameter -> Maybe Bool -> Parameter
getLicenseX :: License -> Maybe (HashMap Text Value)
setLicenseX :: License -> Maybe (HashMap Text Value) -> License
getOperationExternalDocs :: Operation -> Maybe ExternalDocumentation
setOperationExternalDocs :: Operation -> Maybe ExternalDocumentation -> Operation
getComponentsSecuritySchemes :: Components -> Maybe (HashMap Text SecuritySchema)
setComponentsSecuritySchemes :: Components -> Maybe (HashMap Text SecuritySchema) -> Components
getPathItemPut :: PathItem -> Maybe Operation
setPathItemPut :: PathItem -> Maybe Operation -> PathItem
getXMLWrapped :: XML -> Maybe Bool
setXMLWrapped :: XML -> Maybe Bool -> XML
getOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components
setOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components -> OpenAPIObject
data AuthorizationCodeOAuthFlow = AuthorizationCodeOAuthFlow {
- _AuthorizationCodeOAuthFlow_tokenUrl :: Text
- _AuthorizationCodeOAuthFlow_authorizationUrl :: Text
- _AuthorizationCodeOAuthFlow_refreshUrl :: Maybe Text
- _AuthorizationCodeOAuthFlow_scopes :: Maybe (HashMap Text Text)
- _AuthorizationCodeOAuthFlow_x :: Maybe (HashMap Text Value)
}
getContactName :: Contact -> Maybe Text
setContactName :: Contact -> Maybe Text -> Contact
getSchemaMultipleOf :: Schema -> Maybe Double
setSchemaMultipleOf :: Schema -> Maybe Double -> Schema
getOAuth2SecuritySchemeX :: OAuth2SecurityScheme -> Maybe (HashMap Text Value)
setOAuth2SecuritySchemeX :: OAuth2SecurityScheme -> Maybe (HashMap Text Value) -> OAuth2SecurityScheme
getParameterDescription :: Parameter -> Maybe Text
setParameterDescription :: Parameter -> Maybe Text -> Parameter
getInfoContact :: Info -> Maybe Contact
setInfoContact :: Info -> Maybe Contact -> Info
data Components = Components {
- _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)
}
getComponentsCallbacks :: Components -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))
setComponentsCallbacks :: Components -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem))) -> Components
getHeaderAllowReserved :: Header -> Maybe Bool
setHeaderAllowReserved :: Header -> Maybe Bool -> Header
getHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text
setHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme
getTagExternalDocs :: Tag -> Maybe ExternalDocumentation
setTagExternalDocs :: Tag -> Maybe ExternalDocumentation -> Tag
getOperationDescription :: Operation -> Maybe Text
setOperationDescription :: Operation -> Maybe Text -> Operation
getOpenAPIObjectX :: OpenAPIObject -> Maybe (HashMap Text Value)
setOpenAPIObjectX :: OpenAPIObject -> Maybe (HashMap Text Value) -> OpenAPIObject
getPathItemRef :: PathItem -> Maybe Text
setPathItemRef :: PathItem -> Maybe Text -> PathItem
getSchemaX :: Schema -> Maybe (HashMap Text Value)
setSchemaX :: Schema -> Maybe (HashMap Text Value) -> Schema
getAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text
setAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme
getPathItemPatch :: PathItem -> Maybe Operation
setPathItemPatch :: PathItem -> Maybe Operation -> PathItem
data Info = Info {
- _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)
}
data Additionals
- = AdditionalSchema Schema
- | AdditionalReference Reference
- | AdditionalBool Bool
getOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow
setOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow -> OAuthFlows
getSchemaProperties :: Schema -> Maybe (HashMap Text (ReferenceOr Schema))
setSchemaProperties :: Schema -> Maybe (HashMap Text (ReferenceOr Schema)) -> Schema
data BoolInt
- = ABool Bool
- | AnInt Int
getInfoLicense :: Info -> Maybe License
setInfoLicense :: Info -> Maybe License -> Info
getComponentsExamples :: Components -> Maybe (HashMap Text (ReferenceOr Example))
setComponentsExamples :: Components -> Maybe (HashMap Text (ReferenceOr Example)) -> Components
getClientCredentialsFlowScopes :: ClientCredentialsFlow -> Maybe (HashMap Text Text)
setClientCredentialsFlowScopes :: ClientCredentialsFlow -> Maybe (HashMap Text Text) -> ClientCredentialsFlow
getTagDescription :: Tag -> Maybe Text
setTagDescription :: Tag -> Maybe Text -> Tag
getParameterRequired :: Parameter -> Maybe Bool
setParameterRequired :: Parameter -> Maybe Bool -> Parameter
eitherSecuritySchemaOAuth2SS :: SecuritySchema -> Either SecuritySchema OAuth2SecurityScheme
getResponseHeaders :: Response -> Maybe (HashMap Text (ReferenceOr Header))
setResponseHeaders :: Response -> Maybe (HashMap Text (ReferenceOr Header)) -> Response
getServerVariables :: Server -> Maybe (HashMap Text ServerVariable)
setServerVariables :: Server -> Maybe (HashMap Text ServerVariable) -> Server
data PathItem = PathItem {
- _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)
}
getClientCredentialsFlowX :: ClientCredentialsFlow -> Maybe (HashMap Text Value)
setClientCredentialsFlowX :: ClientCredentialsFlow -> Maybe (HashMap Text Value) -> ClientCredentialsFlow
data ClientCredentialsFlow = ClientCredentialsFlow {
- _ClientCredentialsFlow_tokenUrl :: Text
- _ClientCredentialsFlow_refreshUrl :: Maybe Text
- _ClientCredentialsFlow_scopes :: Maybe (HashMap Text Text)
- _ClientCredentialsFlow_x :: Maybe (HashMap Text Value)
}
getAPIKeySecuritySchemeX :: APIKeySecurityScheme -> Maybe (HashMap Text Value)
setAPIKeySecuritySchemeX :: APIKeySecurityScheme -> Maybe (HashMap Text Value) -> APIKeySecurityScheme
getParameterExplode :: Parameter -> Maybe Bool
setParameterExplode :: Parameter -> Maybe Bool -> Parameter
getLinkOperationId :: Link -> Maybe Text
setLinkOperationId :: Link -> Maybe Text -> Link
getXMLPrefix :: XML -> Maybe Text
setXMLPrefix :: XML -> Maybe Text -> XML
getSchemaExclusiveMinimum :: Schema -> Maybe BoolInt
setSchemaExclusiveMinimum :: Schema -> Maybe BoolInt -> Schema
getDiscriminatorMapping :: Discriminator -> Maybe (HashMap Text Text)
setDiscriminatorMapping :: Discriminator -> Maybe (HashMap Text Text) -> Discriminator
getSchemaExample :: Schema -> Maybe Value
setSchemaExample :: Schema -> Maybe Value -> Schema
getRequestBodyDescription :: RequestBody -> Maybe Text
setRequestBodyDescription :: RequestBody -> Maybe Text -> RequestBody
getOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text
setOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme
getAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text
setAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme
getServerUrl :: Server -> Text
setServerUrl :: Server -> Text -> Server
eitherAdditionalReference :: Additionals -> Either Additionals Reference
eitherItemsSingleItem :: Items -> Either Items Schema
data Reference = Reference {
- _Reference_ref :: Text
- _Reference_x :: Maybe (HashMap Text Value)
}
getParameterContent :: Parameter -> Maybe (HashMap Text MediaType)
setParameterContent :: Parameter -> Maybe (HashMap Text MediaType) -> Parameter
getRequestBodyX :: RequestBody -> Maybe (HashMap Text Value)
setRequestBodyX :: RequestBody -> Maybe (HashMap Text Value) -> RequestBody
getOperationSummary :: Operation -> Maybe Text
setOperationSummary :: Operation -> Maybe Text -> Operation
data OAuthFlows = OAuthFlows {
- _OAuthFlows_implicit :: Maybe ImplicitOAuthFlow
- _OAuthFlows_password :: Maybe PasswordOAuthFlow
- _OAuthFlows_clientCredentials :: Maybe ClientCredentialsFlow
- _OAuthFlows_authorizationCode :: Maybe AuthorizationCodeOAuthFlow
- _OAuthFlows_x :: Maybe (HashMap Text Value)
}
getMediaTypeEncoding :: MediaType -> Maybe (HashMap Text Encoding)
setMediaTypeEncoding :: MediaType -> Maybe (HashMap Text Encoding) -> MediaType
getExampleValue :: Example -> Maybe Value
setExampleValue :: Example -> Maybe Value -> Example
data Parameter = Parameter {
- _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)
}
getDiscriminatorX :: Discriminator -> Maybe (HashMap Text Value)
setDiscriminatorX :: Discriminator -> Maybe (HashMap Text Value) -> Discriminator
getEncodingAllowReserved :: Encoding -> Maybe Bool
setEncodingAllowReserved :: Encoding -> Maybe Bool -> Encoding
getOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows
setOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows -> OAuth2SecurityScheme
getParameterSchema :: Parameter -> Maybe (ReferenceOr Schema)
setParameterSchema :: Parameter -> Maybe (ReferenceOr Schema) -> Parameter
getImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text
setImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text -> ImplicitOAuthFlow
getXMLX :: XML -> Maybe (HashMap Text Value)
setXMLX :: XML -> Maybe (HashMap Text Value) -> XML
getInfoDescription :: Info -> Maybe Text
setInfoDescription :: Info -> Maybe Text -> Info
data Operation = Operation {
- _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)
}
getLinkOperationRef :: Link -> Maybe Text
setLinkOperationRef :: Link -> Maybe Text -> Link
getComponentsSchemas :: Components -> Maybe (HashMap Text (ReferenceOr Schema))
setComponentsSchemas :: Components -> Maybe (HashMap Text (ReferenceOr Schema)) -> Components
getLinkParameters :: Link -> Maybe (HashMap Text Value)
setLinkParameters :: Link -> Maybe (HashMap Text Value) -> Link
getReferenceX :: Reference -> Maybe (HashMap Text Value)
setReferenceX :: Reference -> Maybe (HashMap Text Value) -> Reference
data Items
- = Tuple [ReferenceOr Schema]
- | SingleItem Schema
- | SingleItemReference Reference
getResponseX :: Response -> Maybe (HashMap Text Value)
setResponseX :: Response -> Maybe (HashMap Text Value) -> Response
getOperationTags :: Operation -> Maybe [Text]
setOperationTags :: Operation -> Maybe [Text] -> Operation
getServerX :: Server -> Maybe (HashMap Text Value)
setServerX :: Server -> Maybe (HashMap Text Value) -> Server
getInfoVersion :: Info -> Text
setInfoVersion :: Info -> Text -> Info
getServerVariableDefault :: ServerVariable -> Text
setServerVariableDefault :: ServerVariable -> Text -> ServerVariable
getAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text
setAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text -> AuthorizationCodeOAuthFlow
getOpenAPIObjectTags :: OpenAPIObject -> Maybe [Tag]
setOpenAPIObjectTags :: OpenAPIObject -> Maybe [Tag] -> OpenAPIObject
getPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text
setPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text -> PasswordOAuthFlow
getOperationRequestBody :: Operation -> Maybe (ReferenceOr RequestBody)
setOperationRequestBody :: Operation -> Maybe (ReferenceOr RequestBody) -> Operation
getParameterStyle :: Parameter -> Maybe Text
setParameterStyle :: Parameter -> Maybe Text -> Parameter
getSchemaAnyOf :: Schema -> Maybe [ReferenceOr Schema]
setSchemaAnyOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema
getPathItemX :: PathItem -> Maybe (HashMap Text Value)
setPathItemX :: PathItem -> Maybe (HashMap Text Value) -> PathItem
getParameterExamples :: Parameter -> Maybe (HashMap Text (ReferenceOr Example))
setParameterExamples :: Parameter -> Maybe (HashMap Text (ReferenceOr Example)) -> Parameter
getExampleDescription :: Example -> Maybe Text
setExampleDescription :: Example -> Maybe Text -> Example
getServerVariableEnum :: ServerVariable -> Maybe [Text]
setServerVariableEnum :: ServerVariable -> Maybe [Text] -> ServerVariable
eitherSecuritySchemaOpenIdConnectSS :: SecuritySchema -> Either SecuritySchema OpenIdConnectSecurityScheme
getComponentsResponses :: Components -> Maybe (HashMap Text (ReferenceOr Response))
setComponentsResponses :: Components -> Maybe (HashMap Text (ReferenceOr Response)) -> Components
getHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text
setHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme
getSchemaNot :: Schema -> Maybe (ReferenceOr Schema)
setSchemaNot :: Schema -> Maybe (ReferenceOr Schema) -> Schema
getHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text
setHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme
getAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text
setAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme
getComponentsLinks :: Components -> Maybe (HashMap Text (ReferenceOr Link))
setComponentsLinks :: Components -> Maybe (HashMap Text (ReferenceOr Link)) -> Components
getOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow
setOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow -> OAuthFlows
getSchemaDescription :: Schema -> Maybe Text
setSchemaDescription :: Schema -> Maybe Text -> Schema
getParameterIn :: Parameter -> Text
setParameterIn :: Parameter -> Text -> Parameter
getPathItemParameters :: PathItem -> Maybe [ReferenceOr Parameter]
setPathItemParameters :: PathItem -> Maybe [ReferenceOr Parameter] -> PathItem
getPathItemHead :: PathItem -> Maybe Operation
setPathItemHead :: PathItem -> Maybe Operation -> PathItem
getImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text
setImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text -> ImplicitOAuthFlow
getEncodingContentType :: Encoding -> Maybe Text
setEncodingContentType :: Encoding -> Maybe Text -> Encoding
data Contact = Contact {
- _Contact_name :: Maybe Text
- _Contact_url :: Maybe Text
- _Contact_email :: Maybe Text
- _Contact_x :: Maybe (HashMap Text Value)
}
getHeaderDeprecated :: Header -> Maybe Bool
setHeaderDeprecated :: Header -> Maybe Bool -> Header
getComponentsRequestBodies :: Components -> Maybe (HashMap Text (ReferenceOr RequestBody))
setComponentsRequestBodies :: Components -> Maybe (HashMap Text (ReferenceOr RequestBody)) -> Components
getSchemaFormat :: Schema -> Maybe Text
setSchemaFormat :: Schema -> Maybe Text -> Schema
getAuthorizationCodeOAuthFlowX :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Value)
setAuthorizationCodeOAuthFlowX :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Value) -> AuthorizationCodeOAuthFlow
getOpenAPIObjectServers :: OpenAPIObject -> Maybe [Server]
setOpenAPIObjectServers :: OpenAPIObject -> Maybe [Server] -> OpenAPIObject
getSchemaType :: Schema -> Maybe Text
setSchemaType :: Schema -> Maybe Text -> Schema
getResponseDescription :: Response -> Text
setResponseDescription :: Response -> Text -> Response
getSchemaPattern :: Schema -> Maybe Text
setSchemaPattern :: Schema -> Maybe Text -> Schema
data HTTPSecurityScheme = HTTPSecurityScheme {
- _HTTPSecurityScheme_type :: Text
- _HTTPSecurityScheme_scheme :: Text
- _HTTPSecurityScheme_bearerFormat :: Maybe Text
- _HTTPSecurityScheme_description :: Maybe Text
- _HTTPSecurityScheme_x :: Maybe (HashMap Text Value)
}
getExampleExternalValue :: Example -> Maybe Text
setExampleExternalValue :: Example -> Maybe Text -> Example
getHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text
setHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme
data Discriminator = Discriminator {
- _Discriminator_propertyName :: Text
- _Discriminator_mapping :: Maybe (HashMap Text Text)
- _Discriminator_x :: Maybe (HashMap Text Value)
}
getSchemaXml :: Schema -> Maybe XML
setSchemaXml :: Schema -> Maybe XML -> Schema
getOperationServers :: Operation -> Maybe [Server]
setOperationServers :: Operation -> Maybe [Server] -> Operation
getContactUrl :: Contact -> Maybe Text
setContactUrl :: Contact -> Maybe Text -> Contact
getSchemaExclusiveMaximum :: Schema -> Maybe BoolInt
setSchemaExclusiveMaximum :: Schema -> Maybe BoolInt -> Schema
data Link = Link {
- _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)
}
getExampleX :: Example -> Maybe (HashMap Text Value)
setExampleX :: Example -> Maybe (HashMap Text Value) -> Example
eitherSecuritySchemaAPIKeySS :: SecuritySchema -> Either SecuritySchema APIKeySecurityScheme
getOperationCallbacks :: Operation -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem)))
setOperationCallbacks :: Operation -> Maybe (HashMap Text (ReferenceOr (HashMap Text PathItem))) -> Operation
getTagName :: Tag -> Text
setTagName :: Tag -> Text -> Tag
getAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text
setAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow
getOpenAPIObjectSecurity :: OpenAPIObject -> Maybe [HashMap Text [Text]]
setOpenAPIObjectSecurity :: OpenAPIObject -> Maybe [HashMap Text [Text]] -> OpenAPIObject
getPathItemPost :: PathItem -> Maybe Operation
setPathItemPost :: PathItem -> Maybe Operation -> PathItem
getOperationParameters :: Operation -> Maybe [ReferenceOr Parameter]
setOperationParameters :: Operation -> Maybe [ReferenceOr Parameter] -> Operation
getAuthorizationCodeOAuthFlowScopes :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Text)
setAuthorizationCodeOAuthFlowScopes :: AuthorizationCodeOAuthFlow -> Maybe (HashMap Text Text) -> AuthorizationCodeOAuthFlow
getOperationSecurity :: Operation -> Maybe [HashMap Text [Text]]
setOperationSecurity :: Operation -> Maybe [HashMap Text [Text]] -> Operation
getComponentsX :: Components -> Maybe (HashMap Text Value)
setComponentsX :: Components -> Maybe (HashMap Text Value) -> Components
getEncodingStyle :: Encoding -> Maybe Text
setEncodingStyle :: Encoding -> Maybe Text -> Encoding
getComponentsHeaders :: Components -> Maybe (HashMap Text (ReferenceOr Header))
setComponentsHeaders :: Components -> Maybe (HashMap Text (ReferenceOr Header)) -> Components
getExternalDocumentationUrl :: ExternalDocumentation -> Text
setExternalDocumentationUrl :: ExternalDocumentation -> Text -> ExternalDocumentation
getClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text
setClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text -> ClientCredentialsFlow
getInfoTitle :: Info -> Text
setInfoTitle :: Info -> Text -> Info
getSchemaTitle :: Schema -> Maybe Text
setSchemaTitle :: Schema -> Maybe Text -> Schema
getXMLName :: XML -> Maybe Text
setXMLName :: XML -> Maybe Text -> XML
getSchemaDiscriminator :: Schema -> Maybe Discriminator
setSchemaDiscriminator :: Schema -> Maybe Discriminator -> Schema
getSchemaMaxItems :: Schema -> Maybe Int
setSchemaMaxItems :: Schema -> Maybe Int -> Schema
getOAuthFlowsX :: OAuthFlows -> Maybe (HashMap Text Value)
setOAuthFlowsX :: OAuthFlows -> Maybe (HashMap Text Value) -> OAuthFlows
data ExternalDocumentation = ExternalDocumentation {
- _ExternalDocumentation_url :: Text
- _ExternalDocumentation_description :: Maybe Text
- _ExternalDocumentation_x :: Maybe (HashMap Text Value)
}
getSchemaMinLength :: Schema -> Maybe Int
setSchemaMinLength :: Schema -> Maybe Int -> Schema
getHeaderSchema :: Header -> Maybe (ReferenceOr Schema)
setHeaderSchema :: Header -> Maybe (ReferenceOr Schema) -> Header
data SecuritySchema
- = APIKeySS APIKeySecurityScheme
- | HTTPSS HTTPSecurityScheme
- | OAuth2SS OAuth2SecurityScheme
- | OpenIdConnectSS OpenIdConnectSecurityScheme
- | TextSS Text
- | ReferenceSS Reference
getParameterAllowReserved :: Parameter -> Maybe Bool
setParameterAllowReserved :: Parameter -> Maybe Bool -> Parameter
getSchemaNullable :: Schema -> Maybe Bool
setSchemaNullable :: Schema -> Maybe Bool -> Schema
getParameterName :: Parameter -> Text
setParameterName :: Parameter -> Text -> Parameter
getServerVariableDescription :: ServerVariable -> Maybe Text
setServerVariableDescription :: ServerVariable -> Maybe Text -> ServerVariable
getAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text
setAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow
getInfoX :: Info -> Maybe (HashMap Text Value)
setInfoX :: Info -> Maybe (HashMap Text Value) -> Info
getLicenseName :: License -> Text
setLicenseName :: License -> Text -> License
getExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text
setExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text -> ExternalDocumentation
data License = License {
- _License_name :: Text
- _License_url :: Maybe Text
- _License_x :: Maybe (HashMap Text Value)
}
data ReferenceOr a
- = Ref Reference
- | RealDeal a
getParameterDeprecated :: Parameter -> Maybe Bool
setParameterDeprecated :: Parameter -> Maybe Bool -> Parameter
getOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation
setOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation -> OpenAPIObject
data Schema = Schema {
- _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)
}
data RequestBody = RequestBody {
- _RequestBody_content :: HashMap Text MediaType
- _RequestBody_description :: Maybe Text
- _RequestBody_required :: Maybe Bool
- _RequestBody_x :: Maybe (HashMap Text Value)
}
getPathItemServers :: PathItem -> Maybe [Server]
setPathItemServers :: PathItem -> Maybe [Server] -> PathItem
getMediaTypeExample :: MediaType -> Maybe Value
setMediaTypeExample :: MediaType -> Maybe Value -> MediaType
getHeaderExample :: Header -> Maybe Value
setHeaderExample :: Header -> Maybe Value -> Header
getSchemaWriteOnly :: Schema -> Maybe Bool
setSchemaWriteOnly :: Schema -> Maybe Bool -> Schema
getSchemaOneOf :: Schema -> Maybe [ReferenceOr Schema]
setSchemaOneOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema
data Response = Response {
- _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)
}
eitherReferenceOrRealDeal :: ReferenceOr a -> Either (ReferenceOr a) a
getOpenAPIObjectInfo :: OpenAPIObject -> Info
setOpenAPIObjectInfo :: OpenAPIObject -> Info -> OpenAPIObject
getResponseContent :: Response -> Maybe (HashMap Text MediaType)
setResponseContent :: Response -> Maybe (HashMap Text MediaType) -> Response
getLinkDescription :: Link -> Maybe Text
setLinkDescription :: Link -> Maybe Text -> Link
getSchemaMinimum :: Schema -> Maybe Double
setSchemaMinimum :: Schema -> Maybe Double -> Schema
getSchemaMaxLength :: Schema -> Maybe Int
setSchemaMaxLength :: Schema -> Maybe Int -> Schema
getExampleSummary :: Example -> Maybe Text
setExampleSummary :: Example -> Maybe Text -> Example
getParameterX :: Parameter -> Maybe (HashMap Text Value)
setParameterX :: Parameter -> Maybe (HashMap Text Value) -> Parameter
getSchemaMaximum :: Schema -> Maybe Double
setSchemaMaximum :: Schema -> Maybe Double -> Schema
getOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow
setOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow -> OAuthFlows
getRequestBodyContent :: RequestBody -> HashMap Text MediaType
setRequestBodyContent :: RequestBody -> HashMap Text MediaType -> RequestBody
data XML = XML {
- _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)
}
getLinkServer :: Link -> Maybe Server
setLinkServer :: Link -> Maybe Server -> Link
getTagX :: Tag -> Maybe (HashMap Text Value)
setTagX :: Tag -> Maybe (HashMap Text Value) -> Tag
data PasswordOAuthFlow = PasswordOAuthFlow {
- _PasswordOAuthFlow_tokenUrl :: Text
- _PasswordOAuthFlow_refreshUrl :: Maybe Text
- _PasswordOAuthFlow_scopes :: Maybe (HashMap Text Text)
- _PasswordOAuthFlow_x :: Maybe (HashMap Text Value)
}
getSchemaDeprecated :: Schema -> Maybe Bool
setSchemaDeprecated :: Schema -> Maybe Bool -> Schema
getHeaderContent :: Header -> Maybe (HashMap Text MediaType)
setHeaderContent :: Header -> Maybe (HashMap Text MediaType) -> Header
getPathItemGet :: PathItem -> Maybe Operation
setPathItemGet :: PathItem -> Maybe Operation -> PathItem
getSchemaItems :: Schema -> Maybe Items
setSchemaItems :: Schema -> Maybe Items -> Schema
getDiscriminatorPropertyName :: Discriminator -> Text
setDiscriminatorPropertyName :: Discriminator -> Text -> Discriminator
getParameterExample :: Parameter -> Maybe Value
setParameterExample :: Parameter -> Maybe Value -> Parameter
eitherReferenceOrRef :: ReferenceOr a -> Either (ReferenceOr a) Reference
getSchemaUniqueItems :: Schema -> Maybe Bool
setSchemaUniqueItems :: Schema -> Maybe Bool -> Schema
getOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow
setOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow -> OAuthFlows
eitherItemsSingleItemReference :: Items -> Either Items Reference
getImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text
setImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text -> ImplicitOAuthFlow
getOperationResponses :: Operation -> HashMap Text (ReferenceOr Response)
setOperationResponses :: Operation -> HashMap Text (ReferenceOr Response) -> Operation
getResponseLinks :: Response -> Maybe (HashMap Text (ReferenceOr Link))
setResponseLinks :: Response -> Maybe (HashMap Text (ReferenceOr Link)) -> Response
getLicenseUrl :: License -> Maybe Text
setLicenseUrl :: License -> Maybe Text -> License
data Encoding = Encoding {
- _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)
}
getHeaderExamples :: Header -> Maybe (HashMap Text (ReferenceOr Example))
setHeaderExamples :: Header -> Maybe (HashMap Text (ReferenceOr Example)) -> Header
getMediaTypeSchema :: MediaType -> Maybe (ReferenceOr Schema)
setMediaTypeSchema :: MediaType -> Maybe (ReferenceOr Schema) -> MediaType
getClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text
setClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text -> ClientCredentialsFlow
getOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text
setOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text -> OAuth2SecurityScheme
data APIKeySecurityScheme = APIKeySecurityScheme {
- _APIKeySecurityScheme_name :: Text
- _APIKeySecurityScheme_type :: Text
- _APIKeySecurityScheme_in :: Text
- _APIKeySecurityScheme_description :: Maybe Text
- _APIKeySecurityScheme_x :: Maybe (HashMap Text Value)
}
getAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text
setAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text -> APIKeySecurityScheme
getMediaTypeX :: MediaType -> Maybe (HashMap Text Value)
setMediaTypeX :: MediaType -> Maybe (HashMap Text Value) -> MediaType
getSchemaMaxProperties :: Schema -> Maybe Int
setSchemaMaxProperties :: Schema -> Maybe Int -> Schema
getOperationX :: Operation -> Maybe (HashMap Text Value)
setOperationX :: Operation -> Maybe (HashMap Text Value) -> Operation
getPathItemDescription :: PathItem -> Maybe Text
setPathItemDescription :: PathItem -> Maybe Text -> PathItem
getServerDescription :: Server -> Maybe Text
setServerDescription :: Server -> Maybe Text -> Server
getOpenIdConnectSecuritySchemeX :: OpenIdConnectSecurityScheme -> Maybe (HashMap Text Value)
setOpenIdConnectSecuritySchemeX :: OpenIdConnectSecurityScheme -> Maybe (HashMap Text Value) -> OpenIdConnectSecurityScheme
getOperationDeprecated :: Operation -> Maybe Bool
setOperationDeprecated :: Operation -> Maybe Bool -> Operation
data Tag = Tag {
- _Tag_name :: Text
- _Tag_description :: Maybe Text
- _Tag_externalDocs :: Maybe ExternalDocumentation
- _Tag_x :: Maybe (HashMap Text Value)
}
getHeaderRequired :: Header -> Maybe Bool
setHeaderRequired :: Header -> Maybe Bool -> Header
eitherAdditionalSchema :: Additionals -> Either Additionals Schema
getExternalDocumentationX :: ExternalDocumentation -> Maybe (HashMap Text Value)
setExternalDocumentationX :: ExternalDocumentation -> Maybe (HashMap Text Value) -> ExternalDocumentation
getXMLNamespace :: XML -> Maybe Text
setXMLNamespace :: XML -> Maybe Text -> XML
getXMLAttribute :: XML -> Maybe Bool
setXMLAttribute :: XML -> Maybe Bool -> XML
getSchemaMinItems :: Schema -> Maybe Int
setSchemaMinItems :: Schema -> Maybe Int -> Schema
getHTTPSecuritySchemeX :: HTTPSecurityScheme -> Maybe (HashMap Text Value)
setHTTPSecuritySchemeX :: HTTPSecurityScheme -> Maybe (HashMap Text Value) -> HTTPSecurityScheme
data ServerVariable = ServerVariable {
- _ServerVariable_default :: Text
- _ServerVariable_enum :: Maybe [Text]
- _ServerVariable_description :: Maybe Text
- _ServerVariable_x :: Maybe (HashMap Text Value)
}
getSchemaDefault :: Schema -> Maybe Value
setSchemaDefault :: Schema -> Maybe Value -> Schema
getOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text
setOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text -> OpenIdConnectSecurityScheme
getOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text
setOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text -> OAuth2SecurityScheme
data OpenAPIObject = OpenAPIObject {
- _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)
}
getComponentsParameters :: Components -> Maybe (HashMap Text (ReferenceOr Parameter))
setComponentsParameters :: Components -> Maybe (HashMap Text (ReferenceOr Parameter)) -> Components
getHeaderDescription :: Header -> Maybe Text
setHeaderDescription :: Header -> Maybe Text -> Header
data OpenIdConnectSecurityScheme = OpenIdConnectSecurityScheme {
- _OpenIdConnectSecurityScheme_type :: Text
- _OpenIdConnectSecurityScheme_openIdConnectUrl :: Text
- _OpenIdConnectSecurityScheme_description :: Maybe Text
- _OpenIdConnectSecurityScheme_x :: Maybe (HashMap Text Value)
}
getHeaderAllowEmptyValue :: Header -> Maybe Bool
setHeaderAllowEmptyValue :: Header -> Maybe Bool -> Header
data MediaType = MediaType {
- _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)
}
getEncodingX :: Encoding -> Maybe (HashMap Text Value)
setEncodingX :: Encoding -> Maybe (HashMap Text Value) -> Encoding
getPathItemSummary :: PathItem -> Maybe Text
setPathItemSummary :: PathItem -> Maybe Text -> PathItem
eitherItemsTuple :: Items -> Either Items [ReferenceOr Schema]
getReferenceRef :: Reference -> Text
setReferenceRef :: Reference -> Text -> Reference
getEncodingExplode :: Encoding -> Maybe Bool
setEncodingExplode :: Encoding -> Maybe Bool -> Encoding
getSchemaReadOnly :: Schema -> Maybe Bool
setSchemaReadOnly :: Schema -> Maybe Bool -> Schema
getHeaderStyle :: Header -> Maybe Text
setHeaderStyle :: Header -> Maybe Text -> Header
getPasswordOAuthFlowScopes :: PasswordOAuthFlow -> Maybe (HashMap Text Text)
setPasswordOAuthFlowScopes :: PasswordOAuthFlow -> Maybe (HashMap Text Text) -> PasswordOAuthFlow
data Header = Header {
- _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)
}
getOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text
setOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme
getPathItemDelete :: PathItem -> Maybe Operation
setPathItemDelete :: PathItem -> Maybe Operation -> PathItem
getSchemaEnum :: Schema -> Maybe [Value]
setSchemaEnum :: Schema -> Maybe [Value] -> Schema
getOpenAPIObjectOpenapi :: OpenAPIObject -> Text
setOpenAPIObjectOpenapi :: OpenAPIObject -> Text -> OpenAPIObject
getSchemaMinProperties :: Schema -> Maybe Int
setSchemaMinProperties :: Schema -> Maybe Int -> Schema
getEncodingHeaders :: Encoding -> Maybe (HashMap Text Header)
setEncodingHeaders :: Encoding -> Maybe (HashMap Text Header) -> Encoding
eitherBoolIntBool :: BoolInt -> Either BoolInt Bool
getSchemaAllOf :: Schema -> Maybe [ReferenceOr Schema]
setSchemaAllOf :: Schema -> Maybe [ReferenceOr Schema] -> Schema
getMediaTypeExamples :: MediaType -> Maybe (HashMap Text (ReferenceOr Example))
setMediaTypeExamples :: MediaType -> Maybe (HashMap Text (ReferenceOr Example)) -> MediaType
getPathItemOptions :: PathItem -> Maybe Operation
setPathItemOptions :: PathItem -> Maybe Operation -> PathItem
eitherAdditionalBool :: Additionals -> Either Additionals Bool
getOpenAPIObjectPaths :: OpenAPIObject -> HashMap Text PathItem
setOpenAPIObjectPaths :: OpenAPIObject -> HashMap Text PathItem -> OpenAPIObject
getRequestBodyRequired :: RequestBody -> Maybe Bool
setRequestBodyRequired :: RequestBody -> Maybe Bool -> RequestBody
getLinkX :: Link -> Maybe (HashMap Text Value)
setLinkX :: Link -> Maybe (HashMap Text Value) -> Link
getSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation
setSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation -> Schema
data Example = Example {
- _Example_summary :: Maybe Text
- _Example_description :: Maybe Text
- _Example_value :: Maybe Value
- _Example_externalValue :: Maybe Text
- _Example_x :: Maybe (HashMap Text Value)
}
eitherBoolIntInt :: BoolInt -> Either BoolInt Int
data OAuth2SecurityScheme = OAuth2SecurityScheme {
- _OAuth2SecurityScheme_flows :: OAuthFlows
- _OAuth2SecurityScheme_type :: Text
- _OAuth2SecurityScheme_description :: Maybe Text
- _OAuth2SecurityScheme_x :: Maybe (HashMap Text Value)
}
getSchemaAdditionalProperties :: Schema -> Maybe Additionals
setSchemaAdditionalProperties :: Schema -> Maybe Additionals -> Schema
eitherSecuritySchemaHTTPSS :: SecuritySchema -> Either SecuritySchema HTTPSecurityScheme
data Server = Server {
- _Server_url :: Text
- _Server_description :: Maybe Text
- _Server_variables :: Maybe (HashMap Text ServerVariable)
- _Server_x :: Maybe (HashMap Text Value)
}
getHeaderX :: Header -> Maybe (HashMap Text Value)
setHeaderX :: Header -> Maybe (HashMap Text Value) -> Header

Documentation

getLinkRequestBody :: Link -> Maybe Value Source #

setLinkRequestBody :: Link -> Maybe Value -> Link Source #

data ImplicitOAuthFlow Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: ImplicitOAuthFlow -> ImplicitOAuthFlow -> Bool # (/=) :: ImplicitOAuthFlow -> ImplicitOAuthFlow -> Bool #
Show ImplicitOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> ImplicitOAuthFlow -> ShowS # show :: ImplicitOAuthFlow -> String # showList :: [ImplicitOAuthFlow] -> ShowS #
ToJSON ImplicitOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: ImplicitOAuthFlow -> Value # toEncoding :: ImplicitOAuthFlow -> Encoding # toJSONList :: [ImplicitOAuthFlow] -> Value # toEncodingList :: [ImplicitOAuthFlow] -> Encoding #
FromJSON ImplicitOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser ImplicitOAuthFlow # parseJSONList :: Value -> Parser [ImplicitOAuthFlow] #

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

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

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

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

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

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

getOperationOperationId :: Operation -> Maybe Text Source #

setOperationOperationId :: Operation -> Maybe Text -> Operation Source #

getPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text Source #

setPasswordOAuthFlowTokenUrl :: PasswordOAuthFlow -> Text -> PasswordOAuthFlow Source #

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

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

getInfoTermsOfService :: Info -> Maybe Text Source #

setInfoTermsOfService :: Info -> Maybe Text -> Info Source #

getHeaderExplode :: Header -> Maybe Bool Source #

setHeaderExplode :: Header -> Maybe Bool -> Header Source #

getSchemaRequired :: Schema -> Maybe [Text] Source #

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

getPathItemTrace :: PathItem -> Maybe Operation Source #

setPathItemTrace :: PathItem -> Maybe Operation -> PathItem Source #

getContactEmail :: Contact -> Maybe Text Source #

setContactEmail :: Contact -> Maybe Text -> Contact Source #

getParameterAllowEmptyValue :: Parameter -> Maybe Bool Source #

setParameterAllowEmptyValue :: Parameter -> Maybe Bool -> Parameter Source #

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

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

getOperationExternalDocs :: Operation -> Maybe ExternalDocumentation Source #

setOperationExternalDocs :: Operation -> Maybe ExternalDocumentation -> Operation Source #

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

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

getPathItemPut :: PathItem -> Maybe Operation Source #

setPathItemPut :: PathItem -> Maybe Operation -> PathItem Source #

getXMLWrapped :: XML -> Maybe Bool Source #

setXMLWrapped :: XML -> Maybe Bool -> XML Source #

getOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components Source #

setOpenAPIObjectComponents :: OpenAPIObject -> Maybe Components -> OpenAPIObject Source #

data AuthorizationCodeOAuthFlow Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: AuthorizationCodeOAuthFlow -> AuthorizationCodeOAuthFlow -> Bool # (/=) :: AuthorizationCodeOAuthFlow -> AuthorizationCodeOAuthFlow -> Bool #
Show AuthorizationCodeOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> AuthorizationCodeOAuthFlow -> ShowS # show :: AuthorizationCodeOAuthFlow -> String # showList :: [AuthorizationCodeOAuthFlow] -> ShowS #
ToJSON AuthorizationCodeOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: AuthorizationCodeOAuthFlow -> Value # toEncoding :: AuthorizationCodeOAuthFlow -> Encoding # toJSONList :: [AuthorizationCodeOAuthFlow] -> Value # toEncodingList :: [AuthorizationCodeOAuthFlow] -> Encoding #
FromJSON AuthorizationCodeOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser AuthorizationCodeOAuthFlow # parseJSONList :: Value -> Parser [AuthorizationCodeOAuthFlow] #

getContactName :: Contact -> Maybe Text Source #

setContactName :: Contact -> Maybe Text -> Contact Source #

getSchemaMultipleOf :: Schema -> Maybe Double Source #

setSchemaMultipleOf :: Schema -> Maybe Double -> Schema Source #

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

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

getParameterDescription :: Parameter -> Maybe Text Source #

setParameterDescription :: Parameter -> Maybe Text -> Parameter Source #

getInfoContact :: Info -> Maybe Contact Source #

setInfoContact :: Info -> Maybe Contact -> Info Source #

data Components Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Components -> Components -> Bool # (/=) :: Components -> Components -> Bool #
Show Components Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Components -> ShowS # show :: Components -> String # showList :: [Components] -> ShowS #
ToJSON Components Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Components -> Value # toEncoding :: Components -> Encoding # toJSONList :: [Components] -> Value # toEncodingList :: [Components] -> Encoding #
FromJSON Components Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Components # parseJSONList :: Value -> Parser [Components] #

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

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

getHeaderAllowReserved :: Header -> Maybe Bool Source #

setHeaderAllowReserved :: Header -> Maybe Bool -> Header Source #

getHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text Source #

setHTTPSecuritySchemeDescription :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme Source #

getTagExternalDocs :: Tag -> Maybe ExternalDocumentation Source #

setTagExternalDocs :: Tag -> Maybe ExternalDocumentation -> Tag Source #

getOperationDescription :: Operation -> Maybe Text Source #

setOperationDescription :: Operation -> Maybe Text -> Operation Source #

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

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

getPathItemRef :: PathItem -> Maybe Text Source #

setPathItemRef :: PathItem -> Maybe Text -> PathItem Source #

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

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

getAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text Source #

setAPIKeySecuritySchemeIn :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme Source #

getPathItemPatch :: PathItem -> Maybe Operation Source #

setPathItemPatch :: PathItem -> Maybe Operation -> PathItem Source #

data Info Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Info -> Info -> Bool # (/=) :: Info -> Info -> Bool #
Show Info Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Info -> ShowS # show :: Info -> String # showList :: [Info] -> ShowS #
ToJSON Info Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Info -> Value # toEncoding :: Info -> Encoding # toJSONList :: [Info] -> Value # toEncodingList :: [Info] -> Encoding #
FromJSON Info Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Info # parseJSONList :: Value -> Parser [Info] #

data Additionals Source #

Constructors

AdditionalSchema Schema
AdditionalReference Reference
AdditionalBool Bool

Instances

Eq Additionals Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Additionals -> Additionals -> Bool # (/=) :: Additionals -> Additionals -> Bool #
Show Additionals Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Additionals -> ShowS # show :: Additionals -> String # showList :: [Additionals] -> ShowS #
ToJSON Additionals Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Additionals -> Value # toEncoding :: Additionals -> Encoding # toJSONList :: [Additionals] -> Value # toEncodingList :: [Additionals] -> Encoding #
FromJSON Additionals Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Additionals # parseJSONList :: Value -> Parser [Additionals] #

getOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow Source #

setOAuthFlowsImplicit :: OAuthFlows -> Maybe ImplicitOAuthFlow -> OAuthFlows Source #

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

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

data BoolInt Source #

Constructors

ABool Bool
AnInt Int

Instances

Eq BoolInt Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: BoolInt -> BoolInt -> Bool # (/=) :: BoolInt -> BoolInt -> Bool #
Show BoolInt Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> BoolInt -> ShowS # show :: BoolInt -> String # showList :: [BoolInt] -> ShowS #
ToJSON BoolInt Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: BoolInt -> Value # toEncoding :: BoolInt -> Encoding # toJSONList :: [BoolInt] -> Value # toEncodingList :: [BoolInt] -> Encoding #
FromJSON BoolInt Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser BoolInt # parseJSONList :: Value -> Parser [BoolInt] #

getInfoLicense :: Info -> Maybe License Source #

setInfoLicense :: Info -> Maybe License -> Info Source #

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

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

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

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

getTagDescription :: Tag -> Maybe Text Source #

setTagDescription :: Tag -> Maybe Text -> Tag Source #

getParameterRequired :: Parameter -> Maybe Bool Source #

setParameterRequired :: Parameter -> Maybe Bool -> Parameter Source #

eitherSecuritySchemaOAuth2SS :: SecuritySchema -> Either SecuritySchema OAuth2SecurityScheme Source #

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

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

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

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

data PathItem Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: PathItem -> PathItem -> Bool # (/=) :: PathItem -> PathItem -> Bool #
Show PathItem Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> PathItem -> ShowS # show :: PathItem -> String # showList :: [PathItem] -> ShowS #
ToJSON PathItem Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: PathItem -> Value # toEncoding :: PathItem -> Encoding # toJSONList :: [PathItem] -> Value # toEncodingList :: [PathItem] -> Encoding #
FromJSON PathItem Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser PathItem # parseJSONList :: Value -> Parser [PathItem] #

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

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

data ClientCredentialsFlow Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: ClientCredentialsFlow -> ClientCredentialsFlow -> Bool # (/=) :: ClientCredentialsFlow -> ClientCredentialsFlow -> Bool #
Show ClientCredentialsFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> ClientCredentialsFlow -> ShowS # show :: ClientCredentialsFlow -> String # showList :: [ClientCredentialsFlow] -> ShowS #
ToJSON ClientCredentialsFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: ClientCredentialsFlow -> Value # toEncoding :: ClientCredentialsFlow -> Encoding # toJSONList :: [ClientCredentialsFlow] -> Value # toEncodingList :: [ClientCredentialsFlow] -> Encoding #
FromJSON ClientCredentialsFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser ClientCredentialsFlow # parseJSONList :: Value -> Parser [ClientCredentialsFlow] #

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

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

getParameterExplode :: Parameter -> Maybe Bool Source #

setParameterExplode :: Parameter -> Maybe Bool -> Parameter Source #

getLinkOperationId :: Link -> Maybe Text Source #

setLinkOperationId :: Link -> Maybe Text -> Link Source #

getXMLPrefix :: XML -> Maybe Text Source #

setXMLPrefix :: XML -> Maybe Text -> XML Source #

getSchemaExclusiveMinimum :: Schema -> Maybe BoolInt Source #

setSchemaExclusiveMinimum :: Schema -> Maybe BoolInt -> Schema Source #

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

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

getSchemaExample :: Schema -> Maybe Value Source #

setSchemaExample :: Schema -> Maybe Value -> Schema Source #

getRequestBodyDescription :: RequestBody -> Maybe Text Source #

setRequestBodyDescription :: RequestBody -> Maybe Text -> RequestBody Source #

getOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text Source #

setOpenIdConnectSecuritySchemeOpenIdConnectUrl :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme Source #

getAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text Source #

setAPIKeySecuritySchemeType :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme Source #

getServerUrl :: Server -> Text Source #

setServerUrl :: Server -> Text -> Server Source #

eitherAdditionalReference :: Additionals -> Either Additionals Reference Source #

eitherItemsSingleItem :: Items -> Either Items Schema Source #

data Reference Source #

Reference $ref x

Constructors

Reference
Fields _Reference_ref :: Text _Reference_x :: Maybe (HashMap Text Value)

Instances

Eq Reference Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Reference -> Reference -> Bool # (/=) :: Reference -> Reference -> Bool #
Show Reference Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Reference -> ShowS # show :: Reference -> String # showList :: [Reference] -> ShowS #
ToJSON Reference Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Reference -> Value # toEncoding :: Reference -> Encoding # toJSONList :: [Reference] -> Value # toEncodingList :: [Reference] -> Encoding #
FromJSON Reference Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Reference # parseJSONList :: Value -> Parser [Reference] #

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

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

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

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

getOperationSummary :: Operation -> Maybe Text Source #

setOperationSummary :: Operation -> Maybe Text -> Operation Source #

data OAuthFlows Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: OAuthFlows -> OAuthFlows -> Bool # (/=) :: OAuthFlows -> OAuthFlows -> Bool #
Show OAuthFlows Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> OAuthFlows -> ShowS # show :: OAuthFlows -> String # showList :: [OAuthFlows] -> ShowS #
ToJSON OAuthFlows Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: OAuthFlows -> Value # toEncoding :: OAuthFlows -> Encoding # toJSONList :: [OAuthFlows] -> Value # toEncodingList :: [OAuthFlows] -> Encoding #
FromJSON OAuthFlows Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser OAuthFlows # parseJSONList :: Value -> Parser [OAuthFlows] #

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

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

getExampleValue :: Example -> Maybe Value Source #

setExampleValue :: Example -> Maybe Value -> Example Source #

data Parameter Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Show Parameter Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
ToJSON Parameter Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Parameter -> Value # toEncoding :: Parameter -> Encoding # toJSONList :: [Parameter] -> Value # toEncodingList :: [Parameter] -> Encoding #
FromJSON Parameter Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Parameter # parseJSONList :: Value -> Parser [Parameter] #

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

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

getEncodingAllowReserved :: Encoding -> Maybe Bool Source #

setEncodingAllowReserved :: Encoding -> Maybe Bool -> Encoding Source #

getOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows Source #

setOAuth2SecuritySchemeFlows :: OAuth2SecurityScheme -> OAuthFlows -> OAuth2SecurityScheme Source #

getParameterSchema :: Parameter -> Maybe (ReferenceOr Schema) Source #

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

getImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text Source #

setImplicitOAuthFlowScopes :: ImplicitOAuthFlow -> HashMap Text Text -> ImplicitOAuthFlow Source #

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

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

getInfoDescription :: Info -> Maybe Text Source #

setInfoDescription :: Info -> Maybe Text -> Info Source #

data Operation Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #
Show Operation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
ToJSON Operation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding #
FromJSON Operation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] #

getLinkOperationRef :: Link -> Maybe Text Source #

setLinkOperationRef :: Link -> Maybe Text -> Link Source #

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

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

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

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

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

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

data Items Source #

Constructors

Tuple [ReferenceOr Schema]
SingleItem Schema
SingleItemReference Reference

Instances

Eq Items Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Items -> Items -> Bool # (/=) :: Items -> Items -> Bool #
Show Items Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Items -> ShowS # show :: Items -> String # showList :: [Items] -> ShowS #
ToJSON Items Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Items -> Value # toEncoding :: Items -> Encoding # toJSONList :: [Items] -> Value # toEncodingList :: [Items] -> Encoding #
FromJSON Items Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Items # parseJSONList :: Value -> Parser [Items] #

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

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

getOperationTags :: Operation -> Maybe [Text] Source #

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

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

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

getInfoVersion :: Info -> Text Source #

setInfoVersion :: Info -> Text -> Info Source #

getServerVariableDefault :: ServerVariable -> Text Source #

setServerVariableDefault :: ServerVariable -> Text -> ServerVariable Source #

getAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text Source #

setAuthorizationCodeOAuthFlowRefreshUrl :: AuthorizationCodeOAuthFlow -> Maybe Text -> AuthorizationCodeOAuthFlow Source #

getOpenAPIObjectTags :: OpenAPIObject -> Maybe [Tag] Source #

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

getPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text Source #

setPasswordOAuthFlowRefreshUrl :: PasswordOAuthFlow -> Maybe Text -> PasswordOAuthFlow Source #

getOperationRequestBody :: Operation -> Maybe (ReferenceOr RequestBody) Source #

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

getParameterStyle :: Parameter -> Maybe Text Source #

setParameterStyle :: Parameter -> Maybe Text -> Parameter Source #

getSchemaAnyOf :: Schema -> Maybe [ReferenceOr Schema] Source #

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

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

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

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

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

getExampleDescription :: Example -> Maybe Text Source #

setExampleDescription :: Example -> Maybe Text -> Example Source #

getServerVariableEnum :: ServerVariable -> Maybe [Text] Source #

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

eitherSecuritySchemaOpenIdConnectSS :: SecuritySchema -> Either SecuritySchema OpenIdConnectSecurityScheme Source #

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

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

getHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text Source #

setHTTPSecuritySchemeType :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme Source #

getSchemaNot :: Schema -> Maybe (ReferenceOr Schema) Source #

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

getHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text Source #

setHTTPSecuritySchemeScheme :: HTTPSecurityScheme -> Text -> HTTPSecurityScheme Source #

getAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text Source #

setAPIKeySecuritySchemeName :: APIKeySecurityScheme -> Text -> APIKeySecurityScheme Source #

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

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

getOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow Source #

setOAuthFlowsPassword :: OAuthFlows -> Maybe PasswordOAuthFlow -> OAuthFlows Source #

getSchemaDescription :: Schema -> Maybe Text Source #

setSchemaDescription :: Schema -> Maybe Text -> Schema Source #

getParameterIn :: Parameter -> Text Source #

setParameterIn :: Parameter -> Text -> Parameter Source #

getPathItemParameters :: PathItem -> Maybe [ReferenceOr Parameter] Source #

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

getPathItemHead :: PathItem -> Maybe Operation Source #

setPathItemHead :: PathItem -> Maybe Operation -> PathItem Source #

getImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text Source #

setImplicitOAuthFlowRefreshUrl :: ImplicitOAuthFlow -> Maybe Text -> ImplicitOAuthFlow Source #

getEncodingContentType :: Encoding -> Maybe Text Source #

setEncodingContentType :: Encoding -> Maybe Text -> Encoding Source #

data Contact Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Contact -> Contact -> Bool # (/=) :: Contact -> Contact -> Bool #
Show Contact Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Contact -> ShowS # show :: Contact -> String # showList :: [Contact] -> ShowS #
ToJSON Contact Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Contact -> Value # toEncoding :: Contact -> Encoding # toJSONList :: [Contact] -> Value # toEncodingList :: [Contact] -> Encoding #
FromJSON Contact Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Contact # parseJSONList :: Value -> Parser [Contact] #

getHeaderDeprecated :: Header -> Maybe Bool Source #

setHeaderDeprecated :: Header -> Maybe Bool -> Header Source #

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

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

getSchemaFormat :: Schema -> Maybe Text Source #

setSchemaFormat :: Schema -> Maybe Text -> Schema Source #

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

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

getOpenAPIObjectServers :: OpenAPIObject -> Maybe [Server] Source #

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

getSchemaType :: Schema -> Maybe Text Source #

setSchemaType :: Schema -> Maybe Text -> Schema Source #

getResponseDescription :: Response -> Text Source #

setResponseDescription :: Response -> Text -> Response Source #

getSchemaPattern :: Schema -> Maybe Text Source #

setSchemaPattern :: Schema -> Maybe Text -> Schema Source #

data HTTPSecurityScheme Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: HTTPSecurityScheme -> HTTPSecurityScheme -> Bool # (/=) :: HTTPSecurityScheme -> HTTPSecurityScheme -> Bool #
Show HTTPSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> HTTPSecurityScheme -> ShowS # show :: HTTPSecurityScheme -> String # showList :: [HTTPSecurityScheme] -> ShowS #
ToJSON HTTPSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: HTTPSecurityScheme -> Value # toEncoding :: HTTPSecurityScheme -> Encoding # toJSONList :: [HTTPSecurityScheme] -> Value # toEncodingList :: [HTTPSecurityScheme] -> Encoding #
FromJSON HTTPSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser HTTPSecurityScheme # parseJSONList :: Value -> Parser [HTTPSecurityScheme] #

getExampleExternalValue :: Example -> Maybe Text Source #

setExampleExternalValue :: Example -> Maybe Text -> Example Source #

getHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text Source #

setHTTPSecuritySchemeBearerFormat :: HTTPSecurityScheme -> Maybe Text -> HTTPSecurityScheme Source #

data Discriminator Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Discriminator -> Discriminator -> Bool # (/=) :: Discriminator -> Discriminator -> Bool #
Show Discriminator Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Discriminator -> ShowS # show :: Discriminator -> String # showList :: [Discriminator] -> ShowS #
ToJSON Discriminator Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Discriminator -> Value # toEncoding :: Discriminator -> Encoding # toJSONList :: [Discriminator] -> Value # toEncodingList :: [Discriminator] -> Encoding #
FromJSON Discriminator Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Discriminator # parseJSONList :: Value -> Parser [Discriminator] #

getSchemaXml :: Schema -> Maybe XML Source #

setSchemaXml :: Schema -> Maybe XML -> Schema Source #

getOperationServers :: Operation -> Maybe [Server] Source #

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

getContactUrl :: Contact -> Maybe Text Source #

setContactUrl :: Contact -> Maybe Text -> Contact Source #

getSchemaExclusiveMaximum :: Schema -> Maybe BoolInt Source #

setSchemaExclusiveMaximum :: Schema -> Maybe BoolInt -> Schema Source #

data Link Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Link -> Link -> Bool # (/=) :: Link -> Link -> Bool #
Show Link Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Link -> ShowS # show :: Link -> String # showList :: [Link] -> ShowS #
ToJSON Link Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Link -> Value # toEncoding :: Link -> Encoding # toJSONList :: [Link] -> Value # toEncodingList :: [Link] -> Encoding #
FromJSON Link Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Link # parseJSONList :: Value -> Parser [Link] #

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

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

eitherSecuritySchemaAPIKeySS :: SecuritySchema -> Either SecuritySchema APIKeySecurityScheme Source #

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

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

getTagName :: Tag -> Text Source #

setTagName :: Tag -> Text -> Tag Source #

getAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text Source #

setAuthorizationCodeOAuthFlowAuthorizationUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow Source #

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

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

getPathItemPost :: PathItem -> Maybe Operation Source #

setPathItemPost :: PathItem -> Maybe Operation -> PathItem Source #

getOperationParameters :: Operation -> Maybe [ReferenceOr Parameter] Source #

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

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

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

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

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

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

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

getEncodingStyle :: Encoding -> Maybe Text Source #

setEncodingStyle :: Encoding -> Maybe Text -> Encoding Source #

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

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

getExternalDocumentationUrl :: ExternalDocumentation -> Text Source #

setExternalDocumentationUrl :: ExternalDocumentation -> Text -> ExternalDocumentation Source #

getClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text Source #

setClientCredentialsFlowTokenUrl :: ClientCredentialsFlow -> Text -> ClientCredentialsFlow Source #

getInfoTitle :: Info -> Text Source #

setInfoTitle :: Info -> Text -> Info Source #

getSchemaTitle :: Schema -> Maybe Text Source #

setSchemaTitle :: Schema -> Maybe Text -> Schema Source #

getXMLName :: XML -> Maybe Text Source #

setXMLName :: XML -> Maybe Text -> XML Source #

getSchemaDiscriminator :: Schema -> Maybe Discriminator Source #

setSchemaDiscriminator :: Schema -> Maybe Discriminator -> Schema Source #

getSchemaMaxItems :: Schema -> Maybe Int Source #

setSchemaMaxItems :: Schema -> Maybe Int -> Schema Source #

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

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

data ExternalDocumentation Source #

ExternalDocumentation url description x

Constructors

ExternalDocumentation
Fields _ExternalDocumentation_url :: Text _ExternalDocumentation_description :: Maybe Text _ExternalDocumentation_x :: Maybe (HashMap Text Value)

Instances

Eq ExternalDocumentation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: ExternalDocumentation -> ExternalDocumentation -> Bool # (/=) :: ExternalDocumentation -> ExternalDocumentation -> Bool #
Show ExternalDocumentation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> ExternalDocumentation -> ShowS # show :: ExternalDocumentation -> String # showList :: [ExternalDocumentation] -> ShowS #
ToJSON ExternalDocumentation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: ExternalDocumentation -> Value # toEncoding :: ExternalDocumentation -> Encoding # toJSONList :: [ExternalDocumentation] -> Value # toEncodingList :: [ExternalDocumentation] -> Encoding #
FromJSON ExternalDocumentation Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser ExternalDocumentation # parseJSONList :: Value -> Parser [ExternalDocumentation] #

getSchemaMinLength :: Schema -> Maybe Int Source #

setSchemaMinLength :: Schema -> Maybe Int -> Schema Source #

getHeaderSchema :: Header -> Maybe (ReferenceOr Schema) Source #

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

data SecuritySchema Source #

Constructors

APIKeySS APIKeySecurityScheme
HTTPSS HTTPSecurityScheme
OAuth2SS OAuth2SecurityScheme
OpenIdConnectSS OpenIdConnectSecurityScheme
TextSS Text
ReferenceSS Reference

Instances

Eq SecuritySchema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: SecuritySchema -> SecuritySchema -> Bool # (/=) :: SecuritySchema -> SecuritySchema -> Bool #
Show SecuritySchema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> SecuritySchema -> ShowS # show :: SecuritySchema -> String # showList :: [SecuritySchema] -> ShowS #
ToJSON SecuritySchema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: SecuritySchema -> Value # toEncoding :: SecuritySchema -> Encoding # toJSONList :: [SecuritySchema] -> Value # toEncodingList :: [SecuritySchema] -> Encoding #
FromJSON SecuritySchema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser SecuritySchema # parseJSONList :: Value -> Parser [SecuritySchema] #

getParameterAllowReserved :: Parameter -> Maybe Bool Source #

setParameterAllowReserved :: Parameter -> Maybe Bool -> Parameter Source #

getSchemaNullable :: Schema -> Maybe Bool Source #

setSchemaNullable :: Schema -> Maybe Bool -> Schema Source #

getParameterName :: Parameter -> Text Source #

setParameterName :: Parameter -> Text -> Parameter Source #

getServerVariableDescription :: ServerVariable -> Maybe Text Source #

setServerVariableDescription :: ServerVariable -> Maybe Text -> ServerVariable Source #

getAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text Source #

setAuthorizationCodeOAuthFlowTokenUrl :: AuthorizationCodeOAuthFlow -> Text -> AuthorizationCodeOAuthFlow Source #

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

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

getLicenseName :: License -> Text Source #

setLicenseName :: License -> Text -> License Source #

getExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text Source #

setExternalDocumentationDescription :: ExternalDocumentation -> Maybe Text -> ExternalDocumentation Source #

data License Source #

License name url x

Constructors

License
Fields _License_name :: Text _License_url :: Maybe Text _License_x :: Maybe (HashMap Text Value)

Instances

Eq License Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Show License Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #
ToJSON License Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: License -> Value # toEncoding :: License -> Encoding # toJSONList :: [License] -> Value # toEncodingList :: [License] -> Encoding #
FromJSON License Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser License # parseJSONList :: Value -> Parser [License] #

data ReferenceOr a Source #

Constructors

Ref Reference
RealDeal a

Instances

Eq a => Eq (ReferenceOr a) Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: ReferenceOr a -> ReferenceOr a -> Bool # (/=) :: ReferenceOr a -> ReferenceOr a -> Bool #
Show a => Show (ReferenceOr a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser (ReferenceOr a) # parseJSONList :: Value -> Parser [ReferenceOr a] #

getParameterDeprecated :: Parameter -> Maybe Bool Source #

setParameterDeprecated :: Parameter -> Maybe Bool -> Parameter Source #

getOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation Source #

setOpenAPIObjectExternalDocs :: OpenAPIObject -> Maybe ExternalDocumentation -> OpenAPIObject Source #

data Schema Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #
Show Schema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
ToJSON Schema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Schema -> Value # toEncoding :: Schema -> Encoding # toJSONList :: [Schema] -> Value # toEncodingList :: [Schema] -> Encoding #
FromJSON Schema Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Schema # parseJSONList :: Value -> Parser [Schema] #

data RequestBody Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: RequestBody -> RequestBody -> Bool # (/=) :: RequestBody -> RequestBody -> Bool #
Show RequestBody Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> RequestBody -> ShowS # show :: RequestBody -> String # showList :: [RequestBody] -> ShowS #
ToJSON RequestBody Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: RequestBody -> Value # toEncoding :: RequestBody -> Encoding # toJSONList :: [RequestBody] -> Value # toEncodingList :: [RequestBody] -> Encoding #
FromJSON RequestBody Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser RequestBody # parseJSONList :: Value -> Parser [RequestBody] #

getPathItemServers :: PathItem -> Maybe [Server] Source #

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

getMediaTypeExample :: MediaType -> Maybe Value Source #

setMediaTypeExample :: MediaType -> Maybe Value -> MediaType Source #

getHeaderExample :: Header -> Maybe Value Source #

setHeaderExample :: Header -> Maybe Value -> Header Source #

getSchemaWriteOnly :: Schema -> Maybe Bool Source #

setSchemaWriteOnly :: Schema -> Maybe Bool -> Schema Source #

getSchemaOneOf :: Schema -> Maybe [ReferenceOr Schema] Source #

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

data Response Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Response -> Response -> Bool # (/=) :: Response -> Response -> Bool #
Show Response Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
ToJSON Response Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Response -> Value # toEncoding :: Response -> Encoding # toJSONList :: [Response] -> Value # toEncodingList :: [Response] -> Encoding #
FromJSON Response Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Response # parseJSONList :: Value -> Parser [Response] #

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

getOpenAPIObjectInfo :: OpenAPIObject -> Info Source #

setOpenAPIObjectInfo :: OpenAPIObject -> Info -> OpenAPIObject Source #

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

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

getLinkDescription :: Link -> Maybe Text Source #

setLinkDescription :: Link -> Maybe Text -> Link Source #

getSchemaMinimum :: Schema -> Maybe Double Source #

setSchemaMinimum :: Schema -> Maybe Double -> Schema Source #

getSchemaMaxLength :: Schema -> Maybe Int Source #

setSchemaMaxLength :: Schema -> Maybe Int -> Schema Source #

getExampleSummary :: Example -> Maybe Text Source #

setExampleSummary :: Example -> Maybe Text -> Example Source #

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

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

getSchemaMaximum :: Schema -> Maybe Double Source #

setSchemaMaximum :: Schema -> Maybe Double -> Schema Source #

getOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow Source #

setOAuthFlowsAuthorizationCode :: OAuthFlows -> Maybe AuthorizationCodeOAuthFlow -> OAuthFlows Source #

getRequestBodyContent :: RequestBody -> HashMap Text MediaType Source #

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

data XML Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: XML -> XML -> Bool # (/=) :: XML -> XML -> Bool #
Show XML Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> XML -> ShowS # show :: XML -> String # showList :: [XML] -> ShowS #
ToJSON XML Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: XML -> Value # toEncoding :: XML -> Encoding # toJSONList :: [XML] -> Value # toEncodingList :: [XML] -> Encoding #
FromJSON XML Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser XML # parseJSONList :: Value -> Parser [XML] #

getLinkServer :: Link -> Maybe Server Source #

setLinkServer :: Link -> Maybe Server -> Link Source #

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

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

data PasswordOAuthFlow Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: PasswordOAuthFlow -> PasswordOAuthFlow -> Bool # (/=) :: PasswordOAuthFlow -> PasswordOAuthFlow -> Bool #
Show PasswordOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> PasswordOAuthFlow -> ShowS # show :: PasswordOAuthFlow -> String # showList :: [PasswordOAuthFlow] -> ShowS #
ToJSON PasswordOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: PasswordOAuthFlow -> Value # toEncoding :: PasswordOAuthFlow -> Encoding # toJSONList :: [PasswordOAuthFlow] -> Value # toEncodingList :: [PasswordOAuthFlow] -> Encoding #
FromJSON PasswordOAuthFlow Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser PasswordOAuthFlow # parseJSONList :: Value -> Parser [PasswordOAuthFlow] #

getSchemaDeprecated :: Schema -> Maybe Bool Source #

setSchemaDeprecated :: Schema -> Maybe Bool -> Schema Source #

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

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

getPathItemGet :: PathItem -> Maybe Operation Source #

setPathItemGet :: PathItem -> Maybe Operation -> PathItem Source #

getSchemaItems :: Schema -> Maybe Items Source #

setSchemaItems :: Schema -> Maybe Items -> Schema Source #

getDiscriminatorPropertyName :: Discriminator -> Text Source #

setDiscriminatorPropertyName :: Discriminator -> Text -> Discriminator Source #

getParameterExample :: Parameter -> Maybe Value Source #

setParameterExample :: Parameter -> Maybe Value -> Parameter Source #

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

getSchemaUniqueItems :: Schema -> Maybe Bool Source #

setSchemaUniqueItems :: Schema -> Maybe Bool -> Schema Source #

getOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow Source #

setOAuthFlowsClientCredentials :: OAuthFlows -> Maybe ClientCredentialsFlow -> OAuthFlows Source #

eitherItemsSingleItemReference :: Items -> Either Items Reference Source #

getImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text Source #

setImplicitOAuthFlowAuthorizationUrl :: ImplicitOAuthFlow -> Text -> ImplicitOAuthFlow Source #

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

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

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

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

getLicenseUrl :: License -> Maybe Text Source #

setLicenseUrl :: License -> Maybe Text -> License Source #

data Encoding Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Encoding -> Encoding -> Bool # (/=) :: Encoding -> Encoding -> Bool #
Show Encoding Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Encoding -> ShowS # show :: Encoding -> String # showList :: [Encoding] -> ShowS #
ToJSON Encoding Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Encoding -> Value # toEncoding :: Encoding -> Encoding0 # toJSONList :: [Encoding] -> Value # toEncodingList :: [Encoding] -> Encoding0 #
FromJSON Encoding Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Encoding # parseJSONList :: Value -> Parser [Encoding] #

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

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

getMediaTypeSchema :: MediaType -> Maybe (ReferenceOr Schema) Source #

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

getClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text Source #

setClientCredentialsFlowRefreshUrl :: ClientCredentialsFlow -> Maybe Text -> ClientCredentialsFlow Source #

getOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text Source #

setOAuth2SecuritySchemeDescription :: OAuth2SecurityScheme -> Maybe Text -> OAuth2SecurityScheme Source #

data APIKeySecurityScheme Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: APIKeySecurityScheme -> APIKeySecurityScheme -> Bool # (/=) :: APIKeySecurityScheme -> APIKeySecurityScheme -> Bool #
Show APIKeySecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> APIKeySecurityScheme -> ShowS # show :: APIKeySecurityScheme -> String # showList :: [APIKeySecurityScheme] -> ShowS #
ToJSON APIKeySecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: APIKeySecurityScheme -> Value # toEncoding :: APIKeySecurityScheme -> Encoding # toJSONList :: [APIKeySecurityScheme] -> Value # toEncodingList :: [APIKeySecurityScheme] -> Encoding #
FromJSON APIKeySecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser APIKeySecurityScheme # parseJSONList :: Value -> Parser [APIKeySecurityScheme] #

getAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text Source #

setAPIKeySecuritySchemeDescription :: APIKeySecurityScheme -> Maybe Text -> APIKeySecurityScheme Source #

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

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

getSchemaMaxProperties :: Schema -> Maybe Int Source #

setSchemaMaxProperties :: Schema -> Maybe Int -> Schema Source #

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

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

getPathItemDescription :: PathItem -> Maybe Text Source #

setPathItemDescription :: PathItem -> Maybe Text -> PathItem Source #

getServerDescription :: Server -> Maybe Text Source #

setServerDescription :: Server -> Maybe Text -> Server Source #

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

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

getOperationDeprecated :: Operation -> Maybe Bool Source #

setOperationDeprecated :: Operation -> Maybe Bool -> Operation Source #

data Tag Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Show Tag Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToJSON Tag Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #

getHeaderRequired :: Header -> Maybe Bool Source #

setHeaderRequired :: Header -> Maybe Bool -> Header Source #

eitherAdditionalSchema :: Additionals -> Either Additionals Schema Source #

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

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

getXMLNamespace :: XML -> Maybe Text Source #

setXMLNamespace :: XML -> Maybe Text -> XML Source #

getXMLAttribute :: XML -> Maybe Bool Source #

setXMLAttribute :: XML -> Maybe Bool -> XML Source #

getSchemaMinItems :: Schema -> Maybe Int Source #

setSchemaMinItems :: Schema -> Maybe Int -> Schema Source #

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

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

data ServerVariable Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: ServerVariable -> ServerVariable -> Bool # (/=) :: ServerVariable -> ServerVariable -> Bool #
Show ServerVariable Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> ServerVariable -> ShowS # show :: ServerVariable -> String # showList :: [ServerVariable] -> ShowS #
ToJSON ServerVariable Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: ServerVariable -> Value # toEncoding :: ServerVariable -> Encoding # toJSONList :: [ServerVariable] -> Value # toEncodingList :: [ServerVariable] -> Encoding #
FromJSON ServerVariable Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser ServerVariable # parseJSONList :: Value -> Parser [ServerVariable] #

getSchemaDefault :: Schema -> Maybe Value Source #

setSchemaDefault :: Schema -> Maybe Value -> Schema Source #

getOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text Source #

setOpenIdConnectSecuritySchemeDescription :: OpenIdConnectSecurityScheme -> Maybe Text -> OpenIdConnectSecurityScheme Source #

getOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text Source #

setOAuth2SecuritySchemeType :: OAuth2SecurityScheme -> Text -> OAuth2SecurityScheme Source #

data OpenAPIObject Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: OpenAPIObject -> OpenAPIObject -> Bool # (/=) :: OpenAPIObject -> OpenAPIObject -> Bool #
Show OpenAPIObject Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> OpenAPIObject -> ShowS # show :: OpenAPIObject -> String # showList :: [OpenAPIObject] -> ShowS #
ToJSON OpenAPIObject Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: OpenAPIObject -> Value # toEncoding :: OpenAPIObject -> Encoding # toJSONList :: [OpenAPIObject] -> Value # toEncodingList :: [OpenAPIObject] -> Encoding #
FromJSON OpenAPIObject Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser OpenAPIObject # parseJSONList :: Value -> Parser [OpenAPIObject] #

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

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

getHeaderDescription :: Header -> Maybe Text Source #

setHeaderDescription :: Header -> Maybe Text -> Header Source #

data OpenIdConnectSecurityScheme Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: OpenIdConnectSecurityScheme -> OpenIdConnectSecurityScheme -> Bool # (/=) :: OpenIdConnectSecurityScheme -> OpenIdConnectSecurityScheme -> Bool #
Show OpenIdConnectSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> OpenIdConnectSecurityScheme -> ShowS # show :: OpenIdConnectSecurityScheme -> String # showList :: [OpenIdConnectSecurityScheme] -> ShowS #
ToJSON OpenIdConnectSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: OpenIdConnectSecurityScheme -> Value # toEncoding :: OpenIdConnectSecurityScheme -> Encoding # toJSONList :: [OpenIdConnectSecurityScheme] -> Value # toEncodingList :: [OpenIdConnectSecurityScheme] -> Encoding #
FromJSON OpenIdConnectSecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser OpenIdConnectSecurityScheme # parseJSONList :: Value -> Parser [OpenIdConnectSecurityScheme] #

getHeaderAllowEmptyValue :: Header -> Maybe Bool Source #

setHeaderAllowEmptyValue :: Header -> Maybe Bool -> Header Source #

data MediaType Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: MediaType -> MediaType -> Bool # (/=) :: MediaType -> MediaType -> Bool #
Show MediaType Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> MediaType -> ShowS # show :: MediaType -> String # showList :: [MediaType] -> ShowS #
ToJSON MediaType Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: MediaType -> Value # toEncoding :: MediaType -> Encoding # toJSONList :: [MediaType] -> Value # toEncodingList :: [MediaType] -> Encoding #
FromJSON MediaType Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser MediaType # parseJSONList :: Value -> Parser [MediaType] #

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

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

getPathItemSummary :: PathItem -> Maybe Text Source #

setPathItemSummary :: PathItem -> Maybe Text -> PathItem Source #

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

getReferenceRef :: Reference -> Text Source #

setReferenceRef :: Reference -> Text -> Reference Source #

getEncodingExplode :: Encoding -> Maybe Bool Source #

setEncodingExplode :: Encoding -> Maybe Bool -> Encoding Source #

getSchemaReadOnly :: Schema -> Maybe Bool Source #

setSchemaReadOnly :: Schema -> Maybe Bool -> Schema Source #

getHeaderStyle :: Header -> Maybe Text Source #

setHeaderStyle :: Header -> Maybe Text -> Header Source #

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

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

data Header Source #

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

Constructors

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)

getOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text Source #

setOpenIdConnectSecuritySchemeType :: OpenIdConnectSecurityScheme -> Text -> OpenIdConnectSecurityScheme Source #

getPathItemDelete :: PathItem -> Maybe Operation Source #

setPathItemDelete :: PathItem -> Maybe Operation -> PathItem Source #

getSchemaEnum :: Schema -> Maybe [Value] Source #

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

getOpenAPIObjectOpenapi :: OpenAPIObject -> Text Source #

setOpenAPIObjectOpenapi :: OpenAPIObject -> Text -> OpenAPIObject Source #

getSchemaMinProperties :: Schema -> Maybe Int Source #

setSchemaMinProperties :: Schema -> Maybe Int -> Schema Source #

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

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

eitherBoolIntBool :: BoolInt -> Either BoolInt Bool Source #

getSchemaAllOf :: Schema -> Maybe [ReferenceOr Schema] Source #

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

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

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

getPathItemOptions :: PathItem -> Maybe Operation Source #

setPathItemOptions :: PathItem -> Maybe Operation -> PathItem Source #

eitherAdditionalBool :: Additionals -> Either Additionals Bool Source #

getOpenAPIObjectPaths :: OpenAPIObject -> HashMap Text PathItem Source #

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

getRequestBodyRequired :: RequestBody -> Maybe Bool Source #

setRequestBodyRequired :: RequestBody -> Maybe Bool -> RequestBody Source #

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

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

getSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation Source #

setSchemaExternalDocs :: Schema -> Maybe ExternalDocumentation -> Schema Source #

data Example Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Example -> Example -> Bool # (/=) :: Example -> Example -> Bool #
Show Example Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Example -> ShowS # show :: Example -> String # showList :: [Example] -> ShowS #
ToJSON Example Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Example -> Value # toEncoding :: Example -> Encoding # toJSONList :: [Example] -> Value # toEncodingList :: [Example] -> Encoding #
FromJSON Example Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Example # parseJSONList :: Value -> Parser [Example] #

eitherBoolIntInt :: BoolInt -> Either BoolInt Int Source #

data OAuth2SecurityScheme Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: OAuth2SecurityScheme -> OAuth2SecurityScheme -> Bool # (/=) :: OAuth2SecurityScheme -> OAuth2SecurityScheme -> Bool #
Show OAuth2SecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> OAuth2SecurityScheme -> ShowS # show :: OAuth2SecurityScheme -> String # showList :: [OAuth2SecurityScheme] -> ShowS #
ToJSON OAuth2SecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: OAuth2SecurityScheme -> Value # toEncoding :: OAuth2SecurityScheme -> Encoding # toJSONList :: [OAuth2SecurityScheme] -> Value # toEncodingList :: [OAuth2SecurityScheme] -> Encoding #
FromJSON OAuth2SecurityScheme Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser OAuth2SecurityScheme # parseJSONList :: Value -> Parser [OAuth2SecurityScheme] #

getSchemaAdditionalProperties :: Schema -> Maybe Additionals Source #

setSchemaAdditionalProperties :: Schema -> Maybe Additionals -> Schema Source #

eitherSecuritySchemaHTTPSS :: SecuritySchema -> Either SecuritySchema HTTPSecurityScheme Source #

data Server Source #

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 Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Server -> Server -> Bool # (/=) :: Server -> Server -> Bool #
Show Server Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Server -> ShowS # show :: Server -> String # showList :: [Server] -> ShowS #
ToJSON Server Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Server -> Value # toEncoding :: Server -> Encoding # toJSONList :: [Server] -> Value # toEncodingList :: [Server] -> Encoding #
FromJSON Server Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Server # parseJSONList :: Value -> Parser [Server] #

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

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

Eq Header Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Show Header Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
ToJSON Header Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods toJSON :: Header -> Value # toEncoding :: Header -> Encoding # toJSONList :: [Header] -> Value # toEncodingList :: [Header] -> Encoding #
FromJSON Header Source #
Instance details Defined in Data.OpenAPI.V3_0_0 Methods parseJSON :: Value -> Parser Header # parseJSONList :: Value -> Parser [Header] #