// JSONList creates a UserTypeDefinition
func JSONList(name, description string, data *d.UserTypeDefinition, links *d.UserTypeDefinition, meta *d.UserTypeDefinition) *d.MediaTypeDefinition {
return a.MediaType("application/vnd."+strings.ToLower(name)+"list+json", func() {
a.UseTrait("jsonapi-media-type")
a.TypeName(name + "List")
a.Description(description)
if links != nil {
a.Attribute("links", links)
}
if meta != nil {
a.Attribute("meta", meta)
}
a.Attribute("data", a.ArrayOf(data))
a.Attribute("included", a.ArrayOf(d.Any), "An array of mixed types")
a.Required("data")
a.View("default", func() {
if links != nil {
a.Attribute("links")
}
if meta != nil {
a.Attribute("meta")
}
a.Attribute("data")
a.Attribute("included")
a.Required("data")
})
})
}
// JSONSingle creates a Single
func JSONSingle(name, description string, data *d.UserTypeDefinition, links *d.UserTypeDefinition) *d.MediaTypeDefinition {
// WorkItemSingle is the media type for work items
return a.MediaType("application/vnd."+strings.ToLower(name)+"+json", func() {
a.UseTrait("jsonapi-media-type")
a.TypeName(name + "Single")
a.Description(description)
if links != nil {
a.Attribute("links", links)
}
a.Attribute("data", data)
a.Attribute("included", a.ArrayOf(d.Any), "An array of mixed types")
a.Required("data")
a.View("default", func() {
if links != nil {
a.Attribute("links")
}
a.Attribute("data")
a.Attribute("included")
a.Required("data")
})
})
}
a.Required("data")
})
a.View("default", func() {
a.Attribute("data")
a.Required("data")
})
})
// identityArray represents an array of identified user objects
var identityArray = a.MediaType("application/vnd.identity-array+json", func() {
a.UseTrait("jsonapi-media-type")
a.TypeName("IdentityArray")
a.Description("ALM User Identity Array")
a.Attributes(func() {
a.Attribute("data", a.ArrayOf(identityData))
a.Required("data")
})
a.View("default", func() {
a.Attribute("data")
a.Required("data")
})
})
// userArray represents an array of user objects
var userArray = a.MediaType("application/vnd.user-array+json", func() {
a.UseTrait("jsonapi-media-type")
a.TypeName("UserArray")
a.Description("User Array")
a.Attributes(func() {
a.Required("required")
a.Required("type")
a.View("default", func() {
a.Attribute("kind")
})
})
// fieldType is the datatype of a single field in a work item type
var fieldType = a.Type("fieldType", func() {
a.Description("A fieldType describes the values a particular field can hold")
a.Attribute("kind", d.String, "The constant indicating the kind of type, for example 'string' or 'enum' or 'instant'")
a.Attribute("componentType", d.String, "The kind of type of the individual elements for a list type. Required for list types. Must be a simple type, not enum or list")
a.Attribute("baseType", d.String, "The kind of type of the enumeration values for an enum type. Required for enum types. Must be a simple type, not enum or list")
a.Attribute("values", a.ArrayOf(d.Any), "The possible values for an enum type. The values must be of a type convertible to the base type")
a.Required("kind")
})
// workItemType is the media type representing a work item type.
var workItemType = a.MediaType("application/vnd.workitemtype+json", func() {
a.TypeName("WorkItemType")
a.Description("A work item type describes the values a work item type instance can hold.")
a.Attribute("version", d.Integer, "Version for optimistic concurrency control")
a.Attribute("name", d.String, "User Readable Name of this item type")
a.Attribute("fields", a.HashOf(d.String, fieldDefinition), "Definitions of fields in this work item type")
a.Required("version")
a.Required("name")
a.Required("fields")
* pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
or "/data/attributes/title" for a specific attribute].
* parameter: a string indicating which URI query parameter caused the error.`)
a.Attribute("meta", a.HashOf(d.String, d.Any), "a meta object containing non-standard meta-information about the error")
a.Required("detail")
})
// JSONAPIErrors is an array of JSONAPI error objects
var JSONAPIErrors = a.MediaType("application/vnd.jsonapierrors+json", func() {
a.UseTrait("jsonapi-media-type")
a.TypeName("JSONAPIErrors")
a.Description(``)
a.Attributes(func() {
a.Attribute("errors", a.ArrayOf(JSONAPIError))
a.Required("errors")
})
a.View("default", func() {
a.Attribute("errors")
a.Required("errors")
})
})
// relationGeneric is a top level structure for 'other' relationships
var relationGeneric = a.Type("RelationGeneric", func() {
a.Attribute("data", genericData)
a.Attribute("links", genericLinks)
a.Attribute("meta", a.HashOf(d.String, d.Any))
})
