Safe Haskell	None
Language	Haskell2010

Data.Schema.OpenAPI.Types

Documentation

data Tag Source #

Constructors

Tag
Fields tagName :: Text tagDescription :: Text

Instances

Instances details

Show Tag Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToJSON Tag Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding # omitField :: Tag -> Bool #
FromJSON Tag Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] # omittedField :: Maybe Tag #

data Variable Source #

Constructors

Variable
Fields variableDescription :: Text variableDefault :: Text

Instances

Instances details

Show Variable Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Variable -> ShowS # show :: Variable -> String # showList :: [Variable] -> ShowS #
ToJSON Variable Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Variable -> Value # toEncoding :: Variable -> Encoding # toJSONList :: [Variable] -> Value # toEncodingList :: [Variable] -> Encoding # omitField :: Variable -> Bool #
FromJSON Variable Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Variable # parseJSONList :: Value -> Parser [Variable] # omittedField :: Maybe Variable #

data Server Source #

Constructors

Server
Fields serverUrl :: Text serverVariables :: Maybe (HashMap Text Variable)

Instances

Instances details

Show Server Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Server -> ShowS # show :: Server -> String # showList :: [Server] -> ShowS #
ToJSON Server Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Server -> Value # toEncoding :: Server -> Encoding # toJSONList :: [Server] -> Value # toEncodingList :: [Server] -> Encoding # omitField :: Server -> Bool #
FromJSON Server Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Server # parseJSONList :: Value -> Parser [Server] # omittedField :: Maybe Server #

data Url Source #

Constructors

Url
Fields urlDescription :: Text urlUrl :: Text

Instances

Instances details

Show Url Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Url -> ShowS # show :: Url -> String # showList :: [Url] -> ShowS #
ToJSON Url Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Url -> Value # toEncoding :: Url -> Encoding # toJSONList :: [Url] -> Value # toEncodingList :: [Url] -> Encoding # omitField :: Url -> Bool #
FromJSON Url Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Url # parseJSONList :: Value -> Parser [Url] # omittedField :: Maybe Url #

data NameUrl Source #

Constructors

NameUrl
Fields nameUrlName :: Text nameUrlUrl :: Text

Instances

Instances details

Show NameUrl Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> NameUrl -> ShowS # show :: NameUrl -> String # showList :: [NameUrl] -> ShowS #
ToJSON NameUrl Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: NameUrl -> Value # toEncoding :: NameUrl -> Encoding # toJSONList :: [NameUrl] -> Value # toEncodingList :: [NameUrl] -> Encoding # omitField :: NameUrl -> Bool #
FromJSON NameUrl Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser NameUrl # parseJSONList :: Value -> Parser [NameUrl] # omittedField :: Maybe NameUrl #

data Info Source #

Constructors

Info
Fields infoVersion :: Text infoTitle :: Text infoDescription :: Text infoLicense :: NameUrl infoTermsOfService :: Text infoContact :: NameUrl

Instances

Instances details

Show Info Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Info -> ShowS # show :: Info -> String # showList :: [Info] -> ShowS #
ToJSON Info Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Info -> Value # toEncoding :: Info -> Encoding # toJSONList :: [Info] -> Value # toEncodingList :: [Info] -> Encoding # omitField :: Info -> Bool #
FromJSON Info Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Info # parseJSONList :: Value -> Parser [Info] # omittedField :: Maybe Info #

data SchemaType Source #

Instances

Instances details

Show SchemaType Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaType -> ShowS # show :: SchemaType -> String # showList :: [SchemaType] -> ShowS #
ToJSON SchemaType Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: SchemaType -> Value # toEncoding :: SchemaType -> Encoding # toJSONList :: [SchemaType] -> Value # toEncodingList :: [SchemaType] -> Encoding # omitField :: SchemaType -> Bool #
FromJSON SchemaType Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser SchemaType # parseJSONList :: Value -> Parser [SchemaType] # omittedField :: Maybe SchemaType #

parseSingleSchema :: KeyMap Value -> Value -> Parser SchemaType Source #

parseInferredSchema :: KeyMap Value -> Maybe (Parser SchemaType) Source #

data SchemaCommon a example Source #

Constructors

SchemaCommon
Fields schemaCommonDescription :: Maybe Text schemaCommonTitle :: Maybe Text schemaCommonDefault :: Maybe a schemaCommonNullable :: Maybe Bool schemaCommonDeprecated :: Maybe Bool schemaCommonExample :: Maybe example schemaCommonReadOnly :: Maybe Bool

Instances

Instances details

(Show a, Show example) => Show (SchemaCommon a example) Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaCommon a example -> ShowS # show :: SchemaCommon a example -> String # showList :: [SchemaCommon a example] -> ShowS #

encodeCommon :: (ToJSON a, ToJSON example) => SchemaCommon a example -> [Pair] Source #

decodeCommon :: (FromJSON a, FromJSON example) => KeyMap Value -> Parser (SchemaCommon a example) Source #

data SchemaEmpty Source #

Constructors

SchemaEmpty
Fields schemaEmptyNullable :: Maybe Bool schemaEmptyRequired :: Maybe [Text]

Instances

Instances details

Show SchemaEmpty Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaEmpty -> ShowS # show :: SchemaEmpty -> String # showList :: [SchemaEmpty] -> ShowS #

data SchemaQuantifier Source #

Constructors

SchemaQuantifier
Fields schemaQuantifierCommon :: SchemaCommon Void Void schemaQuantifierSchemas :: [SchemaType]

Instances

Instances details

Show SchemaQuantifier Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaQuantifier -> ShowS # show :: SchemaQuantifier -> String # showList :: [SchemaQuantifier] -> ShowS #

parseQuantifier :: KeyMap Value -> Maybe (Parser SchemaType) Source #

data AdditionalProperties Source #

Constructors

AdditionalPropertiesBool Bool
AdditionalPropertiesSchema SchemaType

Instances

Instances details

Show AdditionalProperties Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> AdditionalProperties -> ShowS # show :: AdditionalProperties -> String # showList :: [AdditionalProperties] -> ShowS #
ToJSON AdditionalProperties Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: AdditionalProperties -> Value # toEncoding :: AdditionalProperties -> Encoding # toJSONList :: [AdditionalProperties] -> Value # toEncodingList :: [AdditionalProperties] -> Encoding # omitField :: AdditionalProperties -> Bool #
FromJSON AdditionalProperties Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser AdditionalProperties # parseJSONList :: Value -> Parser [AdditionalProperties] # omittedField :: Maybe AdditionalProperties #

data SchemaObject Source #

Constructors

SchemaObject
Fields schemaObjectCommon :: SchemaCommon Void Value schemaObjectProperties :: Maybe (HashMap Text SchemaType) schemaObjectAdditionalProperties :: Maybe AdditionalProperties schemaObjectMaxProperties :: Maybe Int schemaObjectRequired :: Maybe [Text] schemaObjectOneOf :: Maybe [SchemaType] schemaObjectAllOf :: Maybe [SchemaType] schemaObjectAnyOf :: Maybe [SchemaType]

Instances

Instances details

Show SchemaObject Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaObject -> ShowS # show :: SchemaObject -> String # showList :: [SchemaObject] -> ShowS #

data SchemaArray Source #

Constructors

SchemaArray
Fields schemaArrayCommon :: SchemaCommon [Value] Value schemaArrayItems :: SchemaType schemaArrayMinItems :: Maybe Int schemaArrayMaxItems :: Maybe Int schemaArrayRequired :: Maybe [Text]

Instances

Instances details

Show SchemaArray Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaArray -> ShowS # show :: SchemaArray -> String # showList :: [SchemaArray] -> ShowS #

data StringExample Source #

Constructors

StringExampleString Text
StringExampleArray [Text]

Instances

Instances details

Show StringExample Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> StringExample -> ShowS # show :: StringExample -> String # showList :: [StringExample] -> ShowS #
ToJSON StringExample Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: StringExample -> Value # toEncoding :: StringExample -> Encoding # toJSONList :: [StringExample] -> Value # toEncodingList :: [StringExample] -> Encoding # omitField :: StringExample -> Bool #
FromJSON StringExample Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser StringExample # parseJSONList :: Value -> Parser [StringExample] # omittedField :: Maybe StringExample #

data SchemaString Source #

Constructors

SchemaString
Fields schemaStringCommon :: SchemaCommon Text StringExample schemaStringEnum :: Maybe [Text] schemaStringFormat :: Maybe Text schemaStringPattern :: Maybe Text schemaStringMinLength :: Maybe Int schemaStringMaxLength :: Maybe Int schemaStringAdditionalProperties :: Maybe Bool schemaStringMinItems :: Maybe Int

Instances

Instances details

Show SchemaString Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaString -> ShowS # show :: SchemaString -> String # showList :: [SchemaString] -> ShowS #

newtype SchemaBoolean Source #

Constructors

SchemaBoolean
Fields schemaBooleanCommon :: SchemaCommon Bool Bool

Instances

Instances details

Show SchemaBoolean Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaBoolean -> ShowS # show :: SchemaBoolean -> String # showList :: [SchemaBoolean] -> ShowS #

data SchemaNumber int Source #

Constructors

SchemaNumber
Fields schemaNumberCommon :: SchemaCommon int int schemaNumberFormat :: Maybe Text schemaNumberMinimum :: Maybe int schemaNumberMaximum :: Maybe int

Instances

Instances details

Show int => Show (SchemaNumber int) Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> SchemaNumber int -> ShowS # show :: SchemaNumber int -> String # showList :: [SchemaNumber int] -> ShowS #

data Content Source #

Constructors

Content
Fields contentSchema :: SchemaType contentExamples :: Maybe (HashMap Text Value)

Instances

Instances details

Show Content Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Content -> ShowS # show :: Content -> String # showList :: [Content] -> ShowS #
ToJSON Content Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Content -> Value # toEncoding :: Content -> Encoding # toJSONList :: [Content] -> Value # toEncodingList :: [Content] -> Encoding # omitField :: Content -> Bool #
FromJSON Content Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Content # parseJSONList :: Value -> Parser [Content] # omittedField :: Maybe Content #

data Header Source #

Constructors

Header
Fields headerExample :: Maybe Value headerSchema :: Maybe SchemaType

Instances

data Response Source #

Constructors

Response
Fields responseDescription :: Maybe Text responseContent :: Maybe (HashMap Text Content) responseHeaders :: Maybe (HashMap Text Header)

Instances

Instances details

Show Response Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
ToJSON Response Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Response -> Value # toEncoding :: Response -> Encoding # toJSONList :: [Response] -> Value # toEncodingList :: [Response] -> Encoding # omitField :: Response -> Bool #
FromJSON Response Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Response # parseJSONList :: Value -> Parser [Response] # omittedField :: Maybe Response #

data Request Source #

Constructors

Request
Fields requestContent :: HashMap Text Content requestDescription :: Maybe Text requestRequired :: Maybe Bool

Instances

Instances details

Show Request Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
ToJSON Request Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Request -> Value # toEncoding :: Request -> Encoding # toJSONList :: [Request] -> Value # toEncodingList :: [Request] -> Encoding # omitField :: Request -> Bool #
FromJSON Request Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Request # parseJSONList :: Value -> Parser [Request] # omittedField :: Maybe Request #

data Parameter Source #

Constructors

Parameter
Fields parameterDescription :: Maybe Text parameterIn :: Text parameterName :: Text parameterExample :: Maybe Value parameterExamples :: Maybe (HashMap Text Value) parameterSchema :: SchemaType parameterRequired :: Maybe Bool parameterDeprecated :: Maybe Bool

Instances

Instances details

Show Parameter Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
ToJSON Parameter Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Parameter -> Value # toEncoding :: Parameter -> Encoding # toJSONList :: [Parameter] -> Value # toEncodingList :: [Parameter] -> Encoding # omitField :: Parameter -> Bool #
FromJSON Parameter Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Parameter # parseJSONList :: Value -> Parser [Parameter] # omittedField :: Maybe Parameter #

data Method Source #

Constructors

Method
Fields methodSummary :: Text methodServers :: Maybe [Server] methodDescription :: Maybe Text methodDeprecated :: Maybe Bool methodExternalDocs :: Maybe Url methodTags :: [Text] methodOperationId :: Text methodParameters :: Maybe [Parameter] methodResponses :: HashMap Text Response methodRequestBody :: Maybe Request

Instances

Instances details

Show Method Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
ToJSON Method Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Method -> Value # toEncoding :: Method -> Encoding # toJSONList :: [Method] -> Value # toEncodingList :: [Method] -> Encoding # omitField :: Method -> Bool #
FromJSON Method Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] # omittedField :: Maybe Method #

data Path Source #

Constructors

Path
Fields pathGet :: Maybe Method pathPost :: Maybe Method pathDelete :: Maybe Method pathPatch :: Maybe Method pathPut :: Maybe Method

Instances

Instances details

Show Path Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
ToJSON Path Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Path -> Value # toEncoding :: Path -> Encoding # toJSONList :: [Path] -> Value # toEncodingList :: [Path] -> Encoding # omitField :: Path -> Bool #
FromJSON Path Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Path # parseJSONList :: Value -> Parser [Path] # omittedField :: Maybe Path #

data Spec Source #

Constructors

Spec
Fields specOpenapi :: Text specInfo :: Info specTags :: [Tag] specServers :: [Server] specExternalDocs :: Url specPaths :: HashMap Text Path

Instances

Instances details

Show Spec Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Spec -> ShowS # show :: Spec -> String # showList :: [Spec] -> ShowS #
ToJSON Spec Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Spec -> Value # toEncoding :: Spec -> Encoding # toJSONList :: [Spec] -> Value # toEncodingList :: [Spec] -> Encoding # omitField :: Spec -> Bool #
FromJSON Spec Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Spec # parseJSONList :: Value -> Parser [Spec] # omittedField :: Maybe Spec #

resolveRef :: Text -> Value -> Value Source #

resolveRefsWith :: Value -> Value -> Value Source #

resolveRefs :: Value -> Value Source #

parseSpec :: Value -> Either String Spec Source #

removeNulls :: ToJSON a => a -> Value Source #

SchemaTypeEmpty SchemaEmpty
SchemaTypeObject SchemaObject
SchemaTypeArray SchemaArray
SchemaTypeString SchemaString
SchemaTypeBoolean SchemaBoolean
SchemaTypeInteger (SchemaNumber Int)
SchemaTypeNumber (SchemaNumber Scientific)
SchemaTypeAllOf SchemaQuantifier
SchemaTypeOneOf SchemaQuantifier
SchemaTypeAnyOf SchemaQuantifier

Show Header Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
ToJSON Header Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods toJSON :: Header -> Value # toEncoding :: Header -> Encoding # toJSONList :: [Header] -> Value # toEncodingList :: [Header] -> Encoding # omitField :: Header -> Bool #
FromJSON Header Source #
Instance details Defined in Data.Schema.OpenAPI.Types Methods parseJSON :: Value -> Parser Header # parseJSONList :: Value -> Parser [Header] # omittedField :: Maybe Header #