// listWorkItemLinks defines the list action for endpoints that return an array // of work item links. func listWorkItemLinks() { a.Description("Retrieve work item link (as JSONAPI) for the given link ID.") a.Routing( a.GET(""), ) a.Response(d.OK, func() { a.Media(workItemLinkList) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) }
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 showWorkItemLink() { a.Description("Retrieve work item link (as JSONAPI) for the given link ID.") a.Routing( a.GET("/:linkId"), ) a.Params(func() { a.Param("linkId", d.String, "ID of the work item link to show") }) a.Response(d.OK, func() { a.Media(workItemLink) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, 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) }
// // ############################################################################ var _ = a.Resource("work-item-link-category", func() { a.BasePath("/workitemlinkcategories") a.Action("show", func() { a.Routing( a.GET("/:id"), ) a.Description("Retrieve work item link category (as JSONAPI) for the given ID.") a.Params(func() { a.Param("id", d.String, "ID of the work item link category") }) a.Response(d.OK, func() { a.Media(workItemLinkCategory) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, JSONAPIErrors) }) a.Action("list", func() { a.Routing( a.GET(""), ) a.Description("List work item link categories.") a.Response(d.OK, func() { a.Media(workItemLinkCategoryList) }) a.Response(d.BadRequest, JSONAPIErrors)
nil, ) var _ = a.Resource("comments", func() { a.BasePath("/comments") a.Action("show", func() { a.Routing( a.GET("/:commentId"), ) a.Params(func() { a.Param("commentId", d.UUID, "commentId") }) a.Description("Retrieve comment with given commentId.") a.Response(d.OK, 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.GET(""), ) a.Description("Search by ID, URL, full text capability") a.Params(func() { a.Param("q", d.String, `Following are valid input for search query 1) "id:100" :- Look for work item hainvg id 100 2) "url:http://demo.almighty.io/details/500" :- Search on WI having id 500 and check if this URL is mentioned in searchable columns of work item 3) "simple keywords separated by space" :- Search in Work Items based on these keywords.`) a.Param("page[offset]", d.String, "Paging start position") // #428 a.Param("page[limit]", d.Integer, "Paging size") a.Required("q") }) a.Response(d.OK, func() { a.Media(searchWorkItemList) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) }) a.Action("spaces", func() { a.Routing( a.GET("spaces"), ) a.Description("Search for spaces by name or description") a.Params(func() { a.Param("q", d.String, "Text to match against Name or description") a.Param("page[offset]", d.String, "Paging start position") a.Param("page[limit]", d.Integer, "Paging size") a.Required("q") })
a.Attribute("data") a.Required("data") }) }) var _ = a.Resource("user", func() { a.BasePath("/user") a.Action("show", func() { a.Security("jwt") a.Routing( a.GET(""), ) a.Description("Get the authenticated user") a.Response(d.OK, func() { a.Media(identity) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.Unauthorized, JSONAPIErrors) }) }) var _ = a.Resource("identity", func() { a.BasePath("/identities") a.Action("list", func() { a.Routing( a.GET(""), )
a.Action("authorize", func() { a.Routing( a.GET("authorize"), ) a.Description("Authorize with the ALM") a.Response(d.Unauthorized, JSONAPIErrors) a.Response(d.TemporaryRedirect) }) a.Action("generate", func() { 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)
iteration, nil) // new version of "list" for migration var _ = a.Resource("iteration", func() { a.BasePath("/iterations") a.Action("show", func() { a.Routing( a.GET("/:iterationID"), ) a.Description("Retrieve iteration with given id.") a.Params(func() { a.Param("iterationID", d.String, "Iteration Identifier") }) a.Response(d.OK, func() { 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)
var _ = a.Resource("workitemtype", func() { a.BasePath("/workitemtypes") a.Action("show", func() { a.Routing( a.GET("/:name"), ) a.Description("Retrieve work item type with given name.") 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) })
area, nil) // new version of "list" for migration var _ = a.Resource("area", func() { a.BasePath("/areas") a.Action("show", func() { a.Routing( a.GET("/:id"), ) a.Description("Retrieve area with given id.") a.Params(func() { a.Param("id", d.String, "id") }) a.Response(d.OK, func() { a.Media(areaSingle) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, JSONAPIErrors) }) a.Action("show-child", func() { a.Routing( a.GET("/:id/children"), ) a.Description("Retrieve child areas of given id.") a.Params(func() { a.Param("id", d.String, "id") }) a.Response(d.OK, func() { a.Media(areaList)
space, nil) var _ = a.Resource("space", func() { a.BasePath("/spaces") a.Action("show", func() { a.Routing( a.GET("/:id"), ) a.Description("Retrieve space (as JSONAPI) for the given ID.") a.Params(func() { a.Param("id", d.String, "ID of the space") }) a.Response(d.OK, func() { a.Media(spaceSingle) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, JSONAPIErrors) }) a.Action("list", func() { a.Routing( a.GET(""), ) a.Description("List spaces.") a.Params(func() { a.Param("page[offset]", d.String, "Paging start position") a.Param("page[limit]", d.Integer, "Paging size") })
// // ############################################################################ var _ = a.Resource("work-item-link-type", func() { a.BasePath("/workitemlinktypes") a.Action("show", func() { a.Routing( a.GET("/:id"), ) a.Description("Retrieve work item link type (as JSONAPI) for the given link ID.") a.Params(func() { a.Param("id", d.String, "ID of the work item link type") }) a.Response(d.OK, func() { a.Media(workItemLinkType) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, JSONAPIErrors) }) a.Action("list", func() { a.Routing( a.GET(""), ) a.Description("List work item link types.") a.Response(d.OK, func() { a.Media(workItemLinkTypeList) }) a.Response(d.BadRequest, JSONAPIErrors)
workItem2, workItemLinks) // new version of "list" for migration var _ = a.Resource("workitem", func() { a.BasePath("/workitems") a.Action("show", func() { a.Routing( a.GET("/:id"), ) a.Description("Retrieve work item with given id.") a.Params(func() { a.Param("id", d.String, "id") }) a.Response(d.OK, func() { a.Media(workItemSingle) }) a.Response(d.BadRequest, JSONAPIErrors) a.Response(d.InternalServerError, JSONAPIErrors) a.Response(d.NotFound, JSONAPIErrors) }) a.Action("list", func() { a.Routing( a.GET(""), ) a.Description("List work items.") a.Params(func() { a.Param("filter", d.String, "a query language expression restricting the set of found work items") a.Param("page[offset]", d.String, "Paging start position") a.Param("page[limit]", d.Integer, "Paging size") a.Param("filter[assignee]", d.String, "Work Items assigned to the given user")