Data.Swagger.Model.Api

Description

Synopsis

• 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 {
  • 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
  }
• data Parameter = Parameter {
  • paramType :: ParamType
  • inputType :: Either File DataType
  • paramName :: Text
  • description :: Maybe Text
  • required :: Maybe Bool
  • allowMultiple :: Maybe Bool
  }
• data ParamType
  • = Path
  • | Query
  • | Body
  • | Header
  • | Form
• data Response = Response {
  • code :: Int
  • message :: Text
  • responseModel :: Maybe ModelId
  }
• data Model = Model {
  • modelId :: ModelId
  • properties :: [(PropertyName, Property)]
  • modelDescription :: Maybe Text
  • requiredProps :: Maybe [PropertyName]
  • subTypes :: Maybe [Model]
  • discriminator :: Maybe PropertyName
  }
• data Property = Property {
  • propertyType :: DataType
  • propDescription :: Maybe Text
  }
• data DataType where
  • Prim :: (Show a, ToJSON a) => Primitive a -> DataType
  • Array :: (Show a, ToJSON a) => Items a -> Maybe Bool -> DataType
  • Ref :: ModelId -> DataType
• data Primitive a = Primitive {
  • primType :: PrimType
  • defaultValue :: Maybe a
  • enum :: Maybe [a]
  • minVal :: Maybe a
  • maxVal :: Maybe a
  }
• data Items a
  • = PrimItems (Primitive a)
  • | ModelItems ModelId
• data PrimType
  • = PrimInt32
  • | PrimInt64
  • | PrimFloat
  • | PrimDouble
  • | PrimString
  • | PrimByte
  • | PrimBool
  • | PrimDate
  • | PrimDateTime
• data File = File
• type ModelId = Text
• type PropertyName = Text

Documentation