app

Documentation

Index

• Constants
• func New(config *config.Config, processor processing.Processor) api.ClientModule
• type Module
  • func (m *Module) AppsPOSTHandler(c *gin.Context)
  • func (m *Module) Route(s router.Router) error

Constants

const BasePath = "/api/v1/apps"

BasePath is the base path for this api module

Functions

func New

func New(config *config.Config, processor processing.Processor) api.ClientModule

New returns a new auth module

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module implements the ClientAPIModule interface for requests relating to registering/removing applications

func (*Module) AppsPOSTHandler

func (m *Module) AppsPOSTHandler(c *gin.Context)

AppsPOSTHandler swagger:operation POST /api/v1/apps appCreate

Register a new application on this instance.

The registered application can be used to obtain an application token. This can then be used to register a new account, or (through user auth) obtain an access token.

The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'. The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'.

--- tags: - apps

consumes: - application/json - application/xml - application/x-www-form-urlencoded

produces: - application/json

responses:

'200':
  description: "The newly-created application."
  schema:
    "$ref": "#/definitions/application"
'401':
   description: unauthorized
'400':
   description: bad request
'422':
   description: unprocessable
'500':
   description: internal error

func (*Module) Route

func (m *Module) Route(s router.Router) error

Route satisfies the RESTAPIModule interface