Data.Swagger.Build.Resource

Documentation

resources :: Text -> ResourcesBuilder -> Resources

Construct a resource listing object given a swagger version and some resource objects.

api :: Text -> ResourceBuilder -> ResourcesBuilder

Add one resource object to a resource listing given a path and some resource specific values.

apiVersion :: Text -> ResourcesBuilder

info :: Text -> InfoBuilder -> ResourcesBuilder

Set the info object of a resource listing object given a title and other infor object specific values.

termsOfServiceUrl :: Text -> InfoBuilder

contact :: Text -> InfoBuilder

license :: Text -> InfoBuilder

licenseUrl :: Text -> InfoBuilder

authorisation :: Text -> Authorisation -> ResourcesBuilder

Add a authorisation object to a resource listing with the given name.

end :: Monad m => m ()

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 ()

type InfoBuilder = State InfoSt ()