Safe Haskell	None
Language	Haskell2010

OpenAPI.Generate.Types.Schema

Contents

Orphan instances

Description

This module specifies the data types from the OpenAPI specification 3.0.3 Schema

For more information see http://spec.openapis.org/oas/v3.0.3 and https://json-schema.org/

All names in this module correspond to the respective OpenAPI types

Documentation

type Schema = Referencable SchemaObject Source #

data SchemaObject Source #

Constructors

SchemaObject

Fields

type' :: SchemaType
title :: Maybe Text
multipleOf :: Maybe Integer
maximum :: Maybe Float
exclusiveMaximum :: Bool
minimum :: Maybe Float
exclusiveMinimum :: Bool
maxLength :: Maybe Word
minLength :: Maybe Word
pattern' :: Maybe Text
maxItems :: Maybe Word
minItems :: Maybe Word
uniqueItems :: Bool
maxProperties :: Maybe Word
minProperties :: Maybe Word
required :: Set Text
enum :: Set Value
allOf :: Set Schema
oneOf :: Set Schema
anyOf :: Set Schema
not :: Maybe Schema
properties :: Map Text Schema
additionalProperties :: AdditionalProperties
description :: Maybe Text
format :: Maybe Text
default' :: Maybe ConcreteValue
nullable :: Bool
discriminator :: Maybe DiscriminatorObject
readOnly :: Bool
writeOnly :: Bool
xml :: Maybe XMLObject
externalDocs :: Maybe ExternalDocumentationObject
example :: Maybe Value
deprecated :: Bool
items :: Maybe Schema

Instances

Eq SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: SchemaObject -> SchemaObject -> Bool # (/=) :: SchemaObject -> SchemaObject -> Bool #
Ord SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: SchemaObject -> SchemaObject -> Ordering # (<) :: SchemaObject -> SchemaObject -> Bool # (<=) :: SchemaObject -> SchemaObject -> Bool # (>) :: SchemaObject -> SchemaObject -> Bool # (>=) :: SchemaObject -> SchemaObject -> Bool # max :: SchemaObject -> SchemaObject -> SchemaObject # min :: SchemaObject -> SchemaObject -> SchemaObject #
Show SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> SchemaObject -> ShowS # show :: SchemaObject -> String # showList :: [SchemaObject] -> ShowS #
Generic SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep SchemaObject :: Type -> Type # Methods from :: SchemaObject -> Rep SchemaObject x # to :: Rep SchemaObject x -> SchemaObject #
FromJSON SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser SchemaObject # parseJSONList :: Value -> Parser [SchemaObject] #
type Rep SchemaObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep SchemaObject = D1 (MetaData "SchemaObject" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) (C1 (MetaCons "SchemaObject" PrefixI True) (((((S1 (MetaSel (Just "type'") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SchemaType) :: S1 (MetaSel (Just "title") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "multipleOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :: S1 (MetaSel (Just "maximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Float)))) :: ((S1 (MetaSel (Just "exclusiveMaximum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "minimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Float))) :: (S1 (MetaSel (Just "exclusiveMinimum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "maxLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word))))) :: (((S1 (MetaSel (Just "minLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word)) :: S1 (MetaSel (Just "pattern'") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "maxItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word)) :: S1 (MetaSel (Just "minItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word)))) :: ((S1 (MetaSel (Just "uniqueItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "maxProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word))) :: (S1 (MetaSel (Just "minProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word)) :: (S1 (MetaSel (Just "required") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Text)) :: S1 (MetaSel (Just "enum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Value))))))) :: ((((S1 (MetaSel (Just "allOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Schema)) :: S1 (MetaSel (Just "oneOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Schema))) :: (S1 (MetaSel (Just "anyOf") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Schema)) :: S1 (MetaSel (Just "not") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Schema)))) :: ((S1 (MetaSel (Just "properties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Schema)) :: S1 (MetaSel (Just "additionalProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AdditionalProperties)) :: (S1 (MetaSel (Just "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "format") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "default'") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ConcreteValue)))))) :: (((S1 (MetaSel (Just "nullable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "discriminator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe DiscriminatorObject))) :: (S1 (MetaSel (Just "readOnly") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "writeOnly") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: ((S1 (MetaSel (Just "xml") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe XMLObject)) :: S1 (MetaSel (Just "externalDocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ExternalDocumentationObject))) :: (S1 (MetaSel (Just "example") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Value)) :: (S1 (MetaSel (Just "deprecated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "items") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Schema)))))))))

data SchemaType Source #

Constructors

SchemaTypeString
SchemaTypeNumber
SchemaTypeInteger
SchemaTypeBool
SchemaTypeObject
SchemaTypeArray

Instances

Eq SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: SchemaType -> SchemaType -> Bool # (/=) :: SchemaType -> SchemaType -> Bool #
Ord SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: SchemaType -> SchemaType -> Ordering # (<) :: SchemaType -> SchemaType -> Bool # (<=) :: SchemaType -> SchemaType -> Bool # (>) :: SchemaType -> SchemaType -> Bool # (>=) :: SchemaType -> SchemaType -> Bool # max :: SchemaType -> SchemaType -> SchemaType # min :: SchemaType -> SchemaType -> SchemaType #
Show SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> SchemaType -> ShowS # show :: SchemaType -> String # showList :: [SchemaType] -> ShowS #
Generic SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep SchemaType :: Type -> Type # Methods from :: SchemaType -> Rep SchemaType x # to :: Rep SchemaType x -> SchemaType #
FromJSON SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser SchemaType # parseJSONList :: Value -> Parser [SchemaType] #
type Rep SchemaType Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep SchemaType = D1 (MetaData "SchemaType" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) ((C1 (MetaCons "SchemaTypeString" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SchemaTypeNumber" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SchemaTypeInteger" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "SchemaTypeBool" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SchemaTypeObject" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SchemaTypeArray" PrefixI False) (U1 :: Type -> Type))))

data DiscriminatorObject Source #

Constructors

DiscriminatorObject
Fields propertyName :: Text mapping :: Map Text Text

Instances

Eq DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: DiscriminatorObject -> DiscriminatorObject -> Bool # (/=) :: DiscriminatorObject -> DiscriminatorObject -> Bool #
Ord DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: DiscriminatorObject -> DiscriminatorObject -> Ordering # (<) :: DiscriminatorObject -> DiscriminatorObject -> Bool # (<=) :: DiscriminatorObject -> DiscriminatorObject -> Bool # (>) :: DiscriminatorObject -> DiscriminatorObject -> Bool # (>=) :: DiscriminatorObject -> DiscriminatorObject -> Bool # max :: DiscriminatorObject -> DiscriminatorObject -> DiscriminatorObject # min :: DiscriminatorObject -> DiscriminatorObject -> DiscriminatorObject #
Show DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> DiscriminatorObject -> ShowS # show :: DiscriminatorObject -> String # showList :: [DiscriminatorObject] -> ShowS #
Generic DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep DiscriminatorObject :: Type -> Type # Methods from :: DiscriminatorObject -> Rep DiscriminatorObject x # to :: Rep DiscriminatorObject x -> DiscriminatorObject #
FromJSON DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser DiscriminatorObject # parseJSONList :: Value -> Parser [DiscriminatorObject] #
type Rep DiscriminatorObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep DiscriminatorObject = D1 (MetaData "DiscriminatorObject" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) (C1 (MetaCons "DiscriminatorObject" PrefixI True) (S1 (MetaSel (Just "propertyName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "mapping") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Text))))

data ConcreteValue Source #

Constructors

StringDefaultValue Text
NumericDefaultValue Scientific
BoolDefaultValue Bool
OtherDefaultValue Value

Instances

Eq ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: ConcreteValue -> ConcreteValue -> Bool # (/=) :: ConcreteValue -> ConcreteValue -> Bool #
Ord ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: ConcreteValue -> ConcreteValue -> Ordering # (<) :: ConcreteValue -> ConcreteValue -> Bool # (<=) :: ConcreteValue -> ConcreteValue -> Bool # (>) :: ConcreteValue -> ConcreteValue -> Bool # (>=) :: ConcreteValue -> ConcreteValue -> Bool # max :: ConcreteValue -> ConcreteValue -> ConcreteValue # min :: ConcreteValue -> ConcreteValue -> ConcreteValue #
Show ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> ConcreteValue -> ShowS # show :: ConcreteValue -> String # showList :: [ConcreteValue] -> ShowS #
Generic ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep ConcreteValue :: Type -> Type # Methods from :: ConcreteValue -> Rep ConcreteValue x # to :: Rep ConcreteValue x -> ConcreteValue #
FromJSON ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser ConcreteValue # parseJSONList :: Value -> Parser [ConcreteValue] #
type Rep ConcreteValue Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep ConcreteValue = D1 (MetaData "ConcreteValue" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) ((C1 (MetaCons "StringDefaultValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "NumericDefaultValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Scientific))) :+: (C1 (MetaCons "BoolDefaultValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :+: C1 (MetaCons "OtherDefaultValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Value))))

data AdditionalProperties Source #

Constructors

NoAdditionalProperties
HasAdditionalProperties
AdditionalPropertiesWithSchema Schema

Instances

Eq AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: AdditionalProperties -> AdditionalProperties -> Bool # (/=) :: AdditionalProperties -> AdditionalProperties -> Bool #
Ord AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: AdditionalProperties -> AdditionalProperties -> Ordering # (<) :: AdditionalProperties -> AdditionalProperties -> Bool # (<=) :: AdditionalProperties -> AdditionalProperties -> Bool # (>) :: AdditionalProperties -> AdditionalProperties -> Bool # (>=) :: AdditionalProperties -> AdditionalProperties -> Bool # max :: AdditionalProperties -> AdditionalProperties -> AdditionalProperties # min :: AdditionalProperties -> AdditionalProperties -> AdditionalProperties #
Show AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> AdditionalProperties -> ShowS # show :: AdditionalProperties -> String # showList :: [AdditionalProperties] -> ShowS #
Generic AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep AdditionalProperties :: Type -> Type # Methods from :: AdditionalProperties -> Rep AdditionalProperties x # to :: Rep AdditionalProperties x -> AdditionalProperties #
FromJSON AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser AdditionalProperties # parseJSONList :: Value -> Parser [AdditionalProperties] #
type Rep AdditionalProperties Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep AdditionalProperties = D1 (MetaData "AdditionalProperties" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) (C1 (MetaCons "NoAdditionalProperties" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "HasAdditionalProperties" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "AdditionalPropertiesWithSchema" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Schema))))

data XMLObject Source #

Constructors

XMLObject
Fields name :: Maybe Text namespace :: Maybe Text prefix :: Maybe Text attribute :: Bool wrapped :: Bool

Instances

Eq XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods (==) :: XMLObject -> XMLObject -> Bool # (/=) :: XMLObject -> XMLObject -> Bool #
Ord XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods compare :: XMLObject -> XMLObject -> Ordering # (<) :: XMLObject -> XMLObject -> Bool # (<=) :: XMLObject -> XMLObject -> Bool # (>) :: XMLObject -> XMLObject -> Bool # (>=) :: XMLObject -> XMLObject -> Bool # max :: XMLObject -> XMLObject -> XMLObject # min :: XMLObject -> XMLObject -> XMLObject #
Show XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods showsPrec :: Int -> XMLObject -> ShowS # show :: XMLObject -> String # showList :: [XMLObject] -> ShowS #
Generic XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Associated Types type Rep XMLObject :: Type -> Type # Methods from :: XMLObject -> Rep XMLObject x # to :: Rep XMLObject x -> XMLObject #
FromJSON XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema Methods parseJSON :: Value -> Parser XMLObject # parseJSONList :: Value -> Parser [XMLObject] #
type Rep XMLObject Source #
Instance details Defined in OpenAPI.Generate.Types.Schema type Rep XMLObject = D1 (MetaData "XMLObject" "OpenAPI.Generate.Types.Schema" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) (C1 (MetaCons "XMLObject" PrefixI True) ((S1 (MetaSel (Just "name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "namespace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "attribute") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "wrapped") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

Orphan instances

Ord Value Source #
Instance details Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #