| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Swagger.Model.Api
Description
The API Declaration part of the swagger specification. For construction please consider using Data.Swagger.Build.Api.
- data ApiDecl = ApiDecl {
- 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])]
- data API = API {
- path :: Text
- operations :: [Operation]
- apiDescription :: Maybe Text
- data Operation = Operation {}
- data Parameter = Parameter {}
- data ParamType
- data Response = Response {}
- data Model = Model {
- modelId :: ModelId
- properties :: [(PropertyName, Property)]
- modelDescription :: Maybe Text
- requiredProps :: Maybe [PropertyName]
- subTypes :: Maybe [Model]
- discriminator :: Maybe PropertyName
- data Property = Property {}
- data DataType where
- data Primitive a = Primitive {}
- data Items a
- = PrimItems (Primitive a)
- | ModelItems ModelId
- data PrimType
- data File = File
- type ModelId = Text
- type PropertyName = Text
Documentation
Cf. API Declaration
Constructors
| ApiDecl | |
Fields
| |
Cf. API Object
Constructors
| API | |
Fields
| |
Cf. Operation Object
Constructors
| Operation | |
Cf. Parameter Object
Constructors
| Parameter | |
Cf. Model Object
Constructors
| Model | |
Fields
| |
Cf. Property Object
Constructors
| Property | |
Fields | |
Cf. Primitive Types
Constructors
| Primitive | |
Constructors
| PrimItems (Primitive a) | |
| ModelItems ModelId |
type PropertyName = Text Source