api

Documentation

Index

• func CreateRoutes(storage storage.Storage, authService oauth2.OAuthService) *mux.Router
• type API
  • func (a *API) CreateTag(w http.ResponseWriter, r *http.Request)
  • func (a *API) DeleteTag(w http.ResponseWriter, r *http.Request)
  • func (a *API) GetBundleRevision(w http.ResponseWriter, r *http.Request)
  • func (a *API) GetRevisions(w http.ResponseWriter, r *http.Request)
  • func (a *API) GetTag(w http.ResponseWriter, r *http.Request)
  • func (a *API) GetTags(w http.ResponseWriter, r *http.Request)
  • func (a *API) Health(w http.ResponseWriter, r *http.Request)
  • func (a *API) PostBundle(w http.ResponseWriter, r *http.Request)
• type BundleCreatedResponse
• type BundleRevisions
• type RevisionEntry
• type TagCreate
  • func (t *TagCreate) Validate() httputil.Errors
• type TagInfo
• type TagsResponse

Functions

func CreateRoutes

func CreateRoutes(storage storage.Storage, authService oauth2.OAuthService) *mux.Router

CreateRoutes create a new base api route

Types

type API

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

The API instance with the storage pointer

func (*API) CreateTag

func (a *API) CreateTag(w http.ResponseWriter, r *http.Request)

CreateTag delete the bundle revision

func (*API) DeleteTag

func (a *API) DeleteTag(w http.ResponseWriter, r *http.Request)

DeleteTag delete the bundle revision

func (*API) GetBundleRevision

func (a *API) GetBundleRevision(w http.ResponseWriter, r *http.Request)

GetBundleRevision get bundle data for the revision

func (*API) GetRevisions

func (a *API) GetRevisions(w http.ResponseWriter, r *http.Request)

GetRevisions get revisions for a bundle

func (*API) GetTag

func (a *API) GetTag(w http.ResponseWriter, r *http.Request)

GetTag delete the bundle revision

func (*API) GetTags

func (a *API) GetTags(w http.ResponseWriter, r *http.Request)

GetTags delete the bundle revision

func (*API) Health

func (a *API) Health(w http.ResponseWriter, r *http.Request)

Health get the health function

func (*API) PostBundle

func (a *API) PostBundle(w http.ResponseWriter, r *http.Request)

PostBundle post a bundle

type BundleCreatedResponse

type BundleCreatedResponse struct {
	Revision string `json:"revision"`
	Self     string `json:"self"`
}

BundleCreatedResponse the created response for the api

type BundleRevisions

type BundleRevisions struct {
	Revisions []*RevisionEntry `json:"revisions"`
	// contains filtered or unexported fields
}

BundleRevisions the revisions of bundles

type RevisionEntry

type RevisionEntry struct {
	//Revision the revision of this entry
	BundleCreatedResponse
	//The date this revision was stored.
	Created time.Time `json:"date"`
}

RevisionEntry the revision entry

type TagCreate

type TagCreate struct {
	Revision string `json:"revision"`
	Tag      string `json:"tag"`
}

TagCreate The input payload for the tag create

func (*TagCreate) Validate

func (t *TagCreate) Validate() httputil.Errors

Validate perform validation on the input

type TagInfo

type TagInfo struct {
	TagCreate
	Self string `json:"self"`
}

TagInfo a response of the tag creation

type TagsResponse

type TagsResponse struct {
	Tags []*TagInfo `json:"tags"`
	// contains filtered or unexported fields
}

TagsResponse the revisions of bundles