func createWorkItemLink() {
a.Description("Create a work item link")
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Payload(createWorkItemLinkPayload)
a.Response(d.Created, "/workitemlinks/.*", func() {
a.Media(workItemLink)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
}
func updateWorkItemLink() {
a.Description("Update the given work item link with given id.")
a.Security("jwt")
a.Routing(
a.PATCH("/:linkId"),
)
a.Params(func() {
a.Param("linkId", d.String, "ID of the work item link to be updated")
})
a.Payload(updateWorkItemLinkPayload)
a.Response(d.OK, func() {
a.Media(workItemLink)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
}
)
a.Description("List work item link categories.")
a.Response(d.OK, func() {
a.Media(workItemLinkCategoryList)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("create", func() {
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Description("Create a work item link category")
a.Payload(createWorkItemLinkCategoryPayload)
a.Response(d.Created, "/workitemlinkcategories/.*", func() {
a.Media(workItemLinkCategory)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("delete", func() {
a.Security("jwt")
a.Routing(
a.DELETE("/:id"),
)
a.Description("Delete work item link category with given id.")
a.Params(func() {
a.Media(commentSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
})
a.Action("update", func() {
a.Security("jwt")
a.Routing(
a.PATCH("/:commentId"),
)
a.Description("update the comment with the given commentId.")
a.Params(func() {
a.Param("commentId", d.UUID, "commentId")
})
a.Payload(commentSingle)
a.Response(d.OK, func() {
a.Media(commentSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
a.Response(d.Forbidden, JSONAPIErrors)
})
a.Action("delete", func() {
a.Security("jwt")
a.Routing(
a.DELETE("/:commentId"),
)
a.Description("Delete work item with given id.")
a.Routing(
a.GET("generate"),
)
a.Description("Generates a set of Tokens for different Auth levels. NOT FOR PRODUCTION. Only available if server is running in dev mode")
a.Response(d.OK, func() {
a.Media(a.CollectionOf(AuthToken))
})
a.Response(d.Unauthorized, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("refresh", func() {
a.Routing(
a.POST("refresh"),
)
a.Payload(refreshToken)
a.Description("Refreshes access token")
a.Response(d.OK, func() {
a.Media(AuthToken)
})
a.Response(d.Unauthorized, JSONAPIErrors)
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
})
var refreshToken = a.Type("RefreshToken", func() {
a.Attribute("refresh_token", d.String, "Refresh token")
})
// AuthToken represents an authentication JWT Token
a.Media(iterationSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
})
a.Action("create-child", func() {
a.Security("jwt")
a.Routing(
a.POST("/:iterationID"),
)
a.Params(func() {
a.Param("iterationID", d.String, "Iteration Identifier")
})
a.Description("create child iteration.")
a.Payload(iterationSingle)
a.Response(d.Created, "/iterations/.*", func() {
a.Media(iterationSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("update", func() {
a.Security("jwt")
a.Routing(
a.PATCH("/:iterationID"),
)
a.Description("update the iteration for the given id.")
a.Params(func() {
a.Param("name", d.String, "name")
})
a.Response(d.OK, func() {
a.Media(workItemType)
})
a.Response(d.NotFound, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("create", func() {
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Description("Create work item type.")
a.Payload(CreateWorkItemTypePayload)
a.Response(d.Created, "/workitemtypes/.*", func() {
a.Media(workItemType)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("list", func() {
a.Routing(
a.GET(""),
)
a.Description("List work item types.")
a.Params(func() {
a.Param("page", d.String, "Paging in the format <start>,<limit>")
a.Media(areaList)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
})
a.Action("create-child", func() {
a.Security("jwt")
a.Routing(
a.POST("/:id"),
)
a.Params(func() {
a.Param("id", d.String, "id")
})
a.Description("create child area.")
a.Payload(areaSingle)
a.Response(d.Created, "/areas/.*", func() {
a.Media(areaSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.NotFound, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
})
// new version of "list" for migration
var _ = a.Resource("space-areas", func() {
a.Parent("space")
a.Action("list", func() {
})
a.Response(d.OK, func() {
a.Media(spaceList)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("create", func() {
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Description("Create a space")
a.Payload(spaceSingle)
a.Response(d.Created, "/spaces/.*", func() {
a.Media(spaceSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("delete", func() {
a.Security("jwt")
a.Routing(
a.DELETE("/:id"),
)
a.Description("Delete a space with given id.")
a.Params(func() {
)
a.Description("List work item link types.")
a.Response(d.OK, func() {
a.Media(workItemLinkTypeList)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("create", func() {
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Description("Create a work item link type")
a.Payload(createWorkItemLinkTypePayload)
a.Response(d.Created, "/workitemlinktypes/.*", func() {
a.Media(workItemLinkType)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("delete", func() {
a.Security("jwt")
a.Routing(
a.DELETE("/:id"),
)
a.Description("Delete work item link type with given id.")
a.Params(func() {
a.Param("filter[area]", d.String, "AreaID to filter work items")
})
a.Response(d.OK, func() {
a.Media(workItemList)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
a.Action("create", func() {
a.Security("jwt")
a.Routing(
a.POST(""),
)
a.Description("create work item with type and id.")
a.Payload(workItemSingle)
a.Response(d.Created, "/workitems/.*", func() {
a.Media(workItemSingle)
})
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
a.Response(d.Unauthorized, JSONAPIErrors)
})
a.Action("delete", func() {
a.Security("jwt")
a.Routing(
a.DELETE("/:id"),
)
a.Description("Delete work item with given id.")
a.Params(func() {
a.Param("id", d.String, "id")
package design
import (
d "github.com/goadesign/goa/design"
a "github.com/goadesign/goa/design/apidsl"
)
var _ = a.Resource("userspace", func() {
a.BasePath("/userspace")
a.Action("create", func() {
a.Routing(
a.PUT("/*"),
)
a.Description("Data dump endpoint ")
a.Payload(a.HashOf(d.String, d.Any))
a.Response(d.NoContent)
a.Response(d.InternalServerError)
})
a.Action("show", func() {
a.Routing(
a.GET("/*"),
)
a.Description("Data dump endpoint ")
a.Response(d.OK, a.HashOf(d.String, d.Any))
a.Response(d.InternalServerError)
a.Response(d.NotFound)
})
})
})
a.Attribute("type", d.String, func() {
a.Enum("rendering")
})
a.Attribute("attributes", markupRenderingMediaTypeDataAttributes)
a.Required("id")
a.Required("type")
a.Required("attributes")
})
// MarkupRenderingMediaType is the data included in the rendering result response.
var markupRenderingMediaTypeDataAttributes = a.Type("MarkupRenderingDataAttributes", func() {
a.Attribute("renderedContent", d.String, "The rendered content", func() {
a.Example("<h1>foo</h1>")
})
a.Required("renderedContent")
})
var _ = a.Resource("render", func() {
a.BasePath("/render")
a.Security("jwt")
a.Action("render", func() {
a.Description("Render some content using the markup language")
a.Routing(a.POST(""))
a.Payload(markupRenderingPayload)
a.Response(d.OK, markupRenderingMediaType)
a.Response(d.BadRequest, JSONAPIErrors)
a.Response(d.InternalServerError, JSONAPIErrors)
})
})
