Data.Swagger.Model.Api

The API Declaration part of the swagger specification. For construction please consider using Data.Swagger.Build.Api.

Documentation

data ApiDecl

Cf. API Declaration

Constructors

ApiDecl

Fields

• swaggerVersion :: Text
• basePath :: Text
• apis :: [API]
• apiVersion :: Maybe Text
• resourcePath :: Maybe Text
• models :: Maybe [(Text, Model)]
• apiProduces :: Maybe [Text]
• apiConsumes :: Maybe [Text]
• apiAuthorisations :: Maybe [(Text, [Scope])]

Instances

Show ApiDecl

Methods

showsPrec :: Int -> ApiDecl -> ShowS

show :: ApiDecl -> String

showList :: [ApiDecl] -> ShowS

ToJSON ApiDecl

Methods

toJSON :: ApiDecl -> Value

toEncoding :: ApiDecl -> Encoding

toJSONList :: [ApiDecl] -> Value

toEncodingList :: [ApiDecl] -> Encoding

data API

Cf. API Object

Constructors

API

Fields

• path :: Text
• operations :: [Operation]
• apiDescription :: Maybe Text

Instances

Show API

Methods

showsPrec :: Int -> API -> ShowS

show :: API -> String

showList :: [API] -> ShowS

ToJSON API

Methods

toJSON :: API -> Value

toEncoding :: API -> Encoding

toJSONList :: [API] -> Value

toEncodingList :: [API] -> Encoding

data Operation

Cf. Operation Object

Constructors

Operation

Fields

• method :: Text
• nickname :: Text
• returnType :: Either () DataType
• parameters :: [Parameter]
• summary :: Maybe Text
• notes :: Maybe Text
• authorisations :: Maybe [(Text, [Scope])]
• responses :: Maybe [Response]
• produces :: Maybe [Text]
• consumes :: Maybe [Text]
• deprecated :: Maybe Bool

Instances

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

ToJSON Operation

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

data Parameter

Cf. Parameter Object

Constructors

Parameter

Fields

• paramType :: ParamType
• inputType :: Either File DataType
• paramName :: Text
• description :: Maybe Text
• required :: Maybe Bool
• allowMultiple :: Maybe Bool

Instances

Show Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

ToJSON Parameter

Methods

toJSON :: Parameter -> Value

toEncoding :: Parameter -> Encoding

toJSONList :: [Parameter] -> Value

toEncodingList :: [Parameter] -> Encoding

data ParamType

Constructors

Path

Query

Body

Header

Form

Instances

Eq ParamType

Methods

(==) :: ParamType -> ParamType -> Bool

(/=) :: ParamType -> ParamType -> Bool

Show ParamType

Methods

showsPrec :: Int -> ParamType -> ShowS

show :: ParamType -> String

showList :: [ParamType] -> ShowS

ToJSON ParamType

Methods

toJSON :: ParamType -> Value

toEncoding :: ParamType -> Encoding

toJSONList :: [ParamType] -> Value

toEncodingList :: [ParamType] -> Encoding

data Response

Cf. Response Message Object

Constructors

Response

Fields

• code :: Int
• message :: Text
• responseModel :: Maybe ModelId

Instances

Show Response

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

ToJSON Response

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

data Model

Cf. Model Object

Constructors

Model

Fields

• modelId :: ModelId
• properties :: [(PropertyName, Property)]
• modelDescription :: Maybe Text
• requiredProps :: Maybe [PropertyName]
• subTypes :: Maybe [Model]
• discriminator :: Maybe PropertyName

Instances

Show Model

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

ToJSON Model

Methods

toJSON :: Model -> Value

toEncoding :: Model -> Encoding

toJSONList :: [Model] -> Value

toEncodingList :: [Model] -> Encoding

data Property

Cf. Property Object

Constructors

Property

Fields

• propertyType :: DataType
• propDescription :: Maybe Text

Instances

Show Property

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

ToJSON Property

Methods

toJSON :: Property -> Value

toEncoding :: Property -> Encoding

toJSONList :: [Property] -> Value

toEncodingList :: [Property] -> Encoding

data DataType where

Constructors

Prim :: (Show a, ToJSON a) => Primitive a -> DataType

Array :: (Show a, ToJSON a) => Items a -> Maybe Bool -> DataType

Ref :: ModelId -> DataType

Instances

Show DataType

Methods

showsPrec :: Int -> DataType -> ShowS

show :: DataType -> String

showList :: [DataType] -> ShowS

data Primitive a

Cf. Primitive Types

Constructors

Primitive

Fields

• primType :: PrimType
• defaultValue :: Maybe a
• enum :: Maybe [a]
• minVal :: Maybe a
• maxVal :: Maybe a

Instances

Show a => Show (Primitive a)

Methods

showsPrec :: Int -> Primitive a -> ShowS

show :: Primitive a -> String

showList :: [Primitive a] -> ShowS

data Items a

Constructors

PrimItems (Primitive a)

ModelItems ModelId

Instances

Show a => Show (Items a)

Methods

showsPrec :: Int -> Items a -> ShowS

show :: Items a -> String

showList :: [Items a] -> ShowS

data PrimType

Constructors

PrimInt32

PrimInt64

PrimFloat

PrimDouble

PrimString

PrimByte

PrimBool

PrimDate

PrimDateTime

Instances

Show PrimType

Methods

showsPrec :: Int -> PrimType -> ShowS

show :: PrimType -> String

showList :: [PrimType] -> ShowS

data File

Constructors

File

Instances

Show File

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

type ModelId = Text

type PropertyName = Text