Module
Data.OpenAPI.V300
- Package
- purescript-openapi
- Repository
- meeshkan/purescript-openapi
#_Parameter Source
_Parameter :: Tuple (T_Parameter -> Parameter) (Parameter -> Maybe T_Parameter)
#_ABoolean Source
_ABoolean :: Tuple (Boolean -> BooleanInt) (BooleanInt -> Maybe Boolean)
#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
#_StringSS Source
_StringSS :: Tuple (String -> SecuritySchema) (SecuritySchema -> Maybe String)
#_ReferenceSS Source
_ReferenceSS :: Tuple (Reference -> SecuritySchema) (SecuritySchema -> Maybe Reference)
#_PathItem Source
_PathItem :: Tuple (T_PathItem -> PathItem) (PathItem -> Maybe T_PathItem)
#_MediaType Source
_MediaType :: Tuple (T_MediaType -> MediaType) (MediaType -> Maybe T_MediaType)
#RequestBody Source
#_AnInt Source
_AnInt :: Tuple (Int -> BooleanInt) (BooleanInt -> Maybe Int)
#ReferenceOr Source
data ReferenceOr a
Constructors
Instances
(Eq a) => Eq (ReferenceOr a)
Generic (ReferenceOr a) _
(Show a) => Show (ReferenceOr a)
(ReadForeign a) => ReadForeign (ReferenceOr a)
(WriteForeign a) => WriteForeign (ReferenceOr a)
#_RequestBody Source
_RequestBody :: Tuple (T_RequestBody -> RequestBody) (RequestBody -> Maybe T_RequestBody)
#Discriminator Source
#_AdditionalSchema Source
_AdditionalSchema :: Tuple (Schema -> Additionals) (Additionals -> Maybe Schema)
#_Reference Source
_Reference :: Tuple (T_Reference -> Reference) (Reference -> Maybe T_Reference)
#SecuritySchema Source
#_Response Source
_Response :: Tuple (T_Response -> Response) (Response -> Maybe T_Response)
#_AdditionalBoolean Source
_AdditionalBoolean :: Tuple (Boolean -> Additionals) (Additionals -> Maybe Boolean)
#_RealDeal Source
_RealDeal :: forall a. Tuple (a -> ReferenceOr a) (ReferenceOr a -> Maybe a)
#_Operation Source
_Operation :: Tuple (T_Operation -> Operation) (Operation -> Maybe T_Operation)
#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
#_Encoding Source
_Encoding :: Tuple (T_Encoding -> Encoding) (Encoding -> Maybe T_Encoding)
#_OAuthFlows Source
_OAuthFlows :: Tuple (T_OAuthFlows -> OAuthFlows) (OAuthFlows -> Maybe T_OAuthFlows)
#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
Newtype (OAIMap b) _
Generic (OAIMap b) _
(Show b) => Show (OAIMap b)
(Eq a) => Eq (OAIMap a)
(ReadForeign a) => ReadForeign (OAIMap a)
(WriteForeign a) => WriteForeign (OAIMap a)
#_AdditionalReference Source
_AdditionalReference :: Tuple (Reference -> Additionals) (Additionals -> Maybe Reference)
#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
#OpenAPIObject Source
#Components Source
#_Ref Source
_Ref :: forall a. Tuple (Reference -> ReferenceOr a) (ReferenceOr a -> Maybe Reference)
#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
#BooleanInt Source
#T_OAuthFlows Source
type T_OAuthFlows = { _authorizationCode :: Maybe AuthorizationCodeOAuthFlow, _clientCredentials :: Maybe ClientCredentialsFlow, _implicit :: Maybe ImplicitOAuthFlow, _password :: Maybe PasswordOAuthFlow, _x :: Maybe (OAIMap JSON) }
OAuthFlows
#_Components Source
_Components :: Tuple (T_Components -> Components) (Components -> Maybe T_Components)
#_ItemsAsTuple Source
_ItemsAsTuple :: Tuple ((Array (ReferenceOr Schema)) -> Items) (Items -> Maybe (Array (ReferenceOr Schema)))
#OAuthFlows Source
#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
- Modules
- Data.
OpenAPI. V300