| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Swagger.Build.Resource
Contents
- resources :: Text -> ResourcesBuilder -> Resources
- api :: Text -> ResourceBuilder -> ResourcesBuilder
- apiVersion :: Text -> ResourcesBuilder
- info :: Text -> InfoBuilder -> ResourcesBuilder
- termsOfServiceUrl :: Text -> InfoBuilder
- contact :: Text -> InfoBuilder
- license :: Text -> InfoBuilder
- licenseUrl :: Text -> InfoBuilder
- authorisation :: Text -> Authorisation -> ResourcesBuilder
- end :: Monad m => m ()
- type ResourcesBuilder = State Resources ()
- type InfoBuilder = State InfoSt ()
Documentation
resources :: Text -> ResourcesBuilder -> Resources Source
Construct a resource listing object given a swagger version and some resource objects.
api :: Text -> ResourceBuilder -> ResourcesBuilder Source
Add one resource object to a resource listing given a path and some resource specific values.
apiVersion :: Text -> ResourcesBuilder Source
info :: Text -> InfoBuilder -> ResourcesBuilder Source
Set the info object of a resource listing object given a title and other infor object specific values.
contact :: Text -> InfoBuilder Source
license :: Text -> InfoBuilder Source
licenseUrl :: Text -> InfoBuilder Source
authorisation :: Text -> Authorisation -> ResourcesBuilder Source
Add a authorisation object to a resource listing with the given name.
If cases where no build steps are provided but a builder is required
end can be used, e.g. defineModel "Foo" end
builder types
type ResourcesBuilder = State Resources () Source
type InfoBuilder = State InfoSt () Source