design

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Jul 29, 2016 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ALMVersion = MediaType("application/vnd.version+json", func() {
	Description("The current running version")
	Attributes(func() {
		Attribute("commit", String, "Commit SHA this build is based on")
		Attribute("build_time", String, "The date when build")
		Required("commit", "build_time")
	})
	View("default", func() {
		Attribute("commit")
		Attribute("build_time")
	})
})

ALMVersion defines therunning ALM Version MediaType

View Source
var AuthToken = MediaType("application/vnd.authtoken+json", func() {
	TypeName("AuthToken")
	Description("JWT Token")
	Attributes(func() {
		Attribute("token", String, "JWT Token")
		Required("token")
	})
	View("default", func() {
		Attribute("token")
	})
})

AuthToken represents an authentication JWT Token

View Source
var CreateWorkItemPayload = Type("CreateWorkItemPayload", func() {
	Attribute("type", String, "The type of the newly created work item")
	Attribute("name", String, "User Readable Name of this item")
	Attribute("fields", HashOf(String, Any), "The field values, must conform to the type")
	Required("type", "name", "fields")
})
View Source
var FieldDefinition = Type("fieldDefinition", func() {
	Attribute("required", Boolean)
	Attribute("type", Any)

	Required("required")
	Required("type")

	View("default", func() {
		Attribute("kind")
	})

})
View Source
var WorkItem = MediaType("application/vnd.workitem+json", func() {
	TypeName("WorkItem")
	Description("ALM Work Item")
	Attribute("id", String, "unique id per installation")
	Attribute("version", Integer, "Version for optimistic concurrency control")
	Attribute("name", String, "User Readable Name of this item")
	Attribute("type", String, "Id of the type of this work item")
	Attribute("fields", HashOf(String, Any))

	Required("id")
	Required("version")
	Required("name")
	Required("type")
	Required("fields")

	View("default", func() {
		Attribute("id")
		Attribute("version")
		Attribute("name")
		Attribute("type")
		Attribute("fields")
	})
})
View Source
var WorkItemType = MediaType("application/vnd.workitemtype+json", func() {
	TypeName("WorkItemType")
	Description("ALM Work Item Type")
	Attribute("id", String, "unique id per installation")
	Attribute("version", Integer, "Version for optimistic concurrency control")
	Attribute("name", String, "User Readable Name of this item")
	Attribute("fields", HashOf(String, FieldDefinition), "Definitions of fields in this work item")

	Required("id")
	Required("version")
	Required("name")
	Required("fields")

	View("default", func() {
		Attribute("id")
		Attribute("version")
		Attribute("name")
		Attribute("fields")
	})
	View("link", func() {
		Attribute("id")
	})

})

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