design

package
v0.0.0-...-a2b2d1c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2018 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var BasicAuth = BasicAuthSecurity("BasicAuth", func() {
	Description("Use client ID and client secret to authenticate")
})
View Source
var JWT = JWTSecurity("jwt", func() {
	Header("Authorization")
	Scope("api:write", "API write access")
	Scope("api:read", "API read access")
})
View Source
var Quote = MediaType("vnd.application.io/quote", func() {
	Description("All quotes for a given user ID")
	Attributes(func() {
		Attribute("ID", Integer, "ID of the user")
		Attribute("Name", String, "User ID of quoter")
		Attribute("Quote", String, "The actual quotes of the quoter")
	})
	View("default", func() {
		Attribute("ID", Integer, "ID of the user")
		Attribute("Name", String, "User ID of quoter")
		Attribute("Quote", String, "The actual quotes of the quoter")
	})
})
View Source
var Quotes = MediaType("vnd.application.io/quotes", func() {
	Description("A quote from the user database")
	Attributes(func() {
		Attribute("Quotes", ArrayOf(Quote), "Quote")
	})
	View("default", func() {
		Attribute("Quotes")
	})
})
View Source
var Suggestion = Type("suggestion", func() {
	Description("All suggestions for a given user ID")
	Attribute("ShowID", String, "The ID of the show")
	Attribute("Suggester", String, "Identity of suggester")
	Attribute("Title", String, "The suggested title")
})
View Source
var Suggestions = MediaType("vnd.application.io/suggestions", func() {
	Attributes(func() {
		Attribute("Suggestions", ArrayOf(Suggestion), "Suggestion")
	})
	View("default", func() {
		Attribute("Suggestions")
	})
})

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL