Module

Data.OpenAPI.V300

Package
purescript-openapi
Repository
meeshkan/purescript-openapi

#T_Header Source

type T_Header = { _allowEmptyValue :: Maybe Boolean, _allowReserved :: Maybe Boolean, _content :: Maybe (OAIMap MediaType), _deprecated :: Maybe Boolean, _description :: Maybe String, _example :: Maybe JSON, _examples :: Maybe (OAIMap (ReferenceOr Example)), _explode :: Maybe Boolean, _required :: Maybe Boolean, _schema :: Maybe (ReferenceOr Schema), _style :: Maybe String, _x :: Maybe (OAIMap JSON) }

Header

#T_ClientCredentialsFlow Source

type T_ClientCredentialsFlow = { _refreshUrl :: Maybe String, _scopes :: Maybe (OAIMap String), _tokenUrl :: String, _x :: Maybe (OAIMap JSON) }

ClientCredentialsFlow

#T_AuthorizationCodeOAuthFlow Source

type T_AuthorizationCodeOAuthFlow = { _authorizationUrl :: String, _refreshUrl :: Maybe String, _scopes :: Maybe (OAIMap String), _tokenUrl :: String, _x :: Maybe (OAIMap JSON) }

AuthorizationCodeOAuthFlow

#T_ImplicitOAuthFlow Source

type T_ImplicitOAuthFlow = { _authorizationUrl :: String, _refreshUrl :: Maybe String, _scopes :: OAIMap String, _x :: Maybe (OAIMap JSON) }

ImplicitOAuthFlow

#T_HTTPSecurityScheme Source

type T_HTTPSecurityScheme = { _bearerFormat :: Maybe String, _description :: Maybe String, _scheme :: String, _type :: String, _x :: Maybe (OAIMap JSON) }

HTTPSecurityScheme

#T_RequestBody Source

type T_RequestBody = { _content :: OAIMap MediaType, _description :: Maybe String, _required :: Maybe Boolean, _x :: Maybe (OAIMap JSON) }

RequestBody

#T_APIKeySecurityScheme Source

type T_APIKeySecurityScheme = { _description :: Maybe String, _in :: String, _name :: String, _type :: String, _x :: Maybe (OAIMap JSON) }

APIKeySecurityScheme

#T_Response Source

type T_Response = { _content :: Maybe (OAIMap MediaType), _description :: String, _headers :: Maybe (OAIMap (ReferenceOr Header)), _links :: Maybe (OAIMap (ReferenceOr Link)), _x :: Maybe (OAIMap JSON) }

Response

#T_Encoding Source

type T_Encoding = { _allowReserved :: Maybe Boolean, _contentType :: Maybe String, _explode :: Maybe Boolean, _headers :: Maybe (OAIMap Header), _style :: Maybe String, _x :: Maybe (OAIMap JSON) }

Encoding

#T_ServerVariable Source

type T_ServerVariable = { _default :: String, _description :: Maybe String, _enum :: Maybe (Array String), _x :: Maybe (OAIMap JSON) }

ServerVariable

#_RealDeal Source

_RealDeal :: forall a. Tuple (a -> ReferenceOr a) (ReferenceOr a -> Maybe a)

#T_Schema Source

type T_Schema = { _additionalProperties :: Maybe Additionals, _allOf :: Maybe (Array (ReferenceOr Schema)), _anyOf :: Maybe (Array (ReferenceOr Schema)), _default :: Maybe JSON, _deprecated :: Maybe Boolean, _description :: Maybe String, _discriminator :: Maybe Discriminator, _enum :: Maybe (Array JSON), _example :: Maybe JSON, _exclusiveMaximum :: Maybe BooleanInt, _exclusiveMinimum :: Maybe BooleanInt, _externalDocs :: Maybe ExternalDocumentation, _format :: Maybe String, _items :: Maybe Items, _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 Number, _not :: Maybe (ReferenceOr Schema), _nullable :: Maybe Boolean, _oneOf :: Maybe (Array (ReferenceOr Schema)), _pattern :: Maybe String, _properties :: Maybe (OAIMap (ReferenceOr Schema)), _readOnly :: Maybe Boolean, _required :: Maybe (Array String), _title :: Maybe String, _type :: Maybe String, _uniqueItems :: Maybe Boolean, _writeOnly :: Maybe Boolean, _x :: Maybe (OAIMap JSON), _xml :: Maybe XML }

Schema

#T_Example Source

type T_Example = { _description :: Maybe String, _externalValue :: Maybe String, _summary :: Maybe String, _value :: Maybe JSON, _x :: Maybe (OAIMap JSON) }

Example

#T_Reference Source

type T_Reference = { _ref :: String, _x :: Maybe (OAIMap JSON) }

Reference

#T_PathItem Source

type T_PathItem = { _delete :: Maybe Operation, _description :: Maybe String, _get :: Maybe Operation, _head :: Maybe Operation, _options :: Maybe Operation, _parameters :: Maybe (Array (ReferenceOr Parameter)), _patch :: Maybe Operation, _post :: Maybe Operation, _put :: Maybe Operation, _ref :: Maybe String, _servers :: Maybe (Array Server), _summary :: Maybe String, _trace :: Maybe Operation, _x :: Maybe (OAIMap JSON) }

PathItem

#OAIMap Source

newtype OAIMap b

Constructors

Instances

#T_Info Source

type T_Info = { _contact :: Maybe Contact, _description :: Maybe String, _license :: Maybe License, _termsOfService :: Maybe String, _title :: String, _version :: String, _x :: Maybe (OAIMap JSON) }

Info

#T_Server Source

type T_Server = { _description :: Maybe String, _url :: String, _variables :: Maybe (OAIMap ServerVariable), _x :: Maybe (OAIMap JSON) }

Server

#T_Components Source

type T_Components = { _callbacks :: Maybe (OAIMap (ReferenceOr (OAIMap PathItem))), _examples :: Maybe (OAIMap (ReferenceOr Example)), _headers :: Maybe (OAIMap (ReferenceOr Header)), _links :: Maybe (OAIMap (ReferenceOr Link)), _parameters :: Maybe (OAIMap (ReferenceOr Parameter)), _requestBodies :: Maybe (OAIMap (ReferenceOr RequestBody)), _responses :: Maybe (OAIMap (ReferenceOr Response)), _schemas :: Maybe (OAIMap (ReferenceOr Schema)), _securitySchemes :: Maybe (OAIMap SecuritySchema), _x :: Maybe (OAIMap JSON) }

Components

#T_Tag Source

type T_Tag = { _description :: Maybe String, _externalDocs :: Maybe ExternalDocumentation, _name :: String, _x :: Maybe (OAIMap JSON) }

Tag

#T_PasswordOAuthFlow Source

type T_PasswordOAuthFlow = { _refreshUrl :: Maybe String, _scopes :: Maybe (OAIMap String), _tokenUrl :: String, _x :: Maybe (OAIMap JSON) }

PasswordOAuthFlow

#_OAIMap Source

_OAIMap :: forall b. Tuple (Map String b -> OAIMap b) (OAIMap b -> Maybe (Map String b))

#T_XML Source

type T_XML = { _attribute :: Maybe Boolean, _name :: Maybe String, _namespace :: Maybe String, _prefix :: Maybe String, _wrapped :: Maybe Boolean, _x :: Maybe (OAIMap JSON) }

XML

#T_License Source

type T_License = { _name :: String, _url :: Maybe String, _x :: Maybe (OAIMap JSON) }

License

#T_Discriminator Source

type T_Discriminator = { _mapping :: Maybe (OAIMap String), _propertyName :: String, _x :: Maybe (OAIMap JSON) }

Discriminator

#T_Parameter Source

type T_Parameter = { _allowEmptyValue :: Maybe Boolean, _allowReserved :: Maybe Boolean, _content :: Maybe (OAIMap MediaType), _deprecated :: Maybe Boolean, _description :: Maybe String, _example :: Maybe JSON, _examples :: Maybe (OAIMap (ReferenceOr Example)), _explode :: Maybe Boolean, _in :: String, _name :: String, _required :: Maybe Boolean, _schema :: Maybe (ReferenceOr Schema), _style :: Maybe String, _x :: Maybe (OAIMap JSON) }

Parameter

#T_OpenAPIObject Source

type T_OpenAPIObject = { _components :: Maybe Components, _externalDocs :: Maybe ExternalDocumentation, _info :: Info, _openapi :: String, _paths :: OAIMap PathItem, _security :: Maybe (Array (OAIMap (Array String))), _servers :: Maybe (Array Server), _tags :: Maybe (Array Tag), _x :: Maybe (OAIMap JSON) }

OpenAPIObject

#T_OpenIdConnectSecurityScheme Source

type T_OpenIdConnectSecurityScheme = { _description :: Maybe String, _openIdConnectUrl :: String, _type :: String, _x :: Maybe (OAIMap JSON) }

OpenIdConnectSecurityScheme

#T_MediaType Source

type T_MediaType = { _encoding :: Maybe (OAIMap Encoding), _example :: Maybe JSON, _examples :: Maybe (OAIMap (ReferenceOr Example)), _schema :: Maybe (ReferenceOr Schema), _x :: Maybe (OAIMap JSON) }

MediaType

#T_OAuthFlows Source

type T_OAuthFlows = { _authorizationCode :: Maybe AuthorizationCodeOAuthFlow, _clientCredentials :: Maybe ClientCredentialsFlow, _implicit :: Maybe ImplicitOAuthFlow, _password :: Maybe PasswordOAuthFlow, _x :: Maybe (OAIMap JSON) }

OAuthFlows

#T_Contact Source

type T_Contact = { _email :: Maybe String, _name :: Maybe String, _url :: Maybe String, _x :: Maybe (OAIMap JSON) }

Contact

#T_ExternalDocumentation Source

type T_ExternalDocumentation = { _description :: Maybe String, _url :: String, _x :: Maybe (OAIMap JSON) }

ExternalDocumentation

#T_Operation Source

type T_Operation = { _callbacks :: Maybe (OAIMap (ReferenceOr (OAIMap PathItem))), _deprecated :: Maybe Boolean, _description :: Maybe String, _externalDocs :: Maybe ExternalDocumentation, _operationId :: Maybe String, _parameters :: Maybe (Array (ReferenceOr Parameter)), _requestBody :: Maybe (ReferenceOr RequestBody), _responses :: OAIMap (ReferenceOr Response), _security :: Maybe (Array (OAIMap (Array String))), _servers :: Maybe (Array Server), _summary :: Maybe String, _tags :: Maybe (Array String), _x :: Maybe (OAIMap JSON) }

Operation

#T_OAuth2SecurityScheme Source

type T_OAuth2SecurityScheme = { _description :: Maybe String, _flows :: OAuthFlows, _type :: String, _x :: Maybe (OAIMap JSON) }

OAuth2SecurityScheme