Module

OpenApi3.Schema

Package: purescript-openapi3
Repository: AlexMouton/purescript-openapi3

#Callback Source

newtype Callback

Constructors

Callback (Map String PathItem)

Instances

#Components Source

newtype Components

Constructors

Components { callbacks :: Maybe (Map String (Refable Callback)), examples :: Maybe (Map String (Refable Example)), headers :: Maybe (Map String (Refable Header)), links :: Maybe (Map String (Refable Link)), parameters :: Maybe (Map String (Refable Parameter)), requestBodies :: Maybe (Map String (Refable RequestBody)), responses :: Maybe (Map String (Refable Response)), schemas :: Maybe (Map String (Refable Schema)), securitySchemes :: Maybe (Map String (Refable SecurityScheme)) }

Instances

#Contact Source

newtype Contact

Constructors

Contact { email :: Maybe String, name :: Maybe String, url :: Maybe String }

Instances

#Discriminator Source

newtype Discriminator

Constructors

Discriminator { mapping :: Maybe (Map String String), propertyName :: String }

Instances

#Example Source

newtype Example

Constructors

Example { description :: Maybe String, externalValue :: Maybe String, summary :: Maybe String, value :: Maybe String }

Instances

#ExternalDocumentation Source

newtype ExternalDocumentation

Constructors

ExternalDocumentation { description :: Maybe String, url :: String }

Instances

#Header Source

newtype Header

Constructors

Header { allowEmptyValue :: Maybe Boolean, allowReserved :: Maybe Boolean, content :: Maybe (Map String MediaType), deprecated :: Maybe Boolean, description :: Maybe String, example :: Maybe Json, examples :: Maybe (Map String (Refable Example)), explode :: Maybe Boolean, required :: Maybe Boolean, schema :: Maybe (Refable Schema), style :: Maybe String }

Instances

#Info Source

newtype Info

Constructors

Info { contact :: Maybe Contact, description :: Maybe String, license :: Maybe License, termsOfService :: Maybe String, title :: String, version :: String }

Instances

#License Source

newtype License

Constructors

License { name :: String, url :: Maybe String }

Instances

#Link Source

newtype Link

Constructors

Link { description :: Maybe String, operationId :: Maybe String, operationRef :: Maybe String, parameters :: Maybe (Map String Json), requestBody :: Maybe Json, server :: Maybe Server }

Instances

#MediaType Source

newtype MediaType

Constructors

MediaType { encoding :: Maybe (Map String Encoding), example :: Maybe Json, examples :: Maybe (Map String (Refable Example)), schema :: Maybe (Refable Schema) }

Instances

#Encoding Source

newtype Encoding

Constructors

Encoding { allowReserved :: Maybe Boolean, contentType :: Maybe String, explode :: Maybe Boolean, headers :: Maybe (Map String (Refable Header)), style :: Maybe String }

Instances

#OAuthFlow Source

newtype OAuthFlow

Constructors

OAuthFlow { authorizationUrl :: String, refreshUrl :: Maybe String, scopes :: Map String String, tokenUrl :: String }

Instances

#OAuthFlows Source

newtype OAuthFlows

Constructors

OAuthFlows { authorizationCode :: Maybe OAuthFlow, clientCredentials :: Maybe OAuthFlow, implicit :: Maybe OAuthFlow, password :: Maybe OAuthFlow }

Instances

#OpenApi Source

newtype OpenApi

Constructors

OpenApi { components :: Maybe Components, externalDocs :: Maybe ExternalDocumentation, info :: Info, openapi :: String, paths :: Paths, security :: Maybe (Array SecurityRequirement), servers :: Maybe (Array Server), tags :: Maybe (Array Tag) }

Instances

#Operation Source

newtype Operation

Constructors

Operation { callbacks :: Maybe (Map String (Refable Callback)), deprecated :: Maybe Boolean, description :: Maybe String, externalDocs :: Maybe ExternalDocumentation, operationId :: Maybe String, parameters :: Maybe (Array (Refable Parameter)), requestBody :: Maybe (Refable RequestBody), responses :: Responses, security :: Maybe (Array SecurityRequirement), servers :: Maybe (Array Server), summary :: Maybe String, tags :: Maybe (Array String) }

Instances

#Parameter Source

newtype Parameter

Constructors

Parameter { allowEmptyValue :: Maybe Boolean, allowReserved :: Maybe Boolean, content :: Maybe (Map String MediaType), deprecated :: Maybe Boolean, description :: Maybe String, example :: Maybe Json, examples :: Maybe (Map String (Refable Example)), explode :: Maybe Boolean, in :: String, name :: String, required :: Maybe Boolean, schema :: Maybe (Refable Schema), style :: Maybe String }

Instances

#PathItem Source

newtype PathItem

Constructors

PathItem { "$ref" :: Maybe String, delete :: Maybe Operation, description :: Maybe String, get :: Maybe Operation, head :: Maybe Operation, options :: Maybe Operation, parameters :: Maybe (Array (Refable Parameter)), patch :: Maybe Operation, post :: Maybe Operation, put :: Maybe Operation, servers :: Maybe (Array Server), summary :: Maybe String, trace :: Maybe Operation }

Instances

#Paths Source

newtype Paths

Constructors

Paths (Map String PathItem)

Instances

#RequestBody Source

newtype RequestBody

Constructors

RequestBody { content :: Map String MediaType, description :: Maybe String, required :: Maybe Boolean }

Instances

#Response Source

newtype Response

Constructors

Response { content :: Maybe (Map String MediaType), description :: String, headers :: Maybe (Map String (Refable Header)), links :: Maybe (Map String (Refable Link)) }

Instances

#Responses Source

newtype Responses

Constructors

Responses (Map String (Refable Response))

Instances

#Schema Source

newtype Schema

Constructors

Schema { allOf :: Maybe (Array (Refable Schema)), anyOf :: Maybe (Array (Refable Schema)), deprecated :: Maybe Boolean, discriminator :: Maybe Discriminator, example :: Maybe Json, exclusiveMaximum :: Maybe Number, exclusiveMinimum :: Maybe Number, externalDocs :: Maybe ExternalDocumentation, items :: Maybe (Refable Schema), maxItems :: Maybe Int, maxLength :: Maybe Int, maxProperties :: Maybe Int, maximum :: Maybe Number, minItems :: Maybe Int, minLength :: Maybe Int, minProperties :: Maybe Int, minimum :: Maybe Number, multipleOf :: Maybe String, not :: Maybe (Refable Schema), nullable :: Maybe Boolean, oneOf :: Maybe (Array (Refable Schema)), pattern :: Maybe String, properties :: Maybe (Refable Schema), readOnly :: Maybe Boolean, required :: Maybe (Array String), title :: Maybe String, type :: Maybe String, writeOnly :: Maybe Boolean, xml :: Maybe Xml }

Instances

#SecurityScheme Source

newtype SecurityScheme

Constructors

SecurityScheme { bearerFormat :: Maybe String, description :: Maybe String, flows :: Maybe OAuthFlows, location :: Maybe String, name :: Maybe String, openIdConnectUrl :: Maybe String, scheme :: Maybe String, ty :: String }

Instances

#Server Source

newtype Server

Constructors

Server { description :: Maybe String, url :: String, variables :: Maybe (Map String ServerVariable) }

Instances

#ServerVariable Source

newtype ServerVariable

Constructors

ServerVariable { default :: String, description :: Maybe String, enum :: Maybe (Array String) }

Instances

#Tag Source

newtype Tag

Constructors

Tag { description :: Maybe String, externalDocs :: Maybe ExternalDocumentation, name :: String }

Instances

#Xml Source

newtype Xml

Constructors

Xml { attribute :: Maybe Boolean, name :: Maybe String, namespace :: Maybe String, prefix :: Maybe String, wrapped :: Maybe Boolean }

Instances

Modules: Main; OpenApi3.Schema; OpenApi3.Schema.Map; OpenApi3.Schema.Refable; OpenApi3.Schema.Reference; OpenApi3.Schema.SecurityRequirement; Yml