openapi: 3.1.0 info: title: backend-api version: "0.1" servers: - url: https://api.atono.io description: Atono API security: - ApiKeyAuth: [] paths: /api/acceptance_criteria/{id}: get: tags: - Acceptance Criteria summary: "Look up an acceptance criterion by id, independently from its backlog\ \ item" operationId: getAcceptanceCriterion parameters: - name: id in: path required: true schema: type: string format: uuid responses: "404": description: The acceptance criterion cannot be found /api/ai/story_reviewer: get: tags: - AI summary: Request an existing story review by story id operationId: getReview parameters: - name: storyId in: query required: true schema: type: string format: uuid responses: "200": description: getReview 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryReviewResource_" post: tags: - AI summary: Request a story review from the Story Reviewer Assistant operationId: newReview requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_StoryReviewCreationResource_" required: true responses: "200": description: newReview 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryReviewResource_" /api/ai/story_reviewer/{id}: delete: tags: - AI summary: Delete a story review by its id operationId: deleteReview parameters: - name: id in: path description: The UUID of the key to delete. required: true schema: type: string format: uuid responses: "200": description: deleteReview 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/ai/story_reviewer/{id}/findings: patch: tags: - AI operationId: updateFindings parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_StoryReviewFindingUpdateResource_" required: true responses: "200": description: updateFindings 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_StoryReviewFindingResource_" /api/ai/story_reviewer/{id}/findings/{findingId}: patch: tags: - AI operationId: updateFinding parameters: - name: id in: path required: true schema: type: string format: uuid - name: findingId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_StoryReviewFindingUpdateResource_" required: true responses: "200": description: updateFinding 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryReviewFindingResource_" /api/ai/story_reviewer/{id}/suggestion: post: tags: - AI operationId: createSuggestion parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: createSuggestion 200 response content: application/json: schema: {} /api/ai/story_reviewer/{reviewId}/suggestion/{suggestionId}: get: tags: - AI operationId: getSuggestion parameters: - name: reviewId in: path required: true schema: type: string format: uuid - name: suggestionId in: path required: true schema: type: string format: uuid responses: "200": description: getSuggestion 200 response content: application/json: schema: {} /api/ai/story_writer: get: tags: - AI summary: List Story Writer Conversation messages by story id operationId: getConversation parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/StoryWriterController.RequestFilter" responses: "200": description: getConversation 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_StoryWriterConversationResource_" post: tags: - AI summary: Send a user query to the Story Writer Assistant operationId: postMessage requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_StoryWriterConversationCreationResource_" required: true responses: "200": description: postMessage 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryWriterConversationResource_" /api/ai/story_writer/prompt: get: tags: - AI summary: Get the prompt parts used by the assistant description: "This is not a JSON:API endpoint, as it returns the assistant prompt\ \ configuration rather than a persisted resource." operationId: getPromptParts responses: "200": description: getPromptParts 200 response content: application/json: schema: additionalProperties: type: string /api/ai/story_writer/title: post: tags: - AI summary: Ask Story Writer Assistant to generate a title for a new story operationId: generateTitle requestBody: content: application/json: schema: type: string maxLength: 2000 minLength: 1 required: true responses: "200": description: generateTitle 200 response content: application/json: schema: type: string /api/ai/story_writerconversation: delete: tags: - AI summary: 'Remove the Story Writer conversations by story id ' operationId: deleteConversation parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/StoryWriterController.RequestFilter" responses: "200": description: deleteConversation 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/api_keys: get: tags: - Personal API Keys summary: List API Keys description: List API Keys belonging to the current user operationId: listApiKeys responses: "200": description: listApiKeys 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ApiKeyResource_" post: tags: - Personal API Keys summary: Create an API Key description: Create a new API key for API access with the same permissions as your workspace user. operationId: createApiKey requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ApiKeyCreationResource_" required: true responses: "200": description: createApiKey 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ApiKeyResource_" /api/api_keys/{id}: get: tags: - Personal API Keys summary: Get an API Key description: Get an API Key for API access. operationId: getApiKey parameters: - name: id in: path description: The UUID of the key to retrieve. required: true schema: type: string format: uuid responses: "200": description: getApiKey 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ApiKeyResource_" delete: tags: - Personal API Keys summary: Delete an API Key description: Delete an API Key for API access. operationId: deleteApiKey parameters: - name: id in: path description: The UUID of the key to delete. required: true schema: type: string format: uuid responses: "200": description: deleteApiKey 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Personal API Keys summary: Update an API Key operationId: updateApiKey parameters: - name: id in: path description: The UUID of the key to update. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ApiKeyUpdateResource_" required: true responses: "200": description: updateApiKey 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ApiKeyResource_" /api/attachments: post: tags: - Attachments summary: Create an attachment operationId: createAttachment requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_AttachmentCreationResource_" required: true responses: "200": description: createAttachment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_AttachmentResource_" /api/attachments/download_url: get: tags: - Attachments summary: Request URL for the client to download an attachment description: This is not a JSON:API endpoint to operate on attachments that are still in Draft state and are not saved in the database operationId: getDownloadUrl parameters: - name: path in: query required: true schema: type: string responses: "200": description: getDownloadUrl 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_PreSignedUrl_" /api/attachments/upload_url: get: tags: - Attachments summary: Request URL for the client to upload an attachment description: This is not a JSON:API endpoint operationId: getUploadUrl parameters: - name: filename in: query required: true schema: type: string responses: "200": description: getUploadUrl 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_PreSignedUrl_" /api/attachments/{id}: get: tags: - Attachments summary: Get an attachment operationId: getAttachment parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/AttachmentController.InclusionType" responses: "200": description: getAttachment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_AttachmentResource_" delete: tags: - Attachments summary: Delete an attachment operationId: deleteAttachment parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteAttachment 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Attachments summary: Update an attachment operationId: updateAttachment parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_AttachmentUpdateResource_" required: true responses: "200": description: updateAttachment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_AttachmentResource_" /api/attachments/{id}/duplicate: post: tags: - Attachments summary: Make a copy of an attachment operationId: duplicateAttachment parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: duplicateAttachment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FileUrl_" /api/backlog_item_sizes: get: tags: - Backlog Item Sizes operationId: list responses: "200": description: list 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ItemSizeResource_" /api/backlog_items: get: tags: - Backlog Items summary: Lists all the backlog items operationId: listBacklogItems parameters: - name: include in: query description: | Supports ASSIGNEE, CREATOR, CYCLE_TIME, EPIC, EPIC_STORIES, FEATURE_FLAG, ITEM_TIMES_TEAM_STATS, PRODUCT_THEME, RISK_RATING, SPRINT, STEP, SUBTASK_COUNT, TAG_VALUES, TEAM and TIMEBOX. Ignores ACCEPTANCE_CRITERIA, ATTACHMENTS, COMMENTS, LINKED_ITEMS, LINKED_ITEMS_STEPS and SUBTASKS. required: true schema: type: array items: $ref: "#/components/schemas/BacklogItemController.InclusionType" - name: filter in: query description: | Filter for backlog items. Notes about specific filter parameters - filter[assigneeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[keywordSearch]: Find backlog items that match the given string. Case insensitive. Matches both handle and title portions. - filter[createdAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[doneAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[updatedAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[environmentIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[environmentIds]: pipe-separated list of a hasExternalId flag and an optional keyword search, e.g. 'true|HOTH', 'false' - filter[productThemeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[epicIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[riskRating]: pipe-separated range of integers, e.g. 2|24 or 'NONE', - filter[sizeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[sprintIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[stepIds]: pipe-separated list of valid UUIDs only - filter[stepExpressions]: Filter with an expression that identify one or more step names within a step category. Case insensitive. Repeatable parameter to filter by more than one step category. - filter[teamIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[teams]: possible values: - ALL: List items from all active team and unassigned backlogs. Some item details may be hidden based on user permissions. - SPECIFIED: List only items from specified team or unassigned backlogs - USER_RELATED: List only items from unassigned backlog or backlogs of public teams or of private teams the user is a member or an admin of - USER_RELATED_WITH_DELETED: Similar to USER_RELATED but also includes items from deleted teams - filter[timeboxIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[triageGroup]: The only supported value is 'TRIAGE' - filter[type]: pipe-separated list of ItemType values, e.g. 'STORY|BUG' or single value 'STORY' required: true schema: $ref: "#/components/schemas/BacklogItemController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string - name: privateItemsAtEnd in: query description: "Whether to place private/censored items at the end of the list.\ \ If false, items maintain their original order with censoring applied in\ \ place." required: true schema: type: boolean default: false responses: "200": description: listBacklogItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" post: tags: - Backlog Items summary: Creates a backlog item operationId: createBacklogItem requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemCreationResource_" required: true responses: "200": description: createBacklogItem 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemResource_" /api/backlog_items/{id}: get: tags: - Backlog Items operationId: getBacklogItem parameters: - name: id in: path required: true schema: type: string - name: includeDeleted in: query schema: type: - boolean - "null" - name: includeAcceptanceCriterionId in: query schema: type: - string - "null" format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/BacklogItemController.InclusionType" responses: "200": description: getBacklogItem 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemResource_" delete: tags: - Backlog Items summary: Deletes a backlog item operationId: deleteBacklogItem parameters: - name: id in: path required: true schema: type: string responses: "200": description: deleteBacklogItem 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Backlog Items operationId: updateBacklogItem parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemUpdateResource_" required: true responses: "200": description: updateBacklogItem 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemResource_" /api/backlog_items/{id}/acceptance_criteria: get: tags: - Acceptance Criteria summary: Retrieves all acceptance criteria for a backlog item operationId: listAcceptanceCriteria parameters: - name: id in: path required: true schema: type: string format: uuid responses: "404": description: The parent backlog items cannot be found post: tags: - Acceptance Criteria summary: Creates an acceptance criterion for a backlog item operationId: createAcceptanceCriterion parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_AcceptanceCriterionCreationResource_" required: true responses: "404": description: The parent backlog items cannot be found /api/backlog_items/{id}/acceptance_criteria/batch: put: tags: - Acceptance Criteria summary: Replaces all acceptance criteria for a backlog item description: |- This operation deletes all existing acceptance criteria for a backlog item and replaces them with the provided ones. If any items in the list have ids, they will be treated as updates. Any previously existing ACs that are not in the list will be deleted. operationId: replaceAcceptanceCriteria parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/AcceptanceCriteriaReplaceResource" required: true responses: "404": description: The parent backlog items or acceptance criteria cannot be found post: tags: - Acceptance Criteria summary: Creates multiple acceptance criteria for a backlog item operationId: createAcceptanceCriteria parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/AcceptanceCriteriaCreationResource" required: true responses: "404": description: The parent backlog items cannot be found /api/backlog_items/{id}/acceptance_criteria/{acId}: get: tags: - Acceptance Criteria operationId: getAcceptanceCriterion_1 parameters: - name: id in: path required: true schema: type: string format: uuid - name: acId in: path required: true schema: type: string format: uuid responses: "404": description: The parent backlog items or acceptance criterion cannot be found delete: tags: - Acceptance Criteria summary: Deletes an acceptance criterion for a backlog item operationId: deleteAcceptanceCriterion parameters: - name: id in: path required: true schema: type: string format: uuid - name: acId in: path required: true schema: type: string format: uuid responses: "404": description: The parent backlog items or acceptance criterion cannot be found patch: tags: - Acceptance Criteria operationId: updateAcceptanceCriterion parameters: - name: id in: path required: true schema: type: string format: uuid - name: acId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_AcceptanceCriterionUpdateResource_" required: true responses: "404": description: The parent backlog items or acceptance criterion cannot be found /api/backlog_items/{id}/relationships/environments: get: tags: - Backlog Items summary: Returns the list of affected environments operationId: getItemEnvironments parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getItemEnvironments 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" patch: tags: - Backlog Items summary: Updates the list of affected environments operationId: updateEnvironments parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateEnvironments 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" /api/backlog_items/{id}/relationships/epicStories: post: tags: - Backlog Items summary: Add stories to an epic description: | Bulk-adds backlog items of type STORY to the epic identified by `id`, up to a maximum of 100 stories per epic. To see the current count, fetch the epic with `include=EPIC_STORIES` and check `relationships.epicStories.meta.count`. Note that `id` in the path is the **epic's** id, while each `id` inside the request body's `data` array is a **story's** id. A story that already belongs to a different epic is moved rather than duplicated, since a story can only belong to one epic at a time. Stories that are already on this epic are left as-is and are not duplicated. This endpoint applies a best-effort, partial-success model for invalid items: any story in `data` that is not found, is not of type STORY (e.g. it's a bug or another epic - no nested epics), or belongs to a private team the caller cannot access, is reported in the `errors` array along with its id and the reason, without blocking the rest of the request. Stories already on this epic are left as-is and don't count as new additions. Capacity is enforced as all-or-nothing: if adding every valid, not-yet-associated story in `data` would exceed the 100-story limit, none of them are added, and a single error in `errors` reports how many stories were requested versus how many could actually fit. (Invalid items such as bugs or non-existent ids don't count toward this limit either way.) operationId: addBacklogItemEpicStories parameters: - name: id in: path description: The id of the **epic** to add stories to. required: true schema: type: string format: uuid requestBody: description: "The stories to add to the epic. Each `id` here is a **story's**\ \ id, not the epic's id." content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" examples: example: value: data: - type: backlog_item id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 required: true responses: "200": description: "At least one story ended up associated with the epic. Returns\ \ the full, current list of story ids on the epic (not just the ones just\ \ added) in `data`, plus any failures in `errors`. `meta.addedCount` is\ \ the number of stories newly associated by this call. `meta.errorCount`\ \ is the number of entries in the `errors` array (e.g. the 100-story-limit\ \ violation is always reported as a single aggregate entry, even though\ \ it can reject many stories at once). `meta.failedCount` is the total\ \ number of individual story ids that were rejected across all errors\ \ - for the limit-violation error, check that error's `meta.ids` for the\ \ full list of rejected ids." content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: "`data` was missing, `data` had more than 100 entries, every\ \ story in `data` failed to be added (not found or not of type STORY),\ \ or the valid stories alone would exceed the epic's 100-story limit.\ \ See `errors` for details." "404": description: The epic identified by `id` could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/backlog_items/{id}/relationships/featureFlag: get: tags: - Backlog Items summary: Get the feature flag relationship description: Get the feature flag relationship associated to a backlog item operationId: fetchFeatureFlagRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The feature flag relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error patch: tags: - Backlog Items summary: Update a feature flag relationship description: Update the feature flag relationship of a backlog item operationId: setFeatureFlag parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleRelationshipUpdate" required: true responses: "200": description: The updated feature flag relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error /api/backlog_items/{id}/relationships/impact: get: tags: - Backlog Items summary: Get the impact relationship description: Get the impact relationship associated to a backlog item operationId: fetchImpactRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The impact relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error patch: tags: - Backlog Items summary: Update the impact relationship description: Update the impact relationship of a backlog item operationId: setImpact parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleRelationshipUpdate" required: true responses: "200": description: The updated impact relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error /api/backlog_items/{id}/relationships/linkedItems: get: tags: - Backlog Items summary: Returns the list of linked items operationId: getLinkedItems parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getLinkedItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" post: tags: - Backlog Items summary: Add linked items to the list of linked items operationId: addLinkedItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: addLinkedItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" delete: tags: - Backlog Items summary: Remove linked items from the list of linked items operationId: deleteLinkedItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: deleteLinkedItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" patch: tags: - Backlog Items summary: Updates the list of linked items operationId: updateLinkedItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateLinkedItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" /api/backlog_items/{id}/relationships/nonDuplicateItems: post: tags: - Backlog Items summary: Add items to the list of linked non duplicate items operationId: addLinkedNonDuplicateItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: addLinkedNonDuplicateItems 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/backlog_items/{id}/relationships/probability: get: tags: - Backlog Items summary: Get the probability relationship description: Get the probability relationship associated to a backlog item operationId: fetchProbabilityRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The probability relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error patch: tags: - Backlog Items summary: Update the probability relationship description: Update the probability relationship of a backlog item operationId: setProbability parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleRelationshipUpdate" required: true responses: "200": description: The updated probability relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error /api/backlog_items/{id}/relationships/size: get: tags: - Backlog Items summary: Get the size relationship description: Get the size relationship associated to a backlog item operationId: fetchSizeRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The size relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error patch: tags: - Backlog Items summary: Update a size relationship description: Update the size relationship of a backlog item operationId: setSizeRelationship parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleRelationshipUpdate" required: true responses: "200": description: The updated size relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item or size not found "500": description: Unexpected error /api/backlog_items/{id}/relationships/tagValues: get: tags: - Backlog Items summary: Get tag value relationships for a backlog item description: "GET /api/backlog_items/{id}/relationships/tagValues Get the tag\ \ value relationships for a backlog item" operationId: getBacklogItemTagValueRelationships parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getBacklogItemTagValueRelationships 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" post: tags: - Backlog Items summary: Associate tag values with a backlog item description: "POST /api/backlog_items/{id}/relationships/tagValues Associate\ \ tag values with a backlog item" operationId: associateTagValues parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: associateTagValues 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagValueResource_" delete: tags: - Backlog Items summary: Disassociate tag values from a backlog item description: "DELETE /api/backlog_items/{id}/relationships/tagValues Disassociate\ \ tag values from a backlog item" operationId: disassociateTagValues parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: disassociateTagValues 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagValueResource_" /api/backlog_items/{id}/relationships/workflowStep: get: tags: - Backlog Items summary: Get the workflow step relationship description: Get the workflow step relationship associated to a backlog item operationId: fetchWorkflowStepRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The workflow step relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error patch: tags: - Backlog Items summary: Update the workflow step relationship description: Update the workflow step relationship of a backlog item operationId: setWorkflowStep parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleRelationshipUpdate" required: true responses: "200": description: The updated workflow step relationship content: application/json: schema: $ref: "#/components/schemas/SingleRelationship" "404": description: Backlog item not found "500": description: Unexpected error /api/backlog_items/{id}/risk_rating_suggestion: post: tags: - Backlog Items summary: Estimate bug risk raring and create a risk rating suggestion operationId: suggestItemRiskRating parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: suggestItemRiskRating 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_RiskRatingSuggestionResource_" /api/backlog_items/{id}/size_suggestion: get: tags: - Backlog Items summary: Get size suggestion created for this item operationId: getSizeSuggestion parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getSizeSuggestion 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SizeSuggestionResource_" post: tags: - Backlog Items summary: Estimate story size and create a size suggestion operationId: suggestItemSize parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: suggestItemSize 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SizeSuggestionResource_" /api/backlog_items/{id}/subtasks: get: tags: - Subtasks operationId: listSubtasks parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: listSubtasks 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SubtaskResource_" post: tags: - Subtasks operationId: createSubtask parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SubtaskCreationResource_" required: true responses: "200": description: createSubtask 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" /api/backlog_items/{id}/subtasks/{subtaskId}: get: tags: - Subtasks operationId: getSubtask parameters: - name: id in: path required: true schema: type: string format: uuid - name: subtaskId in: path required: true schema: type: string format: uuid responses: "200": description: getSubtask 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" delete: tags: - Subtasks operationId: deleteSubtask parameters: - name: id in: path required: true schema: type: string format: uuid - name: subtaskId in: path required: true schema: type: string format: uuid responses: "200": description: deleteSubtask 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Subtasks operationId: updateSubtask parameters: - name: id in: path required: true schema: type: string format: uuid - name: subtaskId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SubtaskUpdateResource_" required: true responses: "200": description: updateSubtask 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" /api/backlog_items/{id}/tagValues: get: tags: - Backlog Items summary: List tag values for a backlog item description: "GET /api/backlog_items/{id}/tagValues List all tag values associated\ \ with a backlog item" operationId: listBacklogItemTagValues parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query description: Optional relationships to include in the response. Use 'TAG' to include tag resources. schema: type: - array - "null" items: $ref: "#/components/schemas/BacklogItemController.TagValueInclusionType" responses: "200": description: listBacklogItemTagValues 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagValueResource_" /api/backlog_items/{itemId}/ai_activity: get: tags: - Backlog Items summary: Lists all the AI Activity entries for a backlog item operationId: listEntries parameters: - name: itemId in: path required: true schema: type: string - name: filter in: query description: | Filter for AI Activity entries. - filter[kind]: One of DESIGN, INVESTIGATION, or SUMMARY required: true schema: $ref: "#/components/schemas/AiActivityController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: listEntries 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_AiActivityResource_" post: tags: - Backlog Items summary: Creates an AI Activity entry for a backlog item operationId: createEntry parameters: - name: itemId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_AiActivityCreationResource_" required: true responses: "200": description: createEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_AiActivityResource_" /api/backlog_items/{itemId}/ai_activity/{idOrKind}: delete: tags: - Backlog Items summary: Deletes an AI Activity entry by ID or all entries by kind operationId: deleteEntry parameters: - name: itemId in: path required: true schema: type: string - name: idOrKind in: path required: true schema: type: string responses: "200": description: deleteEntry 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/backlog_items/{itemId}/ai_activity/{id}: get: tags: - Backlog Items summary: Retrieves a single AI Activity entry for a backlog item operationId: getEntry parameters: - name: itemId in: path required: true schema: type: string - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_AiActivityResource_" /api/backlogitem_channels: get: tags: - Backlog Item Channels summary: List story channels description: List all story channels in the workspace or list by filter criteria 'backlogItemId'. operationId: listBacklogItemChannels parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/BacklogItemChannelFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: List of story channels content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemChannelResource_" "500": description: Unexpected error post: tags: - Backlog Item Channels summary: Create a story channel description: "Create a story channel. Associate the story channel with an existing\ \ Slack channel if the channel id is provided. Otherwise, create a new Slack\ \ channel with the provided channel name." operationId: createBacklogItemChannel requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemChannelCreateResource_" required: true responses: "200": description: Created story channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemChannelResource_" "400": description: Story channel is not created because of invalid argument or Slack API error "404": description: The backlog item is not found "500": description: Unexpected error /api/backlogitem_channels/{id}: get: tags: - Backlog Item Channels summary: Gets a story channel description: Gets a story channel with the associated Slack channel information. operationId: getBacklogItemChannel parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The story's channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemChannelResource_" "404": description: The story channel is not found "500": description: Unexpected error delete: tags: - Backlog Item Channels summary: Deletes a story channel description: Deletes a story channel. This does not impact the associated Slack channel. operationId: deleteBacklogItemChannel parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Story channel deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Story channel was not found "500": description: Unexpected error patch: tags: - Backlog Item Channels summary: Update a story channel description: "Update a story channel. Associate the story channel with an existing\ \ Slack channel if the channel id is provided. Otherwise, create a new Slack\ \ channel with the provided channel name." operationId: updateBacklogItemChannel parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemChannelUpdateResource_" required: true responses: "200": description: Updated story channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemChannelResource_" "400": description: Story is not updated because of invalid argument or Slack API error "404": description: The story channel is not found "500": description: Unexpected error /api/comments: get: tags: - Comments summary: Lists all the comments operationId: listComments parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/CommentController.CommentsFilter" responses: "200": description: listComments 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_CommentResource_" post: tags: - Comments summary: Creates a new comment operationId: createComment requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_CommentCreationResource_" required: true responses: "200": description: createComment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_CommentResource_" /api/comments/{id}: get: tags: - Comments summary: Retrieves a comment by ID operationId: getComment parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query description: Supports UPDATED_BY to include who last updated the comment schema: type: - array - "null" items: $ref: "#/components/schemas/CommentController.InclusionType" responses: "200": description: getComment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_CommentResource_" delete: tags: - Comments summary: Deletes a comment by ID operationId: deleteComment parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: deleteComment 204 response patch: tags: - Comments summary: Updates a comment by ID description: Note that you can not update status to DELETED via the UPDATE operation. operationId: updateComment parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_CommentUpdateResource_" required: true responses: "200": description: updateComment 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_CommentResource_" /api/dashboard_widgets: get: tags: - Dashboard Widgets summary: Retrieve all dashboard widgets for the current user operationId: getAllDashboardWidgets parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/DashboardWidgetController.InclusionType" responses: "200": description: getAllDashboardWidgets 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_DashboardWidgetResource_" post: tags: - Dashboard Widgets summary: Creates a single dashboard widget operationId: createDashboardWidget requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_DashboardWidgetCreationResource_" required: true responses: "200": description: createDashboardWidget 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_DashboardWidgetResource_" /api/dashboard_widgets/batch: patch: tags: - Dashboard Widgets summary: Update the attributes of multiple dashboard widgets description: "Supports mass update of widgets positioning and sizing attributes\ \ (row, col, width, height)" operationId: batchUpdateDashboardWidgets requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_DashboardWidgetResource_" required: true responses: "200": description: batchUpdateDashboardWidgets 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_DashboardWidgetResource_" /api/dashboard_widgets/{id}: delete: tags: - Dashboard Widgets summary: Deletes a dashboard widget by ID operationId: deleteTimeline parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: deleteTimeline 204 response /api/environments: get: tags: - Environments summary: List all environments description: List all available environments operationId: listEnvironments parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/EnvironmentController.InclusionType" responses: "200": description: All environments content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_EnvironmentResource_" "500": description: Unexpected error post: tags: - Environments summary: Create an environment description: Create an environment operationId: createEnvironment requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_EnvironmentCreateResource_" required: true responses: "200": description: The environment content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EnvironmentResource_" "409": description: An environment with the same code already exist. "500": description: Unexpected error /api/environments/{id}: get: tags: - Environments summary: Get an environment description: Get an environment operationId: getEnvironment parameters: - name: id in: path required: true schema: type: string - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/EnvironmentController.InclusionType" responses: "200": description: An environment content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EnvironmentResource_" "404": description: Environment not found "500": description: Unexpected error delete: tags: - Environments summary: Delete an environment description: Delete an environment operationId: deleteEnvironment parameters: - name: id in: path required: true schema: type: string responses: "204": description: No Content "500": description: Unexpected error patch: tags: - Environments summary: Update an environment description: Update an environment operationId: updateEnvironment parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_EnvironmentUpdateResource_" required: true responses: "200": description: The environment content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EnvironmentResource_" "404": description: Environment not found "409": description: An environment with the same code already exist. "500": description: Unexpected error /api/feature/evaluations/attributes/{environment}/location: get: tags: - Feature Flag Slice Attributes summary: List location attribute values description: "List locations, showing those that have been evaluated recently\ \ first." operationId: listLocationAttributeValues parameters: - name: environment in: path required: true schema: type: string format: uuid responses: "200": description: List of location attributes content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SliceLocationValueResource_" "500": description: Unexpected error /api/feature/evaluations/attributes/{environment}/{key}: get: tags: - Feature Flag Slice Attributes summary: List attribute values description: List known values for an attribute operationId: listAttributeValues parameters: - name: environment in: path required: true schema: type: string format: uuid - name: key in: path required: true schema: type: string responses: "200": description: Known values for an attribute content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SliceAttributeValueResource_" "500": description: Unexpected error /api/feature/flags: get: tags: - Feature Flags summary: List Flag description: List feature flags operationId: listFeatureFlags parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/FeatureFlagController.InclusionType" - name: with-metrics in: query required: true schema: type: array items: $ref: "#/components/schemas/FeatureFlagController.MetricType" - name: filter in: query required: true schema: $ref: "#/components/schemas/FeatureFlagController.FlagListFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: List of feature flag content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FeatureFlagResource_" "500": description: Unexpected error post: tags: - Feature Flags summary: Create a Flag description: Create a feature flag operationId: createFeatureFlag requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_FeatureFlagCreateResource_" required: true responses: "200": description: The flag content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FeatureFlagResource_" "404": description: One or more backlog items couldn't be found. "409": description: A flag with the same key already exist. "500": description: Unexpected error /api/feature/flags/{id}: get: tags: - Feature Flags summary: Get a Flag description: Get a feature flag operationId: getFeatureFlag parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/FeatureFlagController.InclusionType" - name: with-metrics in: query required: true schema: type: array items: $ref: "#/components/schemas/FeatureFlagController.MetricType" - name: filter in: query required: true schema: $ref: "#/components/schemas/FeatureFlagController.SingleFlagFilter" responses: "200": description: The flag requested content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FeatureFlagResource_" "404": description: The flag couldn't be found "500": description: Unexpected error delete: tags: - Feature Flags summary: Delete a flag description: Delete a flag operationId: deleteFeatureFlag parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: No Content "500": description: Unexpected error patch: tags: - Feature Flags summary: Update a Flag description: Update a feature flag operationId: updateFeatureFlag parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_FeatureFlagUpdateResource_" required: true responses: "200": description: The flag updated content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FeatureFlagResource_" "404": description: The flag to update were couldn't be found "500": description: Unexpected error /api/feature/flags/{id}/relationships/flippers: get: tags: - Feature Flags summary: Get Flag's Flippers description: Get a flag's flippers relationship operationId: getTeamsRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The flag's flippers content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "404": description: The flag couldn't be found "500": description: Unexpected error patch: tags: - Feature Flags summary: Update Flag's Flippers description: Update a flag's flippers relationship operationId: updateFlippersRelationship parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: The flag's updated flippers content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "404": description: The flag to update were couldn't be found "500": description: Unexpected error /api/feature/flags/{id}/relationships/owners: get: tags: - Feature Flags summary: Get Flag's Owners description: Get a flag's owners relationship operationId: getOwnersRelationship parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The flag's owners content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "404": description: The flag couldn't be found "500": description: Unexpected error patch: tags: - Feature Flags summary: Update Flag's Owners description: Update a flag's owners relationship operationId: updateOwnersRelationship parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: The flag's updated owners content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "404": description: The flag to update were couldn't be found "500": description: Unexpected error /api/feature/rules/batch: patch: tags: - Feature Flag Rules summary: Batch update Flag Rules description: Update the rules for a flag in multiple environments operationId: bulkUpdateFlagRules requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_FlagRuleUpdateResource_" required: true responses: "200": description: The rules were updated successfully content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FlagRulesetResource_" "400": description: A ruleset is present more than once. "404": description: The environment and flag combination could not be found. "500": description: Unexpected error /api/feature/rules/{environment}: get: tags: - Feature Flag Rules summary: List all flags rules in an environment description: List the variant rules for all flags in an environment operationId: listFlagRules parameters: - name: environment in: path required: true schema: type: string responses: "200": description: A list of variant rules for all flags in the environment content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FlagRulesetResource_" "404": description: The environment could not be found. "500": description: Unexpected error /api/feature/rules/{environment}/{flag}: get: tags: - Feature Flag Rules summary: Get a Flag's Ruleset description: Get the ruleset for a flag operationId: getFlagRule parameters: - name: environment in: path required: true schema: type: string - name: flag in: path required: true schema: type: string format: uuid responses: "200": description: The ruleset for the current flag content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FlagRulesetResource_" "404": description: The environment and flag combination could not be found. "500": description: Unexpected error patch: tags: - Feature Flag Rules summary: Update a Flag's Ruleset description: Update the ruleset for a flag in an environment operationId: updateFlagRule parameters: - name: environment in: path required: true schema: type: string - name: flag in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_FlagRuleUpdateResource_" required: true responses: "200": description: The ruleset was updated successfully content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FlagRulesetResource_" "404": description: The environment and flag combination could not be found. "500": description: Unexpected error /api/followed_items: get: tags: - Followed Items summary: List followed items description: List all items followed by the current user operationId: listFollowedItems responses: "200": description: The list of followed items content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FollowedItemResource_" "500": description: Unexpected error post: tags: - Followed Items summary: Follow item description: Add an item to the list of followed items for the current user operationId: followItem requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_FollowedItemCreationResource_" required: true responses: "200": description: The item was added to users' list of followed items content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FollowedItemResource_" "404": description: The item to follow could not be found in the workspace "500": description: Unexpected error delete: tags: - Followed Items summary: Unfollow items description: Removes items from the list of followed items for the current user using a filter expression operationId: unfollowItems parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/FollowedItemController.DeleteFilter" responses: "204": description: The item was successfully unfollowed "400": description: No filter was provided "404": description: The item to unfollow could not be found in the workspace "500": description: Unexpected error /api/followed_items/{id}: delete: tags: - Followed Items summary: Unfollow item description: Removes an item from the list of followed items for the current user operationId: unfollowItem parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: The item was successfully unfollowed "404": description: The following id does not exist "500": description: Unexpected error /api/glossaries: get: tags: - Glossaries summary: List glossaries in the workspace description: List glossaries that are part of the workspace. operationId: listGlossaries responses: "200": description: List of glossaries in the workspace content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_GlossaryResource_" "500": description: Unexpected error post: tags: - Glossaries summary: Create a glossary and start crawling job operationId: createGlossary requestBody: description: The glossary to create. content: application/json: schema: $ref: "#/components/schemas/Request_GlossaryCreationResource_" required: true responses: "200": description: Successfully created the glossary. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryResource_" links: self: operationId: fetchGlossary parameters: id: $response.body#/data/id update: operationId: updateGlossary parameters: id: $response.body#/data/id delete: operationId: deleteGlossary parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to create a new glossary. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossaries/upload_url: get: tags: - Glossaries summary: Request URL for the client to upload a TSV file for a glossary description: This is not a JSON:API endpoint. operationId: getGlossaryUploadUrl parameters: - name: filename in: query required: true schema: type: string responses: "200": description: Pre-signed upload URL content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_PreSignedUrl_" "404": description: Glossary not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossaries/{glossaryId}/relationships/entries: get: tags: - Glossaries summary: List entries description: List all entries of a glossary operationId: listGlossaryEntries parameters: - name: glossaryId in: path required: true schema: type: string format: uuid responses: "200": description: List of glossary entries content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_GlossaryEntryResource_" "500": description: Unexpected error post: tags: - Glossaries summary: Create a glossary entry operationId: createGlossaryEntry parameters: - name: glossaryId in: path required: true schema: type: string format: uuid requestBody: description: The glossary entry to create. content: application/json: schema: $ref: "#/components/schemas/Request_GlossaryEntryCreationResource_" required: true responses: "200": description: The glossary term that was created content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryEntryResource_" "403": description: The authenticated user does not have permission to create a new glossary. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossaries/{glossaryId}/relationships/entries/applyDiff: post: tags: - Glossaries summary: Apply a diff to glossary entries description: "Applies an ordered list of create, update, and delete operations\ \ to the entries of a glossary. Multiple operations on the same term are accumulated\ \ and applied as a single write." operationId: applyGlossaryEntryDiff parameters: - name: glossaryId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryEntryDiffResource_" required: true responses: "200": description: Saved entries with any partial errors in the errors field content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Glossary not found /api/glossaries/{glossaryId}/relationships/entries/{id}: get: tags: - Glossaries summary: Get a glossary entry operationId: getGlossaryEntry parameters: - name: glossaryId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: "200": description: A glossary entry content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryEntryResource_" "500": description: Unexpected error delete: tags: - Glossaries summary: Delete a Glossary Entry operationId: deleteGlossaryEntry parameters: - name: glossaryId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: "204": description: deleteGlossaryEntry 204 response patch: tags: - Glossaries summary: Update a glossary entry by ID description: Update a glossary entry by its ID. operationId: updateGlossaryEntry parameters: - name: glossaryId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_GlossaryEntryUpdateResource_" required: true responses: "200": description: The updated glossary entry content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryEntryResource_" "400": description: Id in the path and in the body do not match "404": description: Glossary entry not found "500": description: Unexpected error /api/glossaries/{id}: get: tags: - Glossaries summary: Get a glossary by its id description: Get a specific glossary by its id. operationId: fetchGlossary parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Successfully retrieved the glossary. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryResource_" "404": description: Glossary not found. "500": description: Unexpected error delete: tags: - Glossaries summary: Delete a glossary by its id operationId: deleteGlossary parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Glossary deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "500": description: Unexpected error patch: tags: - Glossaries summary: Update a glossary operationId: updateGlossary parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: description: The glossary attributes to update. content: application/json: schema: $ref: "#/components/schemas/Request_GlossaryUpdateResource_" required: true responses: "200": description: Successfully updated the glossary. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_GlossaryResource_" links: self: operationId: fetchGlossary parameters: id: $response.body#/data/id delete: operationId: deleteGlossary parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to update this glossary. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Glossary not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossaries/{id}/relationships/contributors: patch: tags: - Glossaries summary: Update glossary contributors relationship operationId: updateGlossaryContributorsRelationship parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: description: The contributors relationship data. content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: Successfully updated the glossary contributors relationship. content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "403": description: The authenticated user does not have permission to update this Glossary. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Glossary not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossaries/{id}/relationships/owners: patch: tags: - Glossaries summary: Update glossary owners relationship operationId: updateGlossaryOwnersRelationship parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: description: The owners relationship data. content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: Successfully updated the glossary owners relationship. content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" "403": description: The authenticated user does not have permission to update this glossary. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Glossary not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/glossary/permission: get: tags: - Glossaries summary: Check the current user has permissions to perform actions on given glossary operationId: listPermissions parameters: - name: principalIsContributor in: query schema: type: - boolean - "null" - name: principalIsOwner in: query schema: type: - boolean - "null" responses: "200": description: listPermissions 200 response content: application/json: schema: type: array items: type: string /api/glossary/permission/{action}: get: tags: - Glossaries summary: Check if the current user has permissions to perform action on given glossary operationId: hasPermission parameters: - name: action in: path required: true schema: type: string - name: principalIsContributor in: query schema: type: - boolean - "null" - name: principalIsOwner in: query schema: type: - boolean - "null" responses: "200": description: hasPermission 200 response content: application/json: schema: type: boolean /api/history/backlog_items/{id}: get: tags: - History and Change Tracking summary: Retrieves the change history of a backlog item description: "Retrieves the change history of a backlog item identified by the\ \ given ID. The history is paginated and can be filtered by the field that\ \ has changed, The filter[changed] parameter supports multiple fields separated\ \ by `&` (%26)." operationId: backlogItemHistory parameters: - name: id in: path required: true schema: type: string format: uuid - name: filter in: query required: true schema: $ref: "#/components/schemas/BacklogItemHistoryFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: backlogItemHistory 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemChangeSetResource_" /api/history/flags: get: tags: - History and Change Tracking operationId: featureFlagHistory parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/FeatureFlagHistoryFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: featureFlagHistory 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FeatureFlagChangeSetResource_" /api/history/flags/{id}: get: tags: - History and Change Tracking summary: Retrieves the change history of a feature flag description: "Retrieves the change history of a feature flag identified by the\ \ given ID. The history is paginated and can be filtered by the field that\ \ has changed, The filter[changed] parameter supports multiple fields separated\ \ by `&` (%26)." operationId: featureFlagHistoryById parameters: - name: id in: path required: true schema: type: string format: uuid - name: filter in: query required: true schema: $ref: "#/components/schemas/FeatureFlagHistoryFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: featureFlagHistoryById 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FeatureFlagChangeSetResource_" /api/integrations: get: tags: - Integrations operationId: listWorkspaceIntegrations parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/IntegrationController.WorkspaceIntegrationFilter" responses: "200": description: listWorkspaceIntegrations 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkspaceIntegrationResource_" /api/integrations/shared: get: tags: - Integrations operationId: listSharedIntegrations parameters: - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: listSharedIntegrations 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SharedIntegrationResource_" /api/integrations/shared/{id}: get: tags: - Integrations operationId: getSharedIntegration parameters: - name: id in: path description: The UUID or key of a shared integration. required: true schema: type: string example: atono.shared-integration.github-integration responses: "200": description: getSharedIntegration 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SharedIntegrationResource_" /api/integrations/shared/{id}/install: post: tags: - Integrations operationId: updateSharedIntegration parameters: - name: id in: path description: The UUID or key of a shared integration. required: true schema: type: string example: atono.shared-integration.github-integration responses: "200": description: updateSharedIntegration 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkspaceIntegrationResource_" /api/integrations/synced_jira_spaces: get: tags: - Jira Integration summary: List synced Jira spaces description: List all synced Jira space-to-team mappings. operationId: listJiraSpaces parameters: - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: List of synced Jira spaces content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SyncedJiraSpaceResource_" "404": description: Jira Sync integration not found "500": description: Unexpected error post: tags: - Jira Integration summary: Create a synced Jira space description: Create a new synced Jira space-to-team mapping. operationId: createJiraSpace requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SyncedJiraSpaceCreateResource_" required: true responses: "200": description: The created synced Jira space content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SyncedJiraSpaceResource_" "400": description: Invalid request or duplicate mapping "404": description: Team or Jira Sync integration not found "500": description: Unexpected error /api/integrations/synced_jira_spaces/{id}: get: tags: - Jira Integration summary: Get a synced Jira space description: Get a synced Jira space-to-team mapping by ID. operationId: getJiraSpace parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The synced Jira space content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SyncedJiraSpaceResource_" "404": description: The synced Jira space or integration is not found "500": description: Unexpected error delete: tags: - Jira Integration summary: Delete a synced Jira space description: Soft-delete a synced Jira space-to-team mapping. operationId: deleteJiraSpace parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: synced Jira space deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: synced Jira space or integration was not found "500": description: Unexpected error patch: tags: - Jira Integration summary: Update a synced Jira space description: Update a synced Jira space's team mapping. operationId: updateJiraSpace parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SyncedJiraSpaceUpdateResource_" required: true responses: "200": description: The updated synced Jira space content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SyncedJiraSpaceResource_" "400": description: Invalid request or team already mapped "404": description: "Synced Jira space, team, or integration not found" "500": description: Unexpected error /api/integrations/{id}: get: tags: - Integrations operationId: getWorkspaceIntegrations parameters: - name: id in: path description: The UUID of a workspace integration. required: true schema: type: string format: uuid example: d9e8f7a2-3c4b-11ec-8d3d-0242ac130003 responses: "200": description: getWorkspaceIntegrations 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkspaceIntegrationResource_" delete: tags: - Integrations operationId: revokeWorkspaceIntegrations parameters: - name: id in: path description: The UUID of a workspace integration. required: true schema: type: string format: uuid example: d9e8f7a2-3c4b-11ec-8d3d-0242ac130003 responses: "200": description: revokeWorkspaceIntegrations 200 response patch: tags: - Integrations operationId: updateWorkspaceIntegrations parameters: - name: id in: path description: The UUID of a workspace integration. required: true schema: type: string format: uuid example: d9e8f7a2-3c4b-11ec-8d3d-0242ac130003 requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkspaceIntegrationUpdateResource_" required: true responses: "200": description: updateWorkspaceIntegrations 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkspaceIntegrationResource_" /api/item_types/{itemType}/personas: get: tags: - Backlog Items operationId: listPersonas parameters: - name: itemType in: path required: true schema: $ref: "#/components/schemas/BacklogItem.ItemType" responses: "200": description: listPersonas 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_PersonaItemResource_" /api/jobs/backlog_items/split_story: post: tags: - Backlog Item Handling Jobs summary: Create a Split Story job operationId: createSplitStoryJob requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SplitStoryJobCreationResource_" required: true responses: "200": description: createSplitStoryJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SplitStoryJobResource_" /api/jobs/backlog_items/split_story/{id}: get: tags: - Backlog Item Handling Jobs summary: Get the Split Story job by id operationId: getSplitStoryJob parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getSplitStoryJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SplitStoryJobResource_" delete: tags: - Backlog Item Handling Jobs summary: Delete a Split Story job operationId: deleteSplitStoryJob parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteSplitStoryJob 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Backlog Item Handling Jobs summary: Update a Split Story job operationId: updateSplitStoryJob parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SplitStoryJobUpdateResource_" required: true responses: "200": description: updateSplitStoryJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SplitStoryJobResource_" /api/jobs/backlog_items/tagging: post: tags: - Backlog Item Handling Jobs operationId: scheduleJob requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemsTaggingJobResource_" required: true responses: "200": description: scheduleJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemsTaggingJobResponse_" /api/jobs/backlog_items/team_change_preview: post: tags: - Backlog Item Handling Jobs summary: Preview tag changes for team reassignment description: | Previews which tags will be affected when a backlog item is reassigned to a different team. Team-scoped tags on the backlog item are analyzed: - **matchedTags**: Tags that will be retained because the destination team has a tag with matching key AND value (case-insensitive comparison) - **droppedTags**: Tags that will be removed because no matching tag exists in the destination team (either key or value mismatch) Workspace-scoped tags are not affected by team changes and are not included in the preview. operationId: previewTeamChange requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TeamChangePreviewResource_" required: true responses: "200": description: previewTeamChange 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamChangePreviewResultResource_" /api/jobs/backlog_items/untagging: post: tags: - Backlog Item Handling Jobs operationId: scheduleUntaggingJob requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_BacklogItemsUntaggingJobResource_" required: true responses: "200": description: scheduleUntaggingJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BacklogItemsUntaggingJobResponse_" /api/jobs/create_users: post: operationId: scheduleJob_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_CreateUsersJobResource_" required: true responses: "200": description: scheduleJob_1 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_CreateUsersJobResponse_" /api/jobs/delete_user: post: operationId: scheduleDeleteUsersJob requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_DeleteUserJobResource_" required: true responses: "200": description: scheduleDeleteUsersJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_DeleteUserJobResponse_" /api/jobs/import: get: tags: - Import Jobs summary: Get all the import jobs operationId: listImportJobs parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/ImportJobController.RequestFilter" responses: "200": description: listImportJobs 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ImportJobResource_" post: tags: - Import Jobs summary: Create an import job operationId: createImportJob requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ImportJobCreationResource_" required: true responses: "200": description: createImportJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ImportJobResource_" /api/jobs/import/jira/spaces: get: tags: - Import Jobs summary: Get available Jira spaces operationId: getJiraSpaces parameters: - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: getJiraSpaces 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_JiraSpaceResource_" /api/jobs/import/upload_url: get: tags: - Import Jobs summary: Request URL for the client to upload an import file description: This is not a JSON:API endpoint operationId: getUploadUrl_1 parameters: - name: filename in: query required: true schema: type: string responses: "200": description: getUploadUrl_1 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_PreSignedUrl_" /api/jobs/import/{id}: get: tags: - Import Jobs summary: Get the import job by id operationId: getImportJob parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getImportJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ImportJobResource_" delete: tags: - Import Jobs summary: Delete an import job operationId: deleteImportJob parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteImportJob 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Import Jobs summary: Update an import job operationId: updateImportJob parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ImportJobUpdateResource_" required: true responses: "200": description: updateImportJob 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ImportJobResource_" /api/jobs/jira/sync: post: tags: - Jira Integration operationId: scheduleJob_2 requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_JiraSyncJobResource_" required: true responses: "200": description: scheduleJob_2 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_JiraSyncJobResponse_" /api/keys/{id}: get: tags: - Api Keys summary: Retrieve an API key description: Retrieve an API key operationId: fetchKey parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: An API Key content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ApiKeyResource_" "404": description: Api Key not found "500": description: Unexpected error delete: tags: - Api Keys summary: Delete an API key description: Delete an API key operationId: deleteKey parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: No Content "500": description: Unexpected error /api/locations: get: tags: - Locations summary: List locations description: List location entries. operationId: listLocations responses: "200": description: List of locations content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_LocationResource_" "500": description: Unexpected error /api/locations/{id}: get: tags: - Locations summary: Get a location by ID description: Get a location by its ID. operationId: fetchLocation parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: A location content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_LocationResource_" "500": description: Unexpected error /api/login: post: tags: - Auth flow summary: Starts a person's login process description: On a successful execution email user their login link operationId: login requestBody: content: application/json: schema: $ref: "#/components/schemas/LoginRequest" required: true responses: "400": description: Invalid email supplied. Only returned when verbose errors are enabled "500": description: Unexpected error "200": description: Magic link set /api/login/magic-link: get: tags: - Auth flow summary: Completes a person's login process description: Produces a JWT token to be used to access API operationId: loginWithMagicLink parameters: - name: magic in: query required: true schema: type: string responses: "400": description: Invalid magic link supplied "500": description: Unexpected error "200": description: Tokens issued content: application/json: schema: $ref: "#/components/schemas/LoginResponse" /api/login/refresh: post: tags: - Auth flow summary: Refreshes tokens description: Produces a JWT token to be used to access API operationId: refresh requestBody: content: application/json: schema: $ref: "#/components/schemas/RefreshTokenRequest" required: true responses: "400": description: Invalid refresh token supplied "500": description: Unexpected error "200": description: Tokens issued content: application/json: schema: $ref: "#/components/schemas/LoginResponse" /api/login/verification: post: tags: - Auth flow summary: Verifies a user's email description: Produces a JWT token to be used to access API operationId: verify requestBody: content: application/json: schema: $ref: "#/components/schemas/VerificationRequest" required: true responses: "400": description: Invalid verification supplied "500": description: Unexpected error "200": description: Tokens issued content: application/json: schema: $ref: "#/components/schemas/LoginResponse" /api/product_themes: get: tags: - Product Themes summary: List Product Themes description: Lists all product themes. operationId: listProductThemes parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/ProductThemeController.InclusionType" responses: "200": description: List of product themes content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ProductThemeResource_" "500": description: Unexpected error post: tags: - Product Themes summary: Create Product Theme description: Creates a new product theme. operationId: createProductTheme requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ProductThemeCreationResource_" required: true responses: "200": description: Product theme created content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ProductThemeResource_" "401": description: One or more of the associated stories are inaccessible "404": description: One or more of the associated stories are not found "500": description: Unexpected error /api/product_themes/{id}: get: tags: - Product Themes summary: Fetch Product Theme description: Fetch a product theme. operationId: getProductTheme parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/ProductThemeController.InclusionType" responses: "200": description: The product themes content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ProductThemeResource_" "404": description: Product themes not found "500": description: Unexpected error delete: tags: - Product Themes summary: Delete Product Theme description: Delete a new product theme. operationId: deleteProductTheme parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Product theme deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Product theme not found "500": description: Unexpected error patch: tags: - Product Themes summary: Update Product Theme description: Update a new product theme. operationId: updateProductTheme parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ProductThemeUpdateResource_" required: true responses: "200": description: Product theme updated content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ProductThemeResource_" "401": description: One or more associated stories are inaccessible "404": description: The product theme or some of its associated stories are not found "500": description: Unexpected error /api/rating/impacts: get: tags: - Risk Ratings summary: List all bug impacts description: List all available bug impacts operationId: listImpacts responses: "200": description: All bug impacts content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ImpactResource_" /api/rating/probabilities: get: tags: - Risk Ratings summary: List all bug probabilities description: List all available bug probabilities operationId: listProbabilities responses: "200": description: All bug probabilities content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ProbabilityResource_" /api/release_markers: get: tags: - Release Markers summary: Retrieves a list of release markers operationId: getMarkers parameters: - name: filter in: query description: | Filter for release markers. - filter[date]: pipe-separated time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z schema: type: - "null" - object allOf: - $ref: "#/components/schemas/ReleaseMarkerController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: getMarkers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ReleaseMarkerResource_" post: tags: - Release Markers summary: Creates a new release marker operationId: createMarker requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ReleaseMarkerCreationResource_" required: true responses: "200": description: createMarker 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ReleaseMarkerResource_" /api/release_markers/{id}: get: tags: - Release Markers summary: Retrieves a specific release marker by ID operationId: getMarker parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/ReleaseMarkerController.InclusionType" - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getMarker 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ReleaseMarkerResource_" delete: tags: - Release Markers summary: Deletes a specific release marker by ID operationId: deleteMarker parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteMarker 200 response patch: tags: - Release Markers summary: Updates a specific release marker by ID operationId: updateMarker parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ReleaseMarkerUpdateResource_" required: true responses: "200": description: updateMarker 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ReleaseMarkerResource_" /api/roles: get: tags: - Roles summary: List all user roles description: List all available user roles operationId: listRoles responses: "200": description: All user roles content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_RoleResource_" "500": description: Unexpected error /api/saved_views: get: tags: - Saved Views summary: Retrieve all saved views in the workspace operationId: getAllSavedViews parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SavedViewController.InclusionType" - name: filter in: query required: true schema: $ref: "#/components/schemas/SavedViewController.SavedViewRequestFilter" responses: "200": description: getAllSavedViews 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SavedViewResource_" post: tags: - Saved Views summary: Creates a saved view operationId: createSavedView requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SavedViewCreationResource_" required: true responses: "200": description: createSavedView 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SavedViewResource_" /api/saved_views/{id}: get: tags: - Saved Views summary: Retrieve a saved view by its ID operationId: getSavedView parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SavedViewController.InclusionType" responses: "200": description: getSavedView 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SavedViewResource_" delete: tags: - Saved Views summary: Delete a saved view operationId: deleteSavedView parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteSavedView 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Saved Views summary: Update a saved view by ID operationId: updateSavedView parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SavedViewUpdateResource_" required: true responses: "200": description: updateSavedView 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SavedViewResource_" /api/saved_views/{id}/sharedTeams: get: tags: - Saved Views operationId: getSavedViewSharedTeams parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SavedViewController.InclusionType" responses: "200": description: getSavedViewSharedTeams 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SavedViewTeamResource_" patch: tags: - Saved Views operationId: updateSharedTeams parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateSharedTeams 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SavedViewTeamResource_" /api/saved_views/{id}/sharedUsers: get: tags: - Saved Views operationId: getSavedViewSharedUsers parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SavedViewController.InclusionType" responses: "200": description: getSavedViewSharedUsers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SavedViewUserResource_" patch: tags: - Saved Views operationId: updateSharedUsers parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateSharedUsers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SavedViewUserResource_" /api/search/autocomplete: get: tags: - Search summary: Autocomplete the search term description: "This is not a JSON:API endpoint, as the returned string is not\ \ a resource in the system." operationId: autocompleteSearchTerm parameters: - name: term in: query required: true schema: type: string responses: "200": description: autocompleteSearchTerm 200 response content: application/json: schema: type: string /api/search/backlog_items: get: tags: - Search summary: Find backlog items operationId: findBacklogItems parameters: - name: filter in: query description: | Filter for backlog items. Notes about specific filter parameters - filter[handle]: if specified, filter by handle is applied first to perform a lookup by handle. - filter[assigneeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[keywordSearch]: Find backlog items that match the given string. Case insensitive. Matches both handle and title portions. - filter[createdAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[doneAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[updatedAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z - filter[environmentIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[epicIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[excludeTagIds]: pipe-separated list of tag UUIDs to exclude items that have any value from these tags - filter[excludeTagValueIds]: pipe-separated list of tag value UUIDs to exclude items with these specific tag values - filter[externalId]: pipe-separated list of a hasExternalId flag and an optional keyword search, e.g. 'true|HOTH', 'false' - filter[productThemeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[riskRating]: pipe-separated range of integers, e.g. 2|24 or 'NONE', - filter[sizeIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[stepIds]: pipe-separated list of valid UUIDs only - filter[stepExpressions]: Filter with an expression that identify one or more step names within a step category. Case insensitive. Repeatable parameter to filter by more than one step category. - filter[tagIds]: pipe-separated list of tag UUIDs to filter items that have any value from these tags - filter[tagValueIds]: pipe-separated list of tag value UUIDs to filter items with these specific tag values - filter[teamIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[timeboxIds]: pipe-separated list of UUIDs, can include 'NONE' - filter[triageGroup]: The only supported value is 'TRIAGE' - filter[type]: pipe-separated list of ItemType values, e.g. 'STORY|BUG' or single value 'STORY' required: true schema: $ref: "#/components/schemas/SearchController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/CursorPageFilter" responses: "200": description: findBacklogItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" /api/search/conversation: get: tags: - Search summary: Retrieve the user conversation with the bot operationId: getConversation_1 responses: "200": description: getConversation_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ConversationResource_" post: tags: - Search summary: Send a user query to the bot operationId: postMessage_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_ConversationCreationResource_" required: true responses: "200": description: postMessage_1 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ConversationResource_" delete: tags: - Search summary: Remove the user conversation with the bot operationId: deleteConversation_1 responses: "200": description: deleteConversation_1 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/search/related_items: get: tags: - Search summary: Find items that could be related to this item operationId: searchRelatedItems parameters: - name: itemId in: query required: true schema: type: string format: uuid - name: maxResults in: query schema: type: - integer - "null" format: int32 maximum: 10 minimum: 1 responses: "200": description: searchRelatedItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" post: tags: - Search summary: Find items that could be related to the content posted operationId: searchRelatedItemsForDraft requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_RelatedItemsSearchResource_" required: true responses: "200": description: searchRelatedItemsForDraft 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" /api/search/similar_item: get: tags: - Search summary: Find item that is very similar to this item current and could be a duplicate operationId: searchVerySimilarItem parameters: - name: itemId in: query required: true schema: type: string format: uuid responses: "200": description: searchVerySimilarItem 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" post: tags: - Search summary: Find item that is very similar to the content posted and could be a duplicate operationId: searchVerySimilarItemsForDraft requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_RelatedItemsSearchResource_" required: true responses: "200": description: searchVerySimilarItemsForDraft 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" /api/sign-up: post: tags: - Auth flow summary: Sings up a new user/workspace description: "Provisions a new workspace, creates a user in it and initiates\ \ the Email validation flow" operationId: signup requestBody: content: application/json: schema: $ref: "#/components/schemas/SignUpRequest" required: true responses: "400": description: Invalid email or workspace name supplied "500": description: Unexpected error "200": description: Acknowledgement of the request content: application/json: schema: $ref: "#/components/schemas/SignUpResponse" /api/slack/connect: get: tags: - Slack Integration summary: Generate a slack app connect URL description: Generate a slack app connect URL to connect user to their slack workspace. operationId: connect responses: "200": description: URL to connect slack app content: application/json: schema: $ref: "#/components/schemas/AtonoSlackAppInstallationResponse" "500": description: Unexpected error /api/slack/install: get: tags: - Slack Integration summary: Generate a slack app install URL description: Generate a slack app install URL to start the Atono slack app installation process. operationId: install responses: "200": description: URL to install slack app content: application/json: schema: $ref: "#/components/schemas/AtonoSlackAppInstallationResponse" "500": description: Unexpected error /api/slack/oauth_redirect: get: tags: - Slack Integration summary: Handle slack app oauth redirect description: Hande slack app oauth redirect and exchange verification code for access token. operationId: oauthRedirect parameters: - name: code in: query schema: type: - string - "null" - name: state in: query schema: type: - string - "null" - name: error in: query schema: type: - string - "null" responses: "302": description: Redirect to the Atono workspace settings page /api/slack_connections: get: tags: - Slack Integration summary: List user connections description: List user connections to Slack integration. operationId: listSlackConnections parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/SlackConnectionFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: List of user connections to Slack integration content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SlackConnectionResource_" "400": description: Slack integration disabled "500": description: Unexpected error post: tags: - Slack Integration summary: Create a slack connection with reminder date description: Create a slack connection with reminder date. Connection needs to be enabled separately. operationId: createSlackConnection requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SlackConnectionCreateResource_" required: true responses: "200": description: Created slack connection content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SlackConnectionResource_" "400": description: Not created because of invalid argument or Slack API error "500": description: Unexpected error /api/slack_connections/{id}: get: tags: - Slack Integration summary: List user connections description: List user connections to Slack integration. operationId: getSlackConnection parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of Slack channels content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SlackConnectionResource_" "400": description: Slack integration disabled "500": description: Unexpected error delete: tags: - Slack Integration summary: Removes the slack connection description: Removes the slack connection. operationId: deleteSlackConnection parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Slack integration disabled content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Slack integration not found "500": description: Unexpected error patch: tags: - Slack Integration summary: Update a slack connection with reminder date description: Update a slack connection with reminder date. Connection needs to be enabled separately. operationId: updateSlackConnection parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SlackConnectionUpdateResource_" required: true responses: "200": description: Created slack connection content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SlackConnectionResource_" "400": description: Not created because of invalid argument or Slack API error "500": description: Unexpected error /api/slack_integrations: get: tags: - Slack Integration summary: List slack integration description: List slack integration enabled for Atono workspace operationId: getIntegration responses: "200": description: Slack integration list content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SlackIntegrationResource_" "500": description: Unexpected error /api/slack_integrations/channels: get: tags: - Slack Integration summary: List Slack channels description: List Slack channels from the enabled Slack integration. operationId: listSlackChannels parameters: - name: page in: query required: true schema: $ref: "#/components/schemas/CursorPageFilter" responses: "200": description: List of Slack channels content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SlackChannelResource_" "400": description: Slack integration disabled "500": description: Unexpected error /api/slack_integrations/channels/{id}: get: tags: - Slack Integration summary: 'Get a Slack channel ' description: Get info of a Slack channel by Slack channel id from the enabled Slack integration. operationId: getSlackChannel parameters: - name: id in: path required: true schema: type: string responses: "200": description: The Slack channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SlackChannelResource_" "400": description: Slack channel not found or user has no access to the channel "500": description: Unexpected error /api/slack_integrations/channels/{id}/relationships/members: get: tags: - Slack Integration summary: Gets a list of Atono users who are the Slack channel's members description: Gets a list of Atono users who have opt-ed into Slack and who are the Slack channel's members. operationId: getSlackChannelMembers parameters: - name: id in: path required: true schema: type: string responses: "200": description: The Atono users in the Slack channel content: application/json: schema: type: array items: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: Slack channel not found or user has no access to the channel "500": description: Unexpected error /api/slack_integrations/{id}: delete: tags: - Slack Integration summary: Disables slack integration description: Disables the slack integration from Atono workspace. operationId: disableIntegration parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Slack integration disabled content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Slack integration not found "500": description: Unexpected error /api/sso: get: tags: - SSO operationId: getSsoConfigurationByWorkspaceName parameters: - name: email in: query required: true schema: type: string minLength: 1 responses: "200": description: getSsoConfigurationByWorkspaceName 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SsoConfigurationResource_" /api/sso/saml: get: tags: - SSO operationId: getSamlSetupSettings responses: "200": description: getSamlSetupSettings 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SsoSamlConfigurationResource_" delete: tags: - SSO summary: Remove a SAML SSO configuration from the workspace description: Remove the configuration for SSO authentication using a third-party SAML identity provider. Requires admin privileges. operationId: deleteSsoConfiguration responses: "201": description: SSO provider configuration removed successfully "401": description: Authentication required "403": description: Admin privileges required "500": description: Failed to configure SSO provider patch: tags: - SSO summary: Setup SSO with SAML for the workspace description: Configure a third-party SAML identity provider for SSO authentication. Requires admin privileges. operationId: updateSsoConfiguration requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SsoSamlConfigurationUpdateResource_" required: true responses: "200": description: SSO provider configured successfully content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SsoSamlConfigurationResource_" "400": description: Invalid request - provider metadata URL not accessible "401": description: Authentication required "403": description: Admin privileges required "500": description: Failed to configure SSO provider /api/subscription: get: summary: Get the workspace's subscription description: Returns the workspace's subscription information operationId: getSubscriptions parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SubscriptionController.SubscriptionInclusionType" responses: "200": description: getSubscriptions 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SubscriptionResource_" /api/subscription/billing: post: summary: Prepares a portal session for the stripe billing page operationId: createBillingPortalSession requestBody: content: application/json: schema: $ref: "#/components/schemas/BillingSessionRequestResource" required: true responses: "200": description: createBillingPortalSession 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BillingSessionResource_" /api/subscription/billing_details: get: summary: Get the customer's billing details operationId: getBillingDetails responses: "200": description: getBillingDetails 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BillingDetailsResource_" /api/subscription/checkout: post: operationId: createCheckoutSession requestBody: content: application/json: schema: $ref: "#/components/schemas/CheckoutSessionRequestResource" required: true responses: "200": description: createCheckoutSession 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_CheckoutSessionResource_" /api/subscription/extend_trial: post: summary: Extend the workspace's free trial by 14 days description: One-time trial extension only accessible to workspace owners operationId: extendTrial responses: "200": description: Trial extended content: application/json: schema: $ref: "#/components/schemas/SubscriptionResource" "400": description: Subscription has already extended or is not a trial "500": description: Unexpected error /api/subscription/invoices: get: summary: Get a list of past invoices for the workspace operationId: getInvoices responses: "200": description: getInvoices 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_InvoiceResource_" /api/subscription/prices: get: summary: Get all available subscription product prices description: Returns all available subscription product prices operationId: getPrices responses: "200": description: getPrices 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_PriceResource_" /api/subscription/prices/{id}: get: summary: Get a subscription product price by ID description: Returns a subscription product price by ID operationId: getPrice parameters: - name: id in: path required: true schema: type: string responses: "200": description: getPrice 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_PriceResource_" /api/subscription/products: get: summary: Get all available subscription products description: Returns all available subscription products operationId: getProducts parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SubscriptionController.ProductInclusionType" responses: "200": description: getProducts 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ProductResource_" /api/subscription/products/{id}: get: summary: Get a subscription product by ID description: Returns a subscription product by ID operationId: getProduct parameters: - name: id in: path required: true schema: type: string responses: "200": description: getProduct 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_ProductResource_" /api/subscription/trial_data: get: summary: Get information for free trials description: "includes trial period, max users, and storage limits" operationId: getTrialData responses: "200": description: getTrialData 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubscriptionMetadataResource_" /api/subscription/{id}: get: summary: Get a subscription by ID description: Returns a subscription by ID operationId: getSubscription parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SubscriptionController.SubscriptionInclusionType" responses: "200": description: getSubscription 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubscriptionResource_" /api/subscription/{id}/items/batch: patch: summary: Update multiple subscription items in a single request description: Updates multiple subscription items operationId: updateSubscriptionItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_SubscriptionItemUpdateResource_" required: true responses: "200": description: updateSubscriptionItems 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SubscriptionItemResource_" /api/tags: get: tags: - Tags summary: List all tags description: "GET /api/tags List all tags with filtering, paging, and sorting" operationId: listTags parameters: - name: filter in: query description: | Filter for tags. - filter[autocomplete]: text search on tag key - filter[keyword]: text search on tag key and tag value - filter[scope]: WORKSPACE (workspace tags only), TEAM (team tags only), or WORKSPACE_AND_TEAM (both). When TEAM or WORKSPACE_AND_TEAM, filter[teamId] is required. - filter[teamId]: UUID of the team. Required when filter[scope] is TEAM or WORKSPACE_AND_TEAM. schema: type: - "null" - object allOf: - $ref: "#/components/schemas/TagController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query schema: type: - array - "null" items: type: string - name: include in: query description: "Optional relationships to include in the response. Use 'CREATOR'\ \ to include user resources, 'TAG_VALUES' to include tag value resources,\ \ 'TEAM' to include team resources for team-scoped tags." schema: type: - array - "null" items: $ref: "#/components/schemas/TagController.InclusionType" responses: "200": description: listTags 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagResource_" post: tags: - Tags summary: Create a new tag description: POST /api/tags Create a new tag with optional initial value and backlog item relationships operationId: createTag requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TagCreationResource_" required: true responses: "200": description: createTag 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagResource_" /api/tags/suggestions: get: tags: - Tag Suggestions summary: Get tag key suggestions description: Returns similar existing tag keys based on fuzzy matching. Use this when creating a new tag to avoid duplicates. operationId: getTagKeySuggestions parameters: - name: keyword in: query description: The keyword to search for similar tag keys required: true schema: type: string - name: filter in: query description: | Filter for tag suggestions. - filter[scope]: WORKSPACE (workspace tags only), TEAM (team tags only), or WORKSPACE_AND_TEAM (both). When TEAM or WORKSPACE_AND_TEAM, filter[teamId] is required. - filter[teamId]: UUID of the team. Required when filter[scope] is TEAM or WORKSPACE_AND_TEAM. schema: type: - "null" - object allOf: - $ref: "#/components/schemas/TagSuggestionController.RequestFilter" responses: "200": description: getTagKeySuggestions 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagSuggestionResource_" /api/tags/tag_creation: get: tags: - Tags summary: Get tag creation settings description: Get the tag creation mode and lists of users who can create tags and tag values operationId: getTagCreationSettings responses: "200": description: getTagCreationSettings 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagCreationSettingsResource_" patch: tags: - Tags summary: Update tag creation settings description: Update the tag creation mode for the workspace operationId: updateTagCreationSettings requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TagCreationSettingsUpdateResource_" required: true responses: "200": description: updateTagCreationSettings 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagCreationSettingsResource_" /api/tags/tag_creation/relationships/tagCreators: get: tags: - Tags summary: Get users who can create tags description: Get the list of users with TAG_CREATOR access level operationId: getTagCreators responses: "200": description: getTagCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" post: tags: - Tags summary: Add users who can create tags description: Add users to the TAG_CREATOR access level operationId: addTagCreators requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: addTagCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" delete: tags: - Tags summary: Remove users who can create tags description: Remove users from the TAG_CREATOR access level operationId: removeTagCreators requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: removeTagCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" /api/tags/tag_creation/relationships/tagValueCreators: get: tags: - Tags summary: Get users who can create tag values description: Get the list of users with TAG_VALUE_CREATOR access level operationId: getTagValueCreators responses: "200": description: getTagValueCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" post: tags: - Tags summary: Add users who can create tag values description: Add users to the TAG_VALUE_CREATOR access level operationId: addTagValueCreators requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: addTagValueCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" delete: tags: - Tags summary: Remove users who can create tag values description: Remove users from the TAG_VALUE_CREATOR access level operationId: removeTagValueCreators requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: removeTagValueCreators 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" /api/tags/{id}: get: tags: - Tags summary: Get a tag by ID description: "GET /api/tags/{id} Get a single tag by ID" operationId: getTag parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query description: "Optional relationships to include in the response. Use 'CREATOR'\ \ to include user resources, 'TAG_VALUES' to include tag value resources,\ \ 'TEAM' to include team resources for team-scoped tags." schema: type: - array - "null" items: $ref: "#/components/schemas/TagController.InclusionType" responses: "200": description: getTag 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagResource_" delete: tags: - Tags summary: Delete a tag description: "DELETE /api/tags/{id} Delete a tag and all its tag values, removing\ \ all backlog item associations" operationId: deleteTag parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: deleteTag 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Tags summary: Update a tag description: "PATCH /api/tags/{id} Update a tag's key and description" operationId: updateTag parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TagUpdateResource_" required: true responses: "200": description: updateTag 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagResource_" /api/tags/{tagId}/tag_values: get: tags: - Tags summary: List tag values for a tag description: "GET /api/tags/{tagId}/tag_values List all tag values for a specific\ \ tag" operationId: listTagValues parameters: - name: tagId in: path required: true schema: type: string format: uuid - name: filter in: query description: | Filter for tag values. - filter[autocomplete]: text search on tag value schema: type: - "null" - object allOf: - $ref: "#/components/schemas/TagValueController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query schema: type: - array - "null" items: type: string - name: include in: query description: "Optional relationships to include in the response. Use 'TAG'\ \ to include tag resources, 'CREATOR' to include user resources." schema: type: - array - "null" items: $ref: "#/components/schemas/TagValueController.InclusionType" responses: "200": description: listTagValues 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagValueResource_" post: tags: - Tags summary: Create a tag value description: "POST /api/tags/{tagId}/tag_values Create a new tag value for a\ \ specific tag" operationId: createTagValue parameters: - name: tagId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TagValueCreationResource_" required: true responses: "200": description: createTagValue 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagValueResource_" /api/tags/{tagId}/tag_values/{tagValueId}: get: tags: - Tags summary: Get a tag value description: "GET /api/tags/{tagId}/tag_values/{tagValueId} Get a specific tag\ \ value for a tag" operationId: getTagValue parameters: - name: tagId in: path required: true schema: type: string format: uuid - name: tagValueId in: path required: true schema: type: string format: uuid - name: include in: query description: "Optional relationships to include in the response. Use 'TAG'\ \ to include tag resources, 'CREATOR' to include user resources." schema: type: - array - "null" items: $ref: "#/components/schemas/TagValueController.InclusionType" responses: "200": description: getTagValue 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagValueResource_" delete: tags: - Tags summary: Delete a tag value description: "DELETE /api/tags/{tagId}/tag_values/{tagValueId} Delete a tag\ \ value and remove all associated backlog item relationships" operationId: deleteTagValue parameters: - name: tagId in: path required: true schema: type: string format: uuid - name: tagValueId in: path required: true schema: type: string format: uuid responses: "200": description: deleteTagValue 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Tags summary: Update a tag value description: "PATCH /api/tags/{tagId}/tag_values/{tagValueId} Update a tag value" operationId: updateTagValue parameters: - name: tagId in: path required: true schema: type: string format: uuid - name: tagValueId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TagValueUpdateResource_" required: true responses: "200": description: updateTagValue 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TagValueResource_" /api/tags/{tagId}/values/suggestions: get: tags: - Tag Suggestions summary: Get tag value suggestions description: Returns similar existing tag values for a specific tag based on fuzzy matching. Use this when creating a new tag value to avoid duplicates. operationId: getTagValueSuggestions parameters: - name: tagId in: path required: true schema: type: string format: uuid - name: keyword in: query description: The keyword to search for similar tag values required: true schema: type: string responses: "200": description: getTagValueSuggestions 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TagSuggestionResource_" /api/team_channels: get: tags: - Team Channels summary: List team channels description: List all the team channels in the workspace or list by filter criteria 'teamId'. operationId: listTeamChannels parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/TeamChannelFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" responses: "200": description: List of team channels content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TeamChannelResource_" "500": description: Unexpected error post: tags: - Team Channels summary: Create a team's channel description: "Create a team's channel. Associate the team channel with an existing\ \ Slack channel if the channel id is provided. Otherwise, create a new Slack\ \ channel with the provided channel name." operationId: createTeamChannel requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TeamChannelCreateResource_" required: true responses: "200": description: Created team channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamChannelResource_" "400": description: Team's channel is not created because of invalid argument or Slack API error "404": description: The team is not found "500": description: Unexpected error /api/team_channels/{id}: get: tags: - Team Channels summary: Gets a team channel description: Gets a team channel with the associated Slack channel information. operationId: getTeamChannel parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The team's channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamChannelResource_" "404": description: The team is not found "500": description: Unexpected error delete: tags: - Team Channels summary: Deletes a team channel description: Deletes a team channel. This does not impact the associated Slack channel. operationId: deleteTeamChannel parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Team channel deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: Team channel was not found "500": description: Unexpected error patch: tags: - Team Channels summary: Update a team's channel description: "Update a team's channel. Associate the team channel with an existing\ \ Slack channel if the channel id is provided. Otherwise, create a new Slack\ \ channel with the provided channel name." operationId: updateTeamChannel parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TeamChannelUpdateResource_" required: true responses: "200": description: Updated team channel content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamChannelResource_" "400": description: Team's channel is not updated because of invalid argument or Slack API error "404": description: The team channel is not found "500": description: Unexpected error /api/team_channels/{id}/relationships/members: get: tags: - Team Channels summary: Gets a team channel's members description: Gets members of the team Slack channel who are also Atono users. operationId: getTeamChannelMembers parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: The users in the team channel content: application/json: schema: type: array items: $ref: "#/components/schemas/MultiResourceBody_TeamChannelMemberResource_" "404": description: The team channel is not found "500": description: Unexpected error post: tags: - Team Channels summary: Invite users to the team's Slack channel description: Invite Atono users to the team's Slack channel operationId: inviteUsersToTeamChannel parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Users were invited to the team's Slack channel content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "400": description: Users were not invited to the team's Slack channel because users have not opted in or could already be in the channel "404": description: The team channel is not found "500": description: Unexpected error /api/teams: get: tags: - Teams summary: List teams in the workspace description: List teams that are part of the workspace. operationId: listTeams parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/TeamController.InclusionType" - name: filter in: query required: true schema: $ref: "#/components/schemas/TeamFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: List of teams in the workspace content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TeamResource_" "500": description: Unexpected error post: tags: - Teams summary: Create a team in the workspace description: Add a new team to the workspace. operationId: createTeam requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TeamCreationResource_" required: true responses: "200": description: The team that was created content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResource_" "403": description: The requesting user does not have permissions to create a new team "409": description: The team with the name name already exists in the workspace "500": description: Unexpected error delete: tags: - Teams summary: Deletes teams from the instance operationId: deleteTeams requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_TeamDeletionResource_" required: true responses: "200": description: Teams deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "400": description: Teams were not deleted because of deletion constraints "500": description: Unexpected error /api/teams/sprints: get: tags: - Sprints summary: List sprints description: "List all sprints. Can be filtered by one or more team IDs using\ \ pipe-separated values in the filter[teamIds] query parameter." operationId: listSprints parameters: - name: "filter[teamIds]" in: query required: true schema: type: string - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SprintController.InclusionType" responses: "200": description: List of sprints content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SprintResource_" "500": description: Unexpected error post: tags: - Sprints summary: Create a sprint description: "Create a new sprint. The team ID must be provided in the relationships.team\ \ field of the request body. Optionally, backlog items can be associated with\ \ the sprint by providing their IDs in the relationships.backlogItems field." operationId: createSprint requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SprintCreationResource_" required: true responses: "200": description: The sprint that was created content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintResource_" "400": description: Invalid sprint data "404": description: Team not found "409": description: Sprint dates overlap with existing sprint "500": description: Unexpected error /api/teams/sprints/batch: post: tags: - Sprints summary: Create a series of sprints description: "Create multiple sprints at once with sequential naming and calculated\ \ dates. Sprints will be named sequentially based on the last existing sprint’\ s name (e.g., 'Sprint 5' -> 'Sprint 6')." operationId: createSprintSeries requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SprintSeriesCreationResource_" required: true responses: "200": description: The sprints that were created content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SprintResource_" "400": description: Invalid sprint series data "404": description: Team not found "409": description: Sprint dates overlap or start date is invalid "500": description: Unexpected error /api/teams/sprints/{id}: get: tags: - Sprints summary: Fetch a sprint by ID description: Fetch a single sprint by its ID. operationId: getSprint parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SprintController.InclusionType" responses: "200": description: The requested sprint content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintResource_" "404": description: Sprint not found "500": description: Unexpected error delete: tags: - Sprints summary: Delete a sprint by ID description: Delete a sprint by its ID. This will remove the sprint association from all backlog items. operationId: deleteSprint parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: Sprint deleted successfully "404": description: Sprint not found "500": description: Unexpected error patch: tags: - Sprints summary: Update a sprint by ID description: Update a sprint by its ID. operationId: updateSprint parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SprintUpdateResource_" required: true responses: "200": description: The updated sprint content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintResource_" "400": description: Sprint id in the path and in the body do not match "404": description: Sprint not found "409": description: Sprint dates overlap with existing sprint "500": description: Unexpected error /api/teams/sprints/{id}/relationships/backlogItems: get: tags: - Sprints summary: Returns the list of backlog items associated with the sprint operationId: getBacklogItems parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of backlog items content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: Sprint not found post: tags: - Sprints summary: Add these backlog items to the sprint operationId: addBacklogItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of backlog items content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: Sprint or backlog item not found delete: tags: - Sprints summary: Remove these backlog items from the sprint operationId: removeBacklogItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of backlog items content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: Sprint or backlog item not found patch: tags: - Sprints summary: Updates the list of backlog items associated with the sprint operationId: updateBacklogItems parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of backlog items content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: Sprint or backlog item not found /api/teams/sprints/{id}/storyPointsReport: get: tags: - Sprints summary: Get story points breakdown for a sprint description: "Returns the total story points and remaining points history for\ \ a sprint. The response includes snapshots at the sprint start date, sprint\ \ end date (if in the past), and any date where remaining points changed due\ \ to story completion. No snapshots are returned for dates after the sprint\ \ end date. If the sprint is ongoing and the projected completion date based\ \ on the burn-down trendline's zero intersection is at least one day after\ \ the sprint end date, itemsToPush contains backlog items that may not be\ \ completed. If the sprint is ongoing and the burndown trendline projects\ \ all work to be completed at least one day before the sprint end date, itemsToPull\ \ contains backlog items from the next sprint's TODO that could be pulled\ \ in. If there is no next sprint, itemsToPull will contain unscheduled TODO\ \ items from the team." operationId: getSprintStoryPoints parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Story points breakdown content: application/json: schema: $ref: "#/components/schemas/SprintStoryPointsResponse" "404": description: Sprint not found "500": description: Unexpected error /api/teams/timezones: get: tags: - Teams summary: Get available timezones description: Returns a list of all available IANA timezones with their display names and UTC offsets operationId: listTimezones responses: "200": description: Successfully retrieved the list of timezones content: application/json: schema: type: array items: $ref: "#/components/schemas/TeamController.TimezoneInfo" /api/teams/{id}: get: tags: - Teams summary: Fetch a team by ID description: Fetch a single team from the workspace by its ID. operationId: getTeam parameters: - name: id in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/TeamController.InclusionType" responses: "200": description: A single team content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResource_" "404": description: Team not found "500": description: Unexpected error delete: tags: - Teams summary: Deletes a team from the instance operationId: deleteTeam parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Team deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "400": description: Team was not deleted because of deletion constraints "403": description: The requesting user does not have permissions to delete this team "500": description: Unexpected error patch: tags: - Teams summary: Update a team by ID description: Update a team in the workspace by its ID. operationId: updateTeam parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TeamUpdateResource_" required: true responses: "200": description: The updated team content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResource_" "400": description: Team id in the path and in the body do not match "403": description: The requesting user does not have permissions to update this team "404": description: Team not found "409": description: The team with the name name already exists in the workspace "500": description: Unexpected error /api/teams/{id}/relationships/admins: get: tags: - Teams summary: Gets a team's list of admins description: Gets a team's list of admins operationId: getTeamAdmins parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of admins for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The team is not found "500": description: Unexpected error patch: tags: - Teams summary: Updates a team's admin list description: Updates a team's admin list. operationId: updateTeamAdmins parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of admins for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: Team's admins are not updated because of invalid argument or constraints "404": description: The team or user(s) is not found "500": description: Unexpected error /api/teams/{id}/relationships/backlogOwners: get: tags: - Teams summary: Gets a team's list of backlog owners description: Gets a team's list of backlog owners operationId: getTeamBacklogOwners parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of backlog owners for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The team is not found "500": description: Unexpected error patch: tags: - Teams summary: Updates a team's backlog owners list description: Updates a team's backlog owners list. operationId: updateTeamBacklogOwners parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of backlog owners for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: Team's backlog owners are not updated because of invalid argument or constraints "404": description: The team or user(s) is not found "500": description: Unexpected error /api/teams/{id}/relationships/members: get: tags: - Teams summary: Gets a team's list of members description: Gets a team's list of members operationId: getTeamMembers parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of members for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The team is not found "500": description: Unexpected error patch: tags: - Teams summary: Updates a team's member list description: Updates a team's member list. operationId: updateTeamMembers parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Updated list of members for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: Team's members are not updated because of invalid argument or constraints "404": description: The team or user(s) is not found "500": description: Unexpected error /api/teams/{id}/relationships/sprints: get: tags: - Teams summary: Gets a team's list of sprints description: Gets a team's list of sprints. Only applicable for teams with SCRUM workflow type. operationId: getTeamSprints parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: List of sprints for the team content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The team is not found "500": description: Unexpected error /api/teams/{teamId}/sprintCalendar: get: tags: - Sprint Calendars summary: Get sprint calendar for a team operationId: getTeamSprintCalendar parameters: - name: teamId in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SprintCalendarController.InclusionType" responses: "200": description: getTeamSprintCalendar 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintCalendarResource_" /api/teams/{teamId}/sprintEntries: get: tags: - Sprint Calendars summary: Get all sprint entries for a team operationId: getTeamSprintEntries parameters: - name: teamId in: path required: true schema: type: string format: uuid - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/SprintCalendarController.InclusionType" responses: "200": description: getTeamSprintEntries 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SprintEntryResource_" /api/teams/{teamId}/sprintEntries/{id}: get: tags: - Sprint Calendars summary: Get a specific sprint entry operationId: getSprintEntry parameters: - name: teamId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getSprintEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintEntryResource_" patch: tags: - Sprint Calendars summary: Update a sprint entry operationId: updateSprintEntry parameters: - name: teamId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_SprintEntryUpdateResource_" required: true responses: "200": description: updateSprintEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SprintEntryResource_" /api/timeboxes: get: tags: - Timelines summary: Retrieves a list of timeboxes operationId: getTimeboxes parameters: - name: include in: query description: Supports BACKLOG_ITEMS and TIMELINES required: true schema: type: array items: $ref: "#/components/schemas/TimeboxController.InclusionType" - name: filter in: query required: true schema: $ref: "#/components/schemas/TimeboxController.RequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: getTimeboxes 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TimeboxResource_" post: tags: - Timelines summary: Creates a new timebox operationId: createTimebox requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimeboxCreationResource_" required: true responses: "200": description: createTimebox 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimeboxResource_" /api/timeboxes/{id}: get: tags: - Timelines summary: Retrieves the timebox by ID operationId: getTimebox parameters: - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/TimeboxController.InclusionType" - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getTimebox 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimeboxResource_" delete: tags: - Timelines summary: Deletes a timebox by ID operationId: deleteTimebox parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: deleteTimebox 204 response patch: tags: - Timelines summary: Updates a timebox by ID operationId: updateTimebox parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimeboxUpdateResource_" required: true responses: "200": description: updateTimebox 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimeboxResource_" /api/timeboxes/{id}/relationships/backlogItems: get: tags: - Timelines summary: Returns the list of backlog items associated with the timebox operationId: getBacklogItems_1 parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getBacklogItems_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" post: tags: - Timelines summary: Add these backlog items to the timebox operationId: addBacklogItems_1 parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: addBacklogItems_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" delete: tags: - Timelines summary: Remove these backlog items from the timebox operationId: removeBacklogItems_1 parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: removeBacklogItems_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" patch: tags: - Timelines summary: Updates the list of backlog items associated with the timebox operationId: updateBacklogItems_1 parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateBacklogItems_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" /api/timeboxes/{id}/relationships/timelines: get: tags: - Timelines summary: Returns the list of timelines associated with the timebox operationId: getTimelines parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getTimelines 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" /api/timelines: get: tags: - Timelines summary: Retrieves a list of timelines operationId: getTimelines_1 parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/TimelineController.TimelineFilter" responses: "200": description: getTimelines_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TimelineResource_" post: tags: - Timelines summary: Creates a new timeline operationId: createTimeline requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimelineCreationResource_" required: true responses: "200": description: createTimeline 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineResource_" /api/timelines/{id}: get: tags: - Timelines summary: Retrieves the timeline by ID operationId: getTimeline parameters: - name: id in: path required: true schema: type: string format: uuid - name: filter in: query required: true schema: $ref: "#/components/schemas/TimelineController.SingleTimelineFilter" - name: include in: query required: true schema: type: array items: $ref: "#/components/schemas/TimelineController.InclusionType" responses: "200": description: getTimeline 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineResource_" delete: tags: - Timelines summary: Deletes a timeline by ID operationId: deleteTimeline_1 parameters: - name: id in: path required: true schema: type: string format: uuid responses: "204": description: deleteTimeline_1 204 response patch: tags: - Timelines summary: Updates a timeline by ID operationId: updateTimeline parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimelineUpdateResource_" required: true responses: "200": description: updateTimeline 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineResource_" /api/timelines/{id}/relationships/releaseMarkers: get: tags: - Timelines summary: Returns the list of release marker identifiers associated with the timeline operationId: getReleaseMarkerRelationships parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getReleaseMarkerRelationships 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" post: tags: - Timelines summary: Add release markers to the timeline operationId: addReleaseMarkers parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: addReleaseMarkers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" delete: tags: - Timelines summary: Remove release markers from the timeline operationId: removeReleaseMarkers parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: removeReleaseMarkers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" patch: tags: - Timelines summary: Update release markers associated with the timeline operationId: updateReleaseMarkers parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: updateReleaseMarkers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" /api/timelines/{id}/relationships/timelineEntries: get: tags: - Timelines summary: Returns the list of timeline entries associated with the timeline operationId: getTimelineEntires parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getTimelineEntires 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TimelineEntryResource_" /api/timelines/{id}/timelineEntries: post: tags: - Timelines summary: Creates a new timeline entry for an existing timebox operationId: createTimelineEntry parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimelineEntryCreationResource_" required: true responses: "200": description: createTimelineEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineEntryResource_" /api/timelines/{timelineId}/releaseMarkers: get: tags: - Timelines summary: Retrieves all release markers for a timeline operationId: getReleaseMarkers parameters: - name: timelineId in: path required: true schema: type: string format: uuid responses: "200": description: getReleaseMarkers 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ReleaseMarkerResource_" /api/timelines/{timelineId}/timelineEntries/{id}: get: tags: - Timelines summary: Finds a timeline entry from the timeline operationId: getTimelineEntry parameters: - name: timelineId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getTimelineEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineEntryResource_" delete: tags: - Timelines summary: Removes a timeline entry from the timeline operationId: removeTimelineEntry parameters: - name: timelineId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: "204": description: removeTimelineEntry 204 response patch: tags: - Timelines summary: Updates the properties of a timeline entry associated with the timeline operationId: updateTimelineEntry parameters: - name: timelineId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_TimelineEntryUpdateResource_" required: true responses: "200": description: updateTimelineEntry 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimelineEntryResource_" /api/usages/configuration: get: tags: - Usage Configuration summary: List all auto-wiring configurations operationId: listConfigs parameters: - name: "filter[eventSource]" in: query schema: type: - string - "null" description: "a key value pair to filter configurations by event source\ \ (e.g. \"xpath\":\"//div[@data-atono-id='12345']\")" name: "filter[eventSource]" responses: "200": description: List of all auto-wiring configurations content: application/json: schema: type: array items: $ref: "#/components/schemas/UsageConfigurationResource" post: tags: - Usage Configuration summary: Create a new auto-wiring configuration operationId: createConfig requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UsageConfigurationResourceCreate_" required: true responses: "201": description: The created auto-wiring configuration content: application/json: schema: $ref: "#/components/schemas/UsageConfigurationResource" "400": description: Invalid configuration provided /api/usages/configuration/{id}: get: tags: - Usage Configuration summary: Get a specific auto-wiring configuration by ID operationId: getConfig parameters: - name: id in: path description: Configuration ID required: true schema: type: string format: uuid responses: "200": description: The requested auto-wiring configuration content: application/json: schema: $ref: "#/components/schemas/UsageConfigurationResource" "404": description: Configuration not found delete: tags: - Usage Configuration summary: Delete an auto-wiring configuration operationId: deleteConfig parameters: - name: id in: path description: Configuration ID required: true schema: type: string format: uuid responses: "204": description: Configuration deleted successfully "404": description: Configuration not found patch: tags: - Usage Configuration summary: Update an existing auto-wiring configuration operationId: updateConfig parameters: - name: id in: path description: Configuration ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UsageConfigurationResourceUpdate_" required: true responses: "200": description: The updated auto-wiring configuration content: application/json: schema: $ref: "#/components/schemas/UsageConfigurationResource" "400": description: Invalid configuration provided "404": description: Configuration not found /api/usages/{key}: delete: tags: - Usages operationId: clearUsageData parameters: - name: key in: path required: true schema: type: string responses: "200": description: clearUsageData 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/user_setting_entries: get: tags: - User Setting Entries summary: List all entries for current user operationId: list_1 responses: "200": description: list_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_UserSettingEntryResource_" /api/user_setting_entries/{idOrKey}: get: tags: - User Setting Entries summary: Get entry by id or key; for the current user operationId: getByKey parameters: - name: idOrKey in: path required: true schema: type: string minLength: 1 responses: "200": description: getByKey 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserSettingEntryResource_" delete: tags: - User Setting Entries summary: Delete entry by id or key; for current user operationId: deleteByKey parameters: - name: idOrKey in: path required: true schema: type: string minLength: 1 responses: "200": description: deleteByKey 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - User Setting Entries summary: Create or update entry by id or key; for the current user operationId: upsert parameters: - name: idOrKey in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UserSettingEntryCreationResource_" required: true responses: "200": description: upsert 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserSettingEntryResource_" /api/user_settings: get: tags: - User Settings summary: Fetch the user settings of the authenticated user description: Fetch the user settings of the authenticated user. operationId: getUserSettings responses: "200": description: The user settings content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserSettingsResource_" "404": description: User not found "500": description: Unexpected error patch: tags: - User Settings summary: Update current user's settings operationId: updateSettings requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UserSettingsUpdateResource_" required: true responses: "200": description: The updated settings content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserSettingsResource_" "404": description: User not found "500": description: Unexpected error /api/user_settings/join_community_slack: put: tags: - User Settings operationId: setJoinedCommunitySlack responses: "200": description: setJoinedCommunitySlack 200 response content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/users: get: tags: - Users summary: List users in the workspace description: List users that are part of the workspace. operationId: listUsers parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/UserFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: List of users in the workspace content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_UserResource_" "500": description: Unexpected error post: tags: - Users summary: Register user in the workspace description: Add a user in the workspace. The user will receive an email to confirm their registration. operationId: createUser requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UserCreationResource_" required: true responses: "200": description: The user that was created content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "403": description: The requesting user does not have permissions to register a new user "409": description: The user already exists in the workspace "500": description: Unexpected error /api/users/batch: post: tags: - Users summary: Creates multiple users in the instance description: "If the batch is too big (=>10 users), the users will be scheduled\ \ for creation in the background." operationId: createUsers requestBody: content: application/json: schema: $ref: "#/components/schemas/UsersCreationResource" required: true responses: "200": description: Users created content: application/json: schema: {} "202": description: Users were scheduled for creation in the background. "400": description: Users were not created due to internal constraints /api/users/self: get: tags: - Users summary: Fetch the current user description: Fetch information about the user currently logged in. operationId: getCurrentUser responses: "200": description: The current user content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "500": description: Unexpected error /api/users/{id}: get: tags: - Users summary: Fetch a user by ID description: Fetch a single user from the workspace by their ID. operationId: getUser parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: A single user content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "404": description: User not found "500": description: Unexpected error delete: tags: - Users summary: Deletes a user from the instance description: Deletes a user from the DB and deactivates them in Cognito. operationId: deleteUser parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: User deleted content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "400": description: Users were not deleted because of deletion constraints "500": description: Unexpected error patch: tags: - Users summary: Update a user by ID description: Update a user from the workspace by its ID. operationId: updateUser parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_UserUpdateResource_" required: true responses: "200": description: The updated user content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "400": description: User id in the path and in the body do not match "403": description: The requesting user does not have permissions to update this user "404": description: User not found "409": description: The user already exists in the workspace "500": description: Unexpected error /api/users/{id}/invitation: post: tags: - Users summary: Re-send an invitation for the user to join Atono description: "If the user is still in PENDING state, re-send the invitation\ \ email." operationId: inviteUserAgain parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: User has been invited again. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "404": description: User not found "409": description: User is not in PENDING state "500": description: Unexpected error delete: tags: - Users summary: Cancel a pending invitation for the user to join Atono description: "If the user is still in PENDING state, we abort their invitation." operationId: cancelUserInvitation parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: User's invitation has been aborted. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResource_" "404": description: User not found "409": description: User is not in PENDING state "500": description: Unexpected error /api/users/{id}/relationships/roles: get: tags: - Users summary: Gets a user's roles description: Gets a user's roles operationId: getUserRoles parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: User's roles content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: User is not found "500": description: Unexpected error patch: tags: - Users summary: Updates a user's roles description: Updates a user's roles. operationId: updateUserRoles parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: User's updated roles content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "400": description: User's roles are not updated because of invalid argument or constraints "404": description: User or roles are not found "500": description: Unexpected error /api/users/{id}/relationships/team_channels: post: tags: - Users summary: Invite user to team channels description: Invite the user who have opted-in to Slack connection to the teams' Slack channels operationId: inviteUserToTeamChannels parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "202": description: User has been scheduled to be added to Slack team channels in the background. "404": description: The team channel is not found "500": description: Unexpected error /api/v1/bugs: get: tags: - Bugs summary: Get bugs operationId: listBugs parameters: - name: "filter[assigneeIds]" in: query schema: type: - string - "null" description: "Finds bugs assigned to any of the specified users, or unassigned.\ \ Provide a pipe-separated list of user UUIDs. Use `NONE` to find unassigned\ \ bugs." name: "filter[assigneeIds]" - name: "filter[teamIds]" in: query schema: type: - string - "null" description: "Finds bugs assigned to any of the specified team backlogs,\ \ or in Bug triage. Provide a pipe-separated list of team UUIDs. Use `NONE`\ \ to find bugs in Bug triage." name: "filter[teamIds]" - name: "filter[createdAt]" in: query schema: type: - string - "null" description: "Finds bugs created within a specific date range. Provide two\ \ pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[createdAt]" exampleSetFlag: true - name: "filter[updatedAt]" in: query schema: type: - string - "null" description: "Finds bugs last updated within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[updatedAt]" exampleSetFlag: true - name: "filter[doneAt]" in: query schema: type: - string - "null" description: "Finds bugs completed within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[doneAt]" exampleSetFlag: true - name: "filter[timeboxIds]" in: query schema: type: - string - "null" description: 'Finds bugs assigned to any of the specified timeboxes. Provide a pipe-separated list of timebox UUIDs. Use `NONE` to find bugs not assigned to a timebox. ' name: "filter[timeboxIds]" - name: include in: query description: | Includes additional related data for each bug. Repeat the parameter to include multiple relationships. * `ASSIGNEE` - The user assigned to the bug. * `CREATOR` - The user who reported the bug. * `TEAM` - The team backlog the bug is assigned to. * `WORKFLOW_STEP` - The workflow step the bug is currently in. schema: type: - array - "null" items: $ref: "#/components/schemas/BugController.InclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of bugs by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order, Repeat the parameter to sort by multiple fields. Supported fields include: * `assignee.fullName` * `handle` * `position` * `team.name` * `title` * `createdAt` * `updatedAt` * `doneAt` schema: type: - array - "null" items: type: string example: -createdAt responses: "200": description: Successfully retrieved the list of bugs and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BugResource_" post: tags: - Bugs summary: Create a bug operationId: createBug requestBody: description: The bug to create. content: application/json: schema: $ref: "#/components/schemas/Request_BugCreateResource_" required: true responses: "200": description: Successfully created the bug. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BugResource_" links: self: operationId: fetchBug parameters: id: $response.body#/data/id update: operationId: updateBug parameters: id: $response.body#/data/id delete: operationId: deleteBug parameters: id: $response.body#/data/id "404": description: One of the bug's relationships was not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/bugs/{id}: get: tags: - Bugs summary: Get a bug operationId: fetchBug parameters: - name: id in: path description: "The UUID or handle of the bug. The handle is the item ID shown\ \ in the Atono application (e.g., BUG-123)." required: true schema: type: string example: BUG-123 - name: include in: query description: | Includes additional related data for each bug. Repeat the parameter to include multiple relationships. * `ASSIGNEE` - The user assigned to the bug. * `CREATOR` - The user who reported the bug. * `TEAM` - The team backlog the bug is assigned to. * `WORKFLOW_STEP` - The workflow step the bug is currently in. schema: type: - array - "null" items: $ref: "#/components/schemas/BugController.InclusionType" responses: "200": description: Successfully retrieved the bug and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BugResource_" links: self: operationId: fetchBug parameters: id: $response.body#/data/id update: operationId: updateBug parameters: id: $response.body#/data/id delete: operationId: deleteBug parameters: id: $response.body#/data/id "404": description: "The bug could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Bugs summary: Delete a bug operationId: deleteBug parameters: - name: id in: path description: "The UUID or handle of the bug. The handle is the item ID shown\ \ in the Atono application (e.g., BUG-123)." required: true schema: type: string example: BUG-123 responses: "204": description: Successfully deleted the bug. No content is returned in the response. "404": description: The specified bug could not be found. It may not exist or may have already been deleted. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Bugs summary: Update a bug operationId: updateBug parameters: - name: id in: path description: "The UUID or handle of the bug. The handle is the item ID shown\ \ in the Atono application (e.g., BUG-123)." required: true schema: type: string example: BUG-123 requestBody: description: Information to update in the bug. content: application/json: schema: $ref: "#/components/schemas/Request_BugUpdateResource_" required: true responses: "200": description: Successfully updated the bug. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_BugResource_" links: self: operationId: fetchBug parameters: id: $response.body#/data/id update: operationId: updateBug parameters: id: $response.body#/data/id delete: operationId: deleteBug parameters: id: $response.body#/data/id "404": description: "The bug could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/epics: get: tags: - Epics summary: Get epics operationId: listEpics parameters: - name: "filter[createdAt]" in: query schema: type: - string - "null" description: "Finds epics created within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[createdAt]" exampleSetFlag: true - name: "filter[keywordSearch]" in: query schema: type: - string - "null" description: Finds epics matching the given string. Case insensitive. Matches both handle and title portions. maxLength: 500 name: "filter[keywordSearch]" - name: "filter[updatedAt]" in: query schema: type: - string - "null" description: "Finds epics last updated within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[updatedAt]" exampleSetFlag: true - name: include in: query description: | Includes additional related data for each epic. Repeat the parameter to include multiple relationships. * `CREATOR` - The user who created the epic. * `EPIC_STORIES` - The stories associated with the epic. schema: type: - array - "null" items: $ref: "#/components/schemas/EpicController.InclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of epics by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `handle` * `position` * `title` * `createdAt` * `updatedAt` schema: type: - array - "null" items: type: string example: -createdAt responses: "200": description: Successfully retrieved the list of epics and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_EpicResource_" post: tags: - Epics summary: Create an epic operationId: createEpic requestBody: description: The epic to create. content: application/json: schema: $ref: "#/components/schemas/Request_EpicCreateResource_" required: true responses: "200": description: Successfully created the epic. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EpicResource_" links: self: operationId: fetchEpic parameters: id: $response.body#/data/id update: operationId: updateEpic parameters: id: $response.body#/data/id delete: operationId: deleteEpic parameters: id: $response.body#/data/id "404": description: One of the epic's relationships was not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/epics/{id}: get: tags: - Epics summary: Get an epic operationId: fetchEpic parameters: - name: id in: path description: "The UUID or handle of the epic. The handle is the item ID shown\ \ in the Atono application (e.g., EPIC-123)." required: true schema: type: string example: EPIC-123 - name: include in: query description: | Includes additional related data for each epic. Repeat the parameter to include multiple relationships. * `CREATOR` - The user who created the epic. * `EPIC_STORIES` - The stories associated with the epic. schema: type: - array - "null" items: $ref: "#/components/schemas/EpicController.InclusionType" responses: "200": description: Successfully retrieved the epic and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EpicResource_" links: self: operationId: fetchEpic parameters: id: $response.body#/data/id update: operationId: updateEpic parameters: id: $response.body#/data/id delete: operationId: deleteEpic parameters: id: $response.body#/data/id "404": description: "The epic could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Epics summary: Delete an epic operationId: deleteEpic parameters: - name: id in: path description: The UUID or handle of the epic. required: true schema: type: string example: EPIC-123 responses: "204": description: Successfully deleted the epic. No content is returned in the response. "404": description: The epic could not be found. It may not exist or may have already been deleted. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Epics summary: Update an epic operationId: updateEpic parameters: - name: id in: path description: "The UUID or handle of the epic. The handle is the item ID shown\ \ in the Atono application (e.g., EPIC-123)." required: true schema: type: string example: EPIC-123 requestBody: description: Information to update in the epic. content: application/json: schema: $ref: "#/components/schemas/Request_EpicUpdateResource_" required: true responses: "200": description: Successfully updated the epic. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_EpicResource_" links: self: operationId: fetchEpic parameters: id: $response.body#/data/id update: operationId: updateEpic parameters: id: $response.body#/data/id delete: operationId: deleteEpic parameters: id: $response.body#/data/id "404": description: "The epic could not be found, or one of the requested related\ \ resources does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/epics/{id}/relationships/epicStories: get: tags: - Epics summary: Get epic stories relationship operationId: getEpicStoriesRelationship parameters: - name: id in: path description: The UUID or handle of the epic. required: true schema: type: string example: EPIC-123 responses: "200": description: Successfully retrieved the epic stories relationship. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The epic could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" post: tags: - Epics summary: Add stories to an epic operationId: addEpicStories parameters: - name: id in: path description: The UUID or handle of the epic. required: true schema: type: string example: EPIC-123 requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Successfully added stories to the epic. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The epic could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Epics summary: Remove stories from an epic operationId: removeEpicStories parameters: - name: id in: path description: The UUID or handle of the epic. required: true schema: type: string example: EPIC-123 requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Successfully removed stories from the epic. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The epic could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Epics summary: Update epic stories relationship operationId: updateEpicStoriesRelationship parameters: - name: id in: path description: The UUID or handle of the epic. required: true schema: type: string example: EPIC-123 requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_ResourceIdentifier_" required: true responses: "200": description: Successfully updated the epic stories relationship. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_ResourceIdentifier_" "404": description: The epic could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/flags: get: tags: - Flags summary: Get feature flags operationId: listFlags parameters: - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of feature flags by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `key` * `updatedAt` schema: type: - array - "null" items: type: string example: -updatedAt responses: "200": description: Successfully retrieved the list of feature flags and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FlagResource_" /api/v1/flags/{id}: get: tags: - Flags summary: Get a feature flag operationId: fetchFlag parameters: - name: id in: path description: The UUID or key of the feature flag. The key is the feature flag name shown in the UI. required: true schema: type: string example: amazing_feature responses: "200": description: Successfully retrieved the flag and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FlagResource_" links: self: operationId: fetchFlag parameters: id: $response.body#/data/id listFlagConfigurations: operationId: listFlagConfigurations parameters: id: $response.body#/data/id fetchFlagEnvironmentConfiguration: operationId: fetchFlagEnvironmentConfiguration parameters: id: $response.body#/data/id environmentId: $response.body#/data/relationships/slices/data/0/id updateFlagEnvironmentConfiguration: operationId: updateFlagEnvironmentConfiguration parameters: id: $response.body#/data/id environmentId: $response.body#/data/relationships/slices/data/0/id "404": description: "The flag could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/flags/{id}/environments: get: tags: - Flags summary: Get a flag's environment configurations operationId: listFlagConfigurations parameters: - name: id in: path description: The UUID or key of the feature flag. The key is the feature flag name shown in the Atono application. required: true schema: type: string example: amazing_feature responses: "200": description: Successfully retrieved the specified feature flag’s configuration for all environments. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_FlagEnvironmentResource_" "404": description: The flag or environments could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/flags/{id}/environments/{environmentId}: get: tags: - Flags summary: Get a flag’s environment configuration operationId: fetchFlagEnvironmentConfiguration parameters: - name: id in: path description: The UUID or key of the feature flag. The key is the feature flag name shown in the Atono application. required: true schema: type: string example: amazing_feature - name: environmentId in: path description: The UUID or name of the environment. required: true schema: type: string example: production responses: "200": description: Successfully retrieved the flag configuration for the specified environment. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FlagEnvironmentResource_" links: self: operationId: fetchFlag parameters: id: $response.body#/data/relationships/flag/data/id listFlagConfigurations: operationId: listFlagConfigurations parameters: id: $response.body#/data/relationships/flag/data/id fetchFlagEnvironmentConfiguration: operationId: fetchFlagEnvironmentConfiguration parameters: id: $response.body#/data/relationships/flag/data/id environmentId: $response.body#/data/id updateFlagEnvironmentConfiguration: operationId: updateFlagEnvironmentConfiguration parameters: id: $response.body#/data/relationships/flag/data/id environmentId: $response.body#/data/id "404": description: The flag or environment could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Flags summary: Update a flag’s environment configuration operationId: updateFlagEnvironmentConfiguration parameters: - name: id in: path description: The UUID or key of the feature flag. The key is the feature flag name shown in the Atono application. required: true schema: type: string example: amazing_feature - name: environmentId in: path description: The UUID or name of the environment. required: true schema: type: string example: production requestBody: description: Configuration to update for the specified feature flag and environment. content: application/json: schema: $ref: "#/components/schemas/Request_FlagEnvironmentUpdateResource_" required: true responses: "200": description: Successfully updated the configuration of the feature flag in the specified environment. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_FlagEnvironmentResource_" "404": description: "The flag could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/stories: get: tags: - Stories summary: Get stories operationId: listStories parameters: - name: "filter[assigneeIds]" in: query schema: type: - string - "null" description: "Finds stories assigned to any of the specified users, or unassigned.\ \ Provide a pipe-separated list of user UUIDs. Use `NONE` to find unassigned\ \ stories." name: "filter[assigneeIds]" - name: "filter[teamIds]" in: query schema: type: - string - "null" description: "Finds stories assigned to any of the specified team backlogs,\ \ or in Story refinement (not assigned to a team). Provide a pipe-separated\ \ list of team UUIDs. Use `NONE` to find stories not assigned to a team. " name: "filter[teamIds]" - name: "filter[createdAt]" in: query schema: type: - string - "null" description: "Finds stories created within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[createdAt]" exampleSetFlag: true - name: "filter[updatedAt]" in: query schema: type: - string - "null" description: "Finds stories last updated within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[updatedAt]" exampleSetFlag: true - name: "filter[doneAt]" in: query schema: type: - string - "null" description: "Finds stories completed within a specific date range. Provide\ \ two pipe-separated ISO 8601 timestamps (e.g., `start|end`)." example: 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z name: "filter[doneAt]" exampleSetFlag: true - name: "filter[timeboxIds]" in: query schema: type: - string - "null" description: Finds stories assigned to any of the specified timeboxes. Provide a pipe-separated list of timebox UUIDs. Use `NONE` to find stories not assigned to a timebox. name: "filter[timeboxIds]" - name: include in: query description: | Includes additional related data for each story. Repeat the parameter to include multiple relationships. * `ASSIGNEE` - The user assigned to the story. * `CREATOR` - The user who created the story. * `FEATURE_FLAG` - The feature flag associated with the story. * `TEAM` - The team backlog the story is assigned to. * `FULL_TEXT` - Returns the story’s main content and all acceptance criteria as a single formatted text block (may include minimal HTML). schema: type: - array - "null" items: $ref: "#/components/schemas/StoryController.ListInclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of stories by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `assignee.fullName` * `handle` * `position` * `team.name` * `title` * `createdAt` * `updatedAt` * `doneAt` schema: type: - array - "null" items: type: string example: -createdAt responses: "200": description: Successfully retrieved the list of stories and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_StoryResource_" post: tags: - Stories summary: Create a story operationId: createStory requestBody: description: The story to create. content: application/json: schema: $ref: "#/components/schemas/Request_StoryCreateResource_" required: true responses: "200": description: Successfully created the story. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryResource_" links: self: operationId: fetchStory parameters: id: $response.body#/data/id update: operationId: updateStory parameters: id: $response.body#/data/id delete: operationId: deleteStory parameters: id: $response.body#/data/id "404": description: One of the story's relationships was not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/stories/personas: get: tags: - Personas summary: Get personas operationId: listPersonas_1 responses: "200": description: Successfully retrieved the list of user story personas. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_PersonaResource_" /api/v1/stories/{id}: get: tags: - Stories summary: Get a story operationId: fetchStory parameters: - name: id in: path description: "The UUID or handle of the story. The handle is the item ID shown\ \ in the Atono application (e.g., `STORY-123`)." required: true schema: type: string example: STORY-123 - name: include in: query description: | Includes additional related data for each story. Repeat the parameter to include multiple relationships. * `ACCEPTANCE_CRITERIA` - The acceptance criteria of the story. * `ASSIGNEE` - The user assigned to the story. * `CREATOR` - The user who created the story. * `FEATURE_FLAG` - The feature flag associated with the story. * `TEAM` - The team backlog the story is assigned to. * `FULL_TEXT` - Returns the story’s main content and all acceptance criteria as a single formatted text block (may include minimal HTML). Requires ACCEPTANCE_CRITERIA in the includes list. schema: type: - array - "null" items: $ref: "#/components/schemas/StoryController.FetchInclusionType" responses: "200": description: Successfully retrieved the story and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryResource_" links: self: operationId: fetchStory parameters: id: $response.body#/data/id update: operationId: updateStory parameters: id: $response.body#/data/id delete: operationId: deleteStory parameters: id: $response.body#/data/id "404": description: "The story could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Stories summary: Delete a story operationId: deleteStory parameters: - name: id in: path description: "The UUID or handle of the story. The handle is the item ID shown\ \ in the Atono application (e.g., `STORY-123`)." required: true schema: type: string example: STORY-123 responses: "204": description: Successfully deleted the story. No content is returned in the response. "404": description: The specified story could not be found. It may not exist or may have already been deleted. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Stories summary: Update a story operationId: updateStory parameters: - name: id in: path description: "The UUID or handle of the story. The handle is the item ID shown\ \ in the Atono application (e.g., `STORY-123`)." required: true schema: type: string example: STORY-123 requestBody: description: Information to update in the story. content: application/json: schema: $ref: "#/components/schemas/Request_StoryUpdateResource_" required: true responses: "200": description: Successfully updated the story. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_StoryResource_" links: self: operationId: fetchStory parameters: id: $response.body#/data/id update: operationId: updateStory parameters: id: $response.body#/data/id delete: operationId: deleteStory parameters: id: $response.body#/data/id "404": description: "The story could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/subtasks: get: tags: - Subtasks summary: Get subtasks operationId: listSubtasks_1 parameters: - name: "filter[backlogItemId]" in: query schema: type: - string - "null" description: "Finds subtasks belonging to the specified story or bug. Provide\ \ the UUID or handle of the backlog item (e.g., `STORY-123` or `BUG-456`)." example: STORY-123 name: "filter[backlogItemId]" exampleSetFlag: true - name: include in: query description: | Includes additional related data for each subtask. Repeat the parameter to include multiple relationships. * `ASSIGNEE` - The user assigned to the subtask. schema: type: - array - "null" items: $ref: "#/components/schemas/SubtaskController.InclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of subtasks by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `position` * `title` * `createdAt` * `updatedAt` schema: type: - array - "null" items: type: string example: position responses: "200": description: Successfully retrieved the list of subtasks. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_SubtaskResource_" "404": description: The specified backlog item could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" post: tags: - Subtasks summary: Create a subtask operationId: createSubtask_1 parameters: - name: backlogItemId in: query description: "The UUID or handle of the story or bug the subtask belongs to\ \ (e.g., STORY-123 or BUG-456)." required: true schema: type: string example: STORY-123 requestBody: description: The subtask to create. content: application/json: schema: $ref: "#/components/schemas/Request_SubtaskCreateResource_" required: true responses: "200": description: Successfully created the subtask. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" links: self: operationId: fetchSubtask parameters: subtaskId: $response.body#/data/id update: operationId: updateSubtask parameters: subtaskId: $response.body#/data/id delete: operationId: deleteSubtask parameters: subtaskId: $response.body#/data/id "404": description: The backlog item or assignee could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/subtasks/{subtaskId}: get: tags: - Subtasks summary: Get a subtask operationId: fetchSubtask parameters: - name: subtaskId in: path required: true schema: type: string format: uuid - name: include in: query description: | Includes additional related data for each subtask. Repeat the parameter to include multiple relationships. * `ASSIGNEE` - The user assigned to the subtask. schema: type: - array - "null" items: $ref: "#/components/schemas/SubtaskController.InclusionType" responses: "200": description: Successfully retrieved the subtask. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" links: self: operationId: fetchSubtask parameters: subtaskId: $response.body#/data/id update: operationId: updateSubtask parameters: subtaskId: $response.body#/data/id delete: operationId: deleteSubtask parameters: subtaskId: $response.body#/data/id "404": description: The subtask could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Subtasks summary: Delete a subtask operationId: deleteSubtask_1 parameters: - name: subtaskId in: path required: true schema: type: string format: uuid responses: "204": description: Successfully deleted the subtask. No content is returned in the response. "404": description: The subtask could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Subtasks summary: Update a subtask operationId: updateSubtask_1 parameters: - name: subtaskId in: path required: true schema: type: string format: uuid requestBody: description: Information to update in the subtask. content: application/json: schema: $ref: "#/components/schemas/Request_SubtaskUpdateResource_" required: true responses: "200": description: Successfully updated the subtask. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_SubtaskResource_" links: self: operationId: fetchSubtask parameters: subtaskId: $response.body#/data/id update: operationId: updateSubtask parameters: subtaskId: $response.body#/data/id delete: operationId: deleteSubtask parameters: subtaskId: $response.body#/data/id "404": description: The subtask could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/teams: get: tags: - Teams summary: Get teams operationId: listTeams_1 parameters: - name: include in: query description: | Includes additional related data for each team. Repeat the parameter to include multiple relationships. * `MEMBERS` - The users added to the team as members. * `ADMINS` - The users added to the team as team administrators. * `BACKLOG_OWNERS` - The users added to the team as backlog owners. schema: type: - array - "null" items: $ref: "#/components/schemas/TeamController.ListInclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: | Sorts the list of teams by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `name` * `description` schema: type: - array - "null" items: type: string example: -name responses: "200": description: Successfully retrieved the list of teams and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TeamResourceV1_" post: tags: - Teams summary: Create a team operationId: createTeam_1 requestBody: description: The team to create. content: application/json: schema: $ref: "#/components/schemas/Request_TeamCreateResourceV1_" required: true responses: "200": description: Successfully created the team. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResourceV1_" links: self: operationId: fetchTeam parameters: id: $response.body#/data/id update: operationId: updateTeam parameters: id: $response.body#/data/id delete: operationId: deleteTeam parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to create a new team. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: One of the team's relationships was not found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/teams/{id}: get: tags: - Teams summary: Get a team operationId: fetchTeam parameters: - name: id in: path description: The UUID of the team. required: true schema: type: string format: uuid example: e41df9f0-0c49-403b-978f-828d0066bae9 - name: include in: query description: | Includes additional related data for each team. Repeat the parameter to include multiple relationships. * `MEMBERS` - The users added to the team as members. * `ADMINS` - The users added to the team as admins. * `BACKLOG_OWNERS` - The users added to the team as backlog owners. schema: type: - array - "null" items: $ref: "#/components/schemas/TeamController.ListInclusionType" responses: "200": description: Successfully retrieved the team and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResourceV1_" links: self: operationId: fetchTeam parameters: id: $response.body#/data/id update: operationId: updateTeam parameters: id: $response.body#/data/id delete: operationId: deleteTeam parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to access the requested team. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: "The team could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Teams summary: Delete a team operationId: deleteTeam_1 parameters: - name: id in: path description: The UUID of a team. required: true schema: type: string format: uuid responses: "204": description: Successfully deleted the team. No content is returned in the response. "403": description: The authenticated user does not have permission to delete the specified team. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: The specified team could not be found. It may not exist or may have already been deleted. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Teams summary: Update a team operationId: updateTeam_1 parameters: - name: id in: path description: The UUID of the team. required: true schema: type: string format: uuid requestBody: description: Information to update about the team. content: application/json: schema: $ref: "#/components/schemas/Request_TeamUpdateResourceV1_" required: true responses: "200": description: Successfully updated the team. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TeamResourceV1_" links: self: operationId: fetchTeam parameters: id: $response.body#/data/id update: operationId: updateTeam parameters: id: $response.body#/data/id delete: operationId: deleteTeam parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to update the specified team. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: "The team could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/timeboxes: get: tags: - Timeboxes summary: Get timeboxes operationId: listTimeboxes parameters: - name: "filter[search]" in: query schema: type: - string - "null" description: Searches timeboxes by name using partial matching. name: "filter[search]" - name: "filter[active]" in: query schema: type: - boolean - "null" description: Returns only Timeboxes where the current date is on or before the endDate (i.e. in progress or future). name: "filter[active]" - name: include in: query description: | Includes additional related data for each timebox. Repeat the parameter to include multiple relationships. * `CREATOR` - The user who created the timebox. * `BACKLOG_ITEMS` - The backlog items assigned to this timebox. schema: type: - array - "null" items: $ref: "#/components/schemas/TimeboxController.ListInclusionType" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: | Sorts the list of timeboxes by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `name` * `startDate` * `endDate` * `updatedAt` schema: type: - array - "null" items: type: string example: -startDate responses: "200": description: Successfully retrieved the list of timeboxes and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_TimeboxResourceV1_" /api/v1/timeboxes/{id}: get: tags: - Timeboxes summary: Get a timebox operationId: fetchTimebox parameters: - name: id in: path description: The UUID of the timebox. required: true schema: type: string format: uuid example: e41df9f0-0c49-403b-978f-828d0066bae9 - name: include in: query description: | Includes additional related data for the timebox. Repeat the parameter to include multiple relationships. * `CREATOR` - The user who created the timebox. * `BACKLOG_ITEMS` - The backlog items assigned to this timebox. schema: type: - array - "null" items: $ref: "#/components/schemas/TimeboxController.ListInclusionType" responses: "200": description: Successfully retrieved the timebox and its included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_TimeboxResourceV1_" links: self: operationId: fetchTimebox parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to access the requested timebox. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: "The timebox could not be found, or one of the requested related\ \ resources (include) does not exist." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/users: get: tags: - Users summary: Get users operationId: listUsers_1 parameters: - name: "filter[withDeleted]" in: query schema: type: - boolean - "null" description: "When true, deleted users are included in the response. Defaults\ \ to false." name: "filter[withDeleted]" - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: |- Sorts the list of users by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `fullName` * `email` * `createdAt` * `updatedAt` * `invitedAt` schema: type: - array - "null" items: type: string example: -createdAt responses: "200": description: Successfully retrieved the list of users and their included relationships. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_UserResourceV1_" post: tags: - Users summary: Add a user operationId: createUser_1 requestBody: description: The user to add. content: application/json: schema: $ref: "#/components/schemas/Request_UserCreateResourceV1_" required: true responses: "200": description: Successfully added the user to the workspace. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResourceV1_" links: self: operationId: fetchUser parameters: id: $response.body#/data/id update: operationId: updateUser parameters: id: $response.body#/data/id invite: operationId: inviteUser parameters: id: $response.body#/data/id delete: operationId: deleteUser parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to add a new user. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "409": description: The user already exists in the workspace. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/users/{id}: get: tags: - Users summary: Get a user operationId: fetchUser parameters: - name: id in: path description: The UUID of the user. required: true schema: type: string format: uuid responses: "200": description: Successfully retrieved the user and their included relationships. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResourceV1_" links: self: operationId: fetchUser parameters: id: $response.body#/data/id update: operationId: updateUser parameters: id: $response.body#/data/id invite: operationId: inviteUser parameters: id: $response.body#/data/id delete: operationId: deleteUser parameters: id: $response.body#/data/id "404": description: The user could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" delete: tags: - Users summary: Delete a user operationId: deleteUser_1 parameters: - name: id in: path description: The UUID of the user. required: true schema: type: string format: uuid responses: "200": description: Successfully deleted the user. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" links: self: operationId: fetchUser parameters: id: $response.body#/data/id update: operationId: updateUser parameters: id: $response.body#/data/id invite: operationId: inviteUser parameters: id: $response.body#/data/id delete: operationId: deleteUser parameters: id: $response.body#/data/id "400": description: "The user couldn’t be deleted because of role or ownership\ \ constraints (e.g., being the last team admin or a last feature flag\ \ owner)." content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: The specified user could not be found. They may not exist or may have already been deleted. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" patch: tags: - Users summary: Update a user operationId: updateUser_1 parameters: - name: id in: path description: The UUID of the user. required: true schema: type: string format: uuid requestBody: description: Information to update about the user. content: application/json: schema: $ref: "#/components/schemas/Request_UserUpdateResourceV1_" required: true responses: "200": description: Successfully updated the user’s information. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResourceV1_" links: self: operationId: fetchUser parameters: id: $response.body#/data/id update: operationId: updateUser parameters: id: $response.body#/data/id invite: operationId: inviteUser parameters: id: $response.body#/data/id delete: operationId: deleteUser parameters: id: $response.body#/data/id "403": description: The authenticated user does not have permission to update the user. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "404": description: The user could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/users/{id}/invite: post: tags: - Users summary: Invite a user operationId: inviteUser parameters: - name: id in: path description: The UUID of the user. required: true schema: type: string format: uuid responses: "200": description: Successfully sent the specified user an email to join the workspace. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_UserResourceV1_" links: self: operationId: fetchUser parameters: id: $response.body#/data/id update: operationId: updateUser parameters: id: $response.body#/data/id invite: operationId: inviteUser parameters: id: $response.body#/data/id delete: operationId: deleteUser parameters: id: $response.body#/data/id "404": description: The user could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "409": description: The user has already accepted an invitation or isn’t eligible to be invited. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/v1/workflow-steps: get: tags: - Workflow Steps summary: Get workflow steps operationId: listWorkflowSteps parameters: - name: "filter[teamIds]" in: query schema: type: - string - "null" description: Filter workflow steps by team IDs. Provide one or more team UUIDs separated by the pipe (`|`) symbol. Use `NONE` to filter for workflow steps not assigned to any team (default workflow steps). example: 123e4567-e89b-12d3-a456-426614174000|NONE name: "filter[teamIds]" exampleSetFlag: true - name: "page[number]" in: query schema: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" - name: "page[size]" in: query schema: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" - name: "page[offset]" in: query schema: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" - name: sort in: query description: | Sorts the list of workflow steps by one or more fields. Prefix a field name with a minus sign (`-`) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include: * `name` * `position` * `category` schema: type: - array - "null" items: type: string example: "category,position" responses: "200": description: Successfully retrieved the list of workflow steps. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowStepResourceV1_" /api/v1/workflow-steps/{id}: get: tags: - Workflow Steps summary: Get a workflow step operationId: fetchWorkflowStep parameters: - name: id in: path description: The UUID of the workflow step. required: true schema: type: string format: uuid responses: "200": description: Successfully retrieved the workflow step. content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkflowStepResourceV1_" links: self: operationId: fetchWorkflowStep parameters: id: $response.body#/data/id "404": description: The workflow step could not be found. content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" /api/vcs/pull_requests: get: tags: - Version Control Pull Requests summary: Get pull requests operationId: listVcsPullRequests parameters: - name: "filter[backlogItemIds]" in: query schema: type: - string - "null" description: Finds pull requests associated to any of the specified backlog items. Provide a pipe-separated list of backlog item UUIDs.. name: "filter[backlogItemIds]" responses: "200": description: Successfully retrieved a list of pull requests. content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_PullRequestResource_" /api/workflows: get: tags: - Workflows summary: "List all workflows, optionally get the default workflow by workflow\ \ type or the team workflow by team ID" operationId: listWorkflows parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/WorkflowController.WorkflowsFilter" responses: "200": description: listWorkflows 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowResource_" /api/workflows/default/{workflowType}/steps: get: tags: - Workflows summary: Retrieves the workflow steps of the default workflows by type (STORY or BUG or TEMPLATE) operationId: getWorkflowSteps parameters: - name: workflowType in: path required: true schema: $ref: "#/components/schemas/WorkflowResource.WorkflowType" responses: "200": description: getWorkflowSteps 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowStepResource_" /api/workflows/steps: get: tags: - Workflows summary: "Retrieves the workflow steps, optionally filtered by team ID, step\ \ category, or item type" operationId: getWorkflowSteps_1 parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/WorkflowController.StepRequestFilter" - name: page in: query required: true schema: $ref: "#/components/schemas/PageFilter" - name: sort in: query required: true schema: type: array items: type: string responses: "200": description: getWorkflowSteps_1 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowStepResource_" post: tags: - Workflows summary: Creates a new workflow step operationId: createWorkflowStep requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkflowStepCreationResource_" required: true responses: "200": description: createWorkflowStep 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkflowStepResource_" /api/workflows/steps/step_item_type_change: post: tags: - Workflows summary: Modifies the item type support of a workflow step description: Modifies the item type support of a workflow step with optional moving of items to different step(s) operationId: updateWorkflowStepItemType requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkflowStepItemTypeChangeResource_" required: true responses: "200": description: updateWorkflowStepItemType 200 response /api/workflows/steps/step_removal: post: tags: - Workflows summary: Remove a workflow step description: Remove a workflow with optional moving of items to different step(s) operationId: removeWorkflowStep requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkflowStepRemovalResource_" required: true responses: "200": description: removeWorkflowStep 200 response /api/workflows/steps/{stepId}: get: tags: - Workflows summary: Retrieves the workflow step by ID operationId: getWorkflowStep parameters: - name: stepId in: path required: true schema: type: string format: uuid responses: "200": description: getWorkflowStep 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkflowStepResource_" delete: tags: - Workflows summary: Deletes a workflow step by ID operationId: deleteWorkflowStep parameters: - name: stepId in: path required: true schema: type: string format: uuid responses: "204": description: deleteWorkflowStep 204 response patch: tags: - Workflows summary: Update a workflow step operationId: updateWorkflowStep parameters: - name: stepId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkflowStepUpdateResource_" required: true responses: "200": description: updateWorkflowStep 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkflowStepResource_" /api/workflows/steps/{stepId}/relationships/backlog_items: get: tags: - Workflows summary: Get the backlog items relationships associated with a workflow step operationId: getBacklogItemsRelationships parameters: - name: stepId in: path required: true schema: type: string format: uuid responses: "200": description: getBacklogItemsRelationships 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" post: tags: - Workflows summary: "Update the backlog items to be associated with a workflow step, replacing\ \ the backlog items' existing workflow step relationships" operationId: addBacklogItemsRelationships parameters: - name: stepId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: true responses: "200": description: addBacklogItemsRelationships 200 response content: application/json: schema: $ref: "#/components/schemas/MultipleRelationships" /api/workflows/{id}: get: tags: - Workflows summary: Retrieves a workflow by ID operationId: getWorkflow parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getWorkflow 200 response content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkflowResource_" /api/workflows/{id}/steps: get: tags: - Workflows summary: Retrieves the workflow steps by workflow ID operationId: getWorkflowSteps_2 parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: getWorkflowSteps_2 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowStepResource_" /api/workflows/{id}/steps/reset: post: tags: - Workflows summary: Reset the workflow steps to default step types operationId: resetWorkflow parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/MultiResourceRequest_WorkflowStepResetResource_" required: true responses: "200": description: resetWorkflow 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkflowStepResource_" /api/workspaces: get: tags: - Workspaces summary: List all user workspaces description: List all workspaces that the user are a member of operationId: listWorkspaces responses: "200": description: All user workspaces content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_WorkspaceResource_" "500": description: Unexpected error /api/workspaces/{id}: delete: summary: Marks a workspace for deletion description: Workspace will be deleted 30 days after being marked. operationId: deleteWorkspace parameters: - name: id in: path required: true schema: type: string format: uuid responses: "200": description: Workspace marked for deletion content: application/json: schema: $ref: "#/components/schemas/NoResourceBody" "400": description: Workspace was not marked for deletion because of deletion constraints "500": description: Unexpected error patch: summary: Update workspace state description: Only a few of the workspace options could be updated. operationId: updateWorkspace parameters: - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/Request_WorkspaceUpdateResource_" required: true responses: "200": description: The updated workspace content: application/json: schema: $ref: "#/components/schemas/SingleResourceBody_WorkspaceResource_" /reports/cycle-time: get: tags: - Reporting summary: Computes the data required for the Cycle Time report operationId: cycleTimeReport parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/CycleTimeReport.Filter" - name: interval in: query required: true schema: $ref: "#/components/schemas/CycleTimeReportController.Interval" - name: resolution in: query schema: type: - "null" - object allOf: - $ref: "#/components/schemas/CycleTimeReportController.Resolution" responses: "200": description: cycleTimeReport 200 response content: application/json: schema: $ref: "#/components/schemas/CycleTimeReport" /reports/cycle-time-by-step: get: tags: - Reporting summary: Computes the data required for the Cycle Time report with a breakdown by steps operationId: cycleTimeByStepReport parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/CycleTimeStepReport.Filter" - name: interval in: query required: true schema: $ref: "#/components/schemas/CycleTimeReportController.Interval" - name: resolution in: query schema: type: - "null" - object allOf: - $ref: "#/components/schemas/CycleTimeReportController.Resolution" responses: "200": description: cycleTimeByStepReport 200 response content: application/json: schema: $ref: "#/components/schemas/CycleTimeStepReport" /reports/usage-tracking: post: tags: - Reporting summary: Computes the data required for the Usage Tracking report operationId: usageEventsReportWithFiltering requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.Request" required: true responses: "200": description: usageEventsReportWithFiltering 200 response content: application/json: schema: $ref: "#/components/schemas/UsageReport" /reports/usage-tracking/by-story: post: tags: - Reporting summary: Computes the data required for the Usage Tracking report broken down by story operationId: usageEventsReportWithFilteringByStory requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.ByStoryRequest" required: true responses: "200": description: usageEventsReportWithFilteringByStory 200 response content: application/json: schema: type: array items: $ref: "#/components/schemas/UsageReport.StoryUsageBin" /reports/usage-tracking/customers: get: tags: - Reporting summary: Returns the list of known customers operationId: knownCustomers parameters: - name: filter in: query required: true schema: $ref: "#/components/schemas/UsageReport.Filter" - name: interval in: query required: true schema: $ref: "#/components/schemas/UsageReport.Interval" responses: "200": description: knownCustomers 200 response content: application/json: schema: type: array items: type: string /reports/usage-tracking/stories: post: tags: - Reporting summary: Returns the list of top 10 stories with the highest usage operationId: mostUsedStories requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.StoriesRequestFilter" required: true responses: "200": description: mostUsedStories 200 response content: application/json: schema: $ref: "#/components/schemas/MultiResourceBody_BacklogItemResource_" /reports/usage-tracking/stories/customers: post: tags: - Reporting summary: Returns the list of known customers operationId: knownCustomersForStories requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.ByStoryRequest" required: true responses: "200": description: knownCustomersForStories 200 response content: application/json: schema: type: array items: type: string /reports/usage-tracking/top-customers: post: tags: - Reporting summary: Returns the top 10 customers by usage count and their timeseries operationId: topCustomers requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.TopCustomerRequest" required: true responses: "200": description: topCustomers 200 response content: application/json: schema: $ref: "#/components/schemas/UsageReport.CustomerUsageReport" /reports/usage-tracking/top-customers/totals: post: tags: - Reporting summary: Returns the top 10 customers by usage count and their totals operationId: topCustomersTotals requestBody: content: application/json: schema: $ref: "#/components/schemas/UsageReport.TopCustomerRequest" required: true responses: "200": description: topCustomersTotals 200 response content: application/json: schema: $ref: "#/components/schemas/UsageReport.CustomersTotalsReport" components: schemas: AcceptanceCriteriaCreationResource: properties: data: type: array items: $ref: "#/components/schemas/AcceptanceCriterionCreationResource" description: A requirement that the work on a story must meet to be considered complete. required: - data AcceptanceCriteriaReplaceResource: properties: data: type: array items: $ref: "#/components/schemas/AcceptanceCriterionUpdateResource" description: A requirement that the work on a story must meet to be considered complete. required: - data AcceptanceCriterionChangeSet: properties: id: type: string format: uuid state: $ref: "#/components/schemas/AcceptanceCriterionChangeSet.State" description: $ref: "#/components/schemas/TextFieldChangeSet" position: $ref: "#/components/schemas/SimpleFieldChangeSet_Integer_" level: $ref: "#/components/schemas/SimpleFieldChangeSet_Integer_" required: - description - id - level - position - state AcceptanceCriterionChangeSet.State: enum: - CREATE - DELETE - UPDATE - KEEP AcceptanceCriterionCreationResource: description: A requirement that the work on a story must meet to be considered complete. properties: type: type: string default: acceptance_criterion description: Identifies the type of resource. pattern: acceptance_criterion defaultValue: acceptance_criterion requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/AcceptanceCriterionCreationResource.AcceptanceCriterionAttributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - type writeOnly: true AcceptanceCriterionCreationResource.AcceptanceCriterionAttributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: description: type: string description: Description of the acceptance criterion. minLength: 1 requiredMode: REQUIRED position: type: - integer - "null" format: int32 description: "The desired position of this acceptance criterion in the list.\ \ The first AC is at position `0`. Atono will attempt to insert the AC\ \ at this position, but the actual result may vary depending on the existing\ \ structure. For example, if no other criteria exist, the item will be\ \ added at position 0 regardless of the value provided." minimum: 0 requiredMode: NOT_REQUIRED level: type: - integer - "null" format: int32 description: The desired nesting level of the criterion. Level `0` indicates a root level criterion; higher values represent subcriteria. maximum: 10 minimum: 0 requiredMode: NOT_REQUIRED required: - description AcceptanceCriterionSnapshot: description: A shortened self-contained version of the AcceptanceCriterion for the purpose of storing a snapshot of the item at a point in time. It is almost identical and the main purpose is to isolate the API DTO object from ever using DB access objects directly. properties: id: type: string format: uuid description: type: string position: type: integer format: int32 level: type: integer format: int32 required: - description - id - level - position AcceptanceCriterionUpdateResource: description: A requirement that the work on a story must meet to be considered complete. properties: type: type: string default: acceptance_criterion description: Identifies the type of resource. pattern: acceptance_criterion defaultValue: acceptance_criterion requiredMode: REQUIRED id: type: - string - "null" format: uuid description: "ID of the acceptance criterion to update. If `null`, a new\ \ criterion will be created. Preserving the ID is important when tracking\ \ usage metrics for individual criteria." requiredMode: NOT_REQUIRED attributes: allOf: - $ref: "#/components/schemas/AcceptanceCriterionUpdateResource.AcceptanceCriterionBacklogItemAttributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - type writeOnly: true AcceptanceCriterionUpdateResource.AcceptanceCriterionBacklogItemAttributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: description: type: - string - "null" description: Description of the acceptance criterion. requiredMode: NOT_REQUIRED position: type: - integer - "null" format: int32 description: "The desired position of this acceptance criterion in the list.\ \ The first AC is at position `0`. Atono will attempt to insert the AC\ \ at this position, but the actual result may vary depending on the existing\ \ structure. For example, if no other criteria exist, the item will be\ \ added at position 0 regardless of the value provided." minimum: 0 requiredMode: NOT_REQUIRED level: type: - integer - "null" format: int32 description: The desired nesting level of the criterion. Level `0` indicates a root level criterion; higher values represent subcriteria. maximum: 10 minimum: 0 requiredMode: NOT_REQUIRED aiAgentName: type: - string - "null" required: - aiAgentName AiActivity.Kind: enum: - DESIGN - INVESTIGATION - SUMMARY AiActivityController.RequestFilter: properties: kind: type: - "null" - object allOf: - $ref: "#/components/schemas/AiActivity.Kind" AiActivityCreationResource: properties: type: type: string pattern: ai_activity attributes: $ref: "#/components/schemas/AiActivityCreationResource.AiActivityAttributes" required: - attributes - type AiActivityCreationResource.AiActivityAttributes: properties: kind: $ref: "#/components/schemas/AiActivity.Kind" content: type: string aiAgentName: type: - string - "null" required: - aiAgentName - content - kind AiActivityResource: properties: type: type: string pattern: ai_activity id: type: string format: uuid attributes: $ref: "#/components/schemas/AiActivityResource.AiActivityAttributes" relationships: $ref: "#/components/schemas/AiActivityResource.AiActivityRelationships" required: - attributes - id - relationships - type AiActivityResource.AiActivityAttributes: properties: createdAt: type: string format: date-time userAgent: type: string kind: $ref: "#/components/schemas/AiActivity.Kind" content: type: string required: - content - createdAt - kind - userAgent AiActivityResource.AiActivityRelationships: properties: item: $ref: "#/components/schemas/SingleRelationship" user: $ref: "#/components/schemas/SingleRelationship" required: - item - user ApiKeyCreationResource: description: An API key to perform calls on the behalf of the user who created the key. properties: type: type: string default: user_api_key description: Identifies the type of resource. pattern: user_api_key defaultValue: user_api_key requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/ApiKeyCreationResource.ApiKeyAttributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - type writeOnly: true ApiKeyCreationResource.ApiKeyAttributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: Human-readable name of the API key. maxLength: 255 minLength: 1 requiredMode: REQUIRED required: - name ApiKeyResource: description: "The returned resource, based on the request." properties: type: type: string pattern: api_key id: type: string attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/ApiKeyResource.Attributes" required: - id - type ApiKeyResource.ApiKeyAttributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: createdAt: type: string format: date-time description: The date and time when the key was created. updatedAt: type: string format: date-time description: The date and time when the key last updated. usedAt: type: string format: date-time description: The date and time when the key last used. name: type: string description: Human-readable name of the API key. maxLength: 255 value: type: string description: The actual API key value. Set it in the headers of your requests according to the documentation to perform API call on behalf of the user that created the key. ApiKeyResource.ApiKeyRelationships: description: Contains references to other related resources. properties: user: allOf: - $ref: "#/components/schemas/SingleRelationship" description: The user that is associated to the API key. ApiKeyResource.Attributes: properties: key: type: string keyType: type: string required: - key - keyType ApiKeyResource_1: description: An API key to perform calls on the behalf of the user who created the key. properties: type: type: string default: user_api_key description: Identifies the type of resource. pattern: user_api_key defaultValue: user_api_key id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/ApiKeyResource.ApiKeyAttributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/ApiKeyResource.ApiKeyRelationships" description: Contains references to other related resources. readOnly: true ApiKeyUpdateResource: description: An API key to perform calls on the behalf of the user who created the key. properties: type: type: string default: user_api_key description: Identifies the type of resource. pattern: user_api_key defaultValue: user_api_key requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/ApiKeyUpdateResource.ApiKeyAttributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." readOnly: true required: - attributes - id - type ApiKeyUpdateResource.ApiKeyAttributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: Human-readable name of the API key. maxLength: 255 minLength: 1 requiredMode: REQUIRED required: - name AtonoSlackAppInstallationResponse: description: Atono slack app installation response. Contains a url to install the app. properties: url: type: string description: Atono slack app installation url Attachment.Status: enum: - ACTIVE - DELETED - ARCHIVED AttachmentChangeSet: properties: state: $ref: "#/components/schemas/AttachmentChangeSet.State" path: type: string fileName: type: string thumbnail: type: string required: - fileName - path - state - thumbnail AttachmentChangeSet.State: enum: - CREATE - DELETE AttachmentController.InclusionType: enum: - DOWNLOAD_URL AttachmentCreationResource: properties: type: type: string pattern: attachment attributes: $ref: "#/components/schemas/AttachmentCreationResource.AttachmentAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/AttachmentCreationResource.AttachmentRelationships" required: - attributes - relationships - type AttachmentCreationResource.AttachmentAttributes: properties: path: type: string minLength: 1 description: type: string maxLength: 200 height: type: - integer - "null" format: int64 minimum: 0 width: type: - integer - "null" format: int64 minimum: 0 required: - description - height - path - width AttachmentCreationResource.AttachmentRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion - backlogItem AttachmentResource: description: "The returned resource, based on the request." properties: type: type: string pattern: attachment id: type: string format: uuid attributes: $ref: "#/components/schemas/AttachmentResource.AttachmentAttributes" relationships: $ref: "#/components/schemas/AttachmentResource.AttachmentRelationships" meta: $ref: "#/components/schemas/AttachmentResource.Metadata" required: - attributes - id - meta - relationships - type AttachmentResource.AttachmentAttributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time path: type: string minLength: 1 description: type: string maxLength: 200 size: type: integer format: int64 height: type: integer format: int64 width: type: integer format: int64 contentType: type: string thumbnail: type: string status: $ref: "#/components/schemas/Attachment.Status" position: type: number format: double required: - contentType - createdAt - description - height - path - position - size - status - thumbnail - updatedAt - width AttachmentResource.AttachmentRelationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" backlogItem: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion - backlogItem - creator AttachmentResource.Metadata: properties: accessible: type: boolean downloadUrl: type: string required: - accessible - downloadUrl AttachmentUpdateResource: properties: type: type: string pattern: attachment id: type: string format: uuid attributes: $ref: "#/components/schemas/AttachmentUpdateResource.AttachmentAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/AttachmentUpdateResource.AttachmentRelationships" required: - attributes - id - relationships - type AttachmentUpdateResource.AttachmentAttributes: properties: height: type: - integer - "null" format: int64 minimum: 0 width: type: - integer - "null" format: int64 minimum: 0 position: type: - number - "null" format: double description: | Position change request. At the moment we are only paying attention to the sign of the value. Positive number means to move right (down) in the list. Negative number means to move the other way. requiredMode: NOT_REQUIRED required: - height - width AttachmentUpdateResource.AttachmentRelationships: properties: acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion BacklogItem.CycleTimeMode: enum: - NORMAL - OUTLIER BacklogItem.ImportMetadata: properties: importSource: $ref: "#/components/schemas/BacklogItem.ImportSource" itemId: type: string itemLabels: type: string itemPriority: type: string itemSize: type: string team: type: string sampleData: type: boolean syncStatus: $ref: "#/components/schemas/BacklogItem.SyncStatus" syncDate: type: string format: date-time jiraUpdatedAt: type: string format: date-time required: - importSource - itemId - itemLabels - itemPriority - itemSize - jiraUpdatedAt - sampleData - syncDate - syncStatus - team BacklogItem.ImportSource: enum: - LINEAR - JIRA - JIRA_SYNC - SAMPLE_DATA - ATONO_IMPORT BacklogItem.ItemType: enum: - STORY - BUG - TASK - VULNERABILITY - EPIC BacklogItem.RiskRating: properties: rating: type: integer format: int32 impact: type: integer format: int32 probability: type: integer format: int32 required: - impact - probability - rating BacklogItem.SizingMode: enum: - MANUAL - USE_SUGGESTION BacklogItem.SyncStatus: enum: - IN_PROGRESS - COMPLETED - FAILED - JIRA_NEWER - UNSYNCED BacklogItem.Triage: enum: - NOT_TRIAGED - TRIAGED - REJECTED - INFO_REQUIRED BacklogItemChangeRationale: enum: - TEAM_DELETION - WORKFLOW_STEP_DELETION - WORKFLOW_STEP_ITEM_TYPE_UPDATE - WORKFLOW_RESET - TEAM_WORKFLOW_TYPE_TO_KANBAN - TEAM_WORKFLOW_TYPE_TO_SCRUM BacklogItemChangeSetResource: properties: type: type: string pattern: backlog_item_change_set id: type: string format: uuid attributes: $ref: "#/components/schemas/BacklogItemChangeSetResource.BacklogItemChangeSetAttributes" relationships: $ref: "#/components/schemas/BacklogItemChangeSetResource.BacklogItemChangeSetRelationships" required: - attributes - id - relationships - type BacklogItemChangeSetResource.BacklogItemChangeSetAttributes: properties: snapshot: $ref: "#/components/schemas/BacklogItemSnapshot" isCreation: type: boolean title: $ref: "#/components/schemas/TextFieldChangeSet" position: $ref: "#/components/schemas/SimpleFieldChangeSet_Integer_" workflowStep: $ref: "#/components/schemas/SimpleFieldChangeSet_WorkflowStepSnapshot_" assignee: $ref: "#/components/schemas/SimpleFieldChangeSet_UUID_" creator: $ref: "#/components/schemas/SimpleFieldChangeSet_UUID_" team: $ref: "#/components/schemas/SimpleFieldChangeSet_UUID_" featureFlag: $ref: "#/components/schemas/SimpleFieldChangeSet_FeatureFlagHistoricalIdentifier_" featureFlagState: $ref: "#/components/schemas/FlagRulesetChangeSet" content: $ref: "#/components/schemas/CollectionFieldChangeSet_BacklogItemContentChunk.BacklogItemContentChunk_" additionalContent: $ref: "#/components/schemas/CollectionFieldChangeSet_BacklogItemContentChunk.BacklogItemContentChunk_" acceptanceCriteria: $ref: "#/components/schemas/CollectionFieldChangeSet_AcceptanceCriterionSnapshot.AcceptanceCriterionChangeSet_" triage: $ref: "#/components/schemas/SimpleFieldChangeSet_BugTriageSnapshot_" createdAt: type: string format: date-time comment: $ref: "#/components/schemas/CommentChangeSet" attachment: type: array items: $ref: "#/components/schemas/AttachmentChangeSet" size: $ref: "#/components/schemas/SimpleFieldChangeSet_ItemSizeIdentifier_" cycleTimeMode: $ref: "#/components/schemas/SimpleFieldChangeSet_BacklogItem.CycleTimeMode_" environment: $ref: "#/components/schemas/CollectionFieldChangeSet_EnvironmentHistoricalIdentifier.EnvironmentHistoricalIdentifier_" linkedItems: $ref: "#/components/schemas/CollectionFieldDiffChangeSet_HistoricalIdentifier_" epicItems: $ref: "#/components/schemas/CollectionFieldDiffChangeSet_HistoricalIdentifier_" timebox: $ref: "#/components/schemas/SimpleFieldChangeSet_HistoricalIdentifier_" tagValues: $ref: "#/components/schemas/CollectionFieldDiffChangeSet_HistoricalIdentifier_" productTheme: $ref: "#/components/schemas/SimpleFieldChangeSet_HistoricalIdentifier_" changeContext: type: array items: $ref: "#/components/schemas/ContextChangeSet" importMetadata: $ref: "#/components/schemas/SimpleFieldChangeSet_BacklogItem.ImportMetadata_" restoreVersion: type: string format: uuid vcsPullRequests: type: array items: $ref: "#/components/schemas/VcsPullRequest" userAgent: type: string sprint: $ref: "#/components/schemas/SimpleFieldChangeSet_HistoricalIdentifier_" splitStory: $ref: "#/components/schemas/BacklogItemSplitSnapshot" subtasks: $ref: "#/components/schemas/CollectionFieldChangeSet_SubtaskSnapshot.SubtaskChangeSet_" review: $ref: "#/components/schemas/SimpleFieldChangeSet_HistoricalIdentifier_" required: - acceptanceCriteria - additionalContent - assignee - attachment - changeContext - comment - content - createdAt - creator - cycleTimeMode - environment - epicItems - featureFlag - featureFlagState - importMetadata - isCreation - linkedItems - position - productTheme - restoreVersion - review - size - snapshot - splitStory - sprint - subtasks - tagValues - team - timebox - title - triage - userAgent - vcsPullRequests - workflowStep BacklogItemChangeSetResource.BacklogItemChangeSetRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" actor: $ref: "#/components/schemas/SingleRelationship" originalAssignee: $ref: "#/components/schemas/SingleRelationship" modifiedAssignee: $ref: "#/components/schemas/SingleRelationship" originalCreator: $ref: "#/components/schemas/SingleRelationship" modifiedCreator: $ref: "#/components/schemas/SingleRelationship" originalTeam: $ref: "#/components/schemas/SingleRelationship" modifiedTeam: $ref: "#/components/schemas/SingleRelationship" featureFlagsReference: $ref: "#/components/schemas/MultipleRelationships" originalCommentAuthor: $ref: "#/components/schemas/SingleRelationship" linkedItemsAdded: $ref: "#/components/schemas/MultipleRelationships" linkedItemsRemoved: $ref: "#/components/schemas/MultipleRelationships" epicItemsAdded: $ref: "#/components/schemas/MultipleRelationships" epicItemsRemoved: $ref: "#/components/schemas/MultipleRelationships" originalTimebox: $ref: "#/components/schemas/SingleRelationship" modifiedTimebox: $ref: "#/components/schemas/SingleRelationship" tagValuesAdded: $ref: "#/components/schemas/MultipleRelationships" tagValuesRemoved: $ref: "#/components/schemas/MultipleRelationships" originalProductTheme: $ref: "#/components/schemas/SingleRelationship" modifiedProductTheme: $ref: "#/components/schemas/SingleRelationship" duplicatedFromBacklogItem: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" originalSprint: $ref: "#/components/schemas/SingleRelationship" modifiedSprint: $ref: "#/components/schemas/SingleRelationship" subtaskAssigneesReference: $ref: "#/components/schemas/MultipleRelationships" required: - actor - backlogItem - duplicatedFromBacklogItem - epicItemsAdded - epicItemsRemoved - featureFlagsReference - linkedItemsAdded - linkedItemsRemoved - modifiedAssignee - modifiedCreator - modifiedProductTheme - modifiedSprint - modifiedTeam - modifiedTimebox - originalAssignee - originalCommentAuthor - originalCreator - originalProductTheme - originalSprint - originalTeam - originalTimebox - subtaskAssigneesReference - tagValuesAdded - tagValuesRemoved BacklogItemChannelCreateResource: properties: type: type: string pattern: backlogitem_channel attributes: $ref: "#/components/schemas/BacklogItemChannelCreateResource.BacklogItemChannelAttributes" relationships: $ref: "#/components/schemas/BacklogItemChannelCreateResource.BacklogItemChannelRelationships" required: - attributes - relationships - type BacklogItemChannelCreateResource.BacklogItemChannelAttributes: properties: slackChannelId: type: - string - "null" maxLength: 80 slackChannelName: type: - string - "null" maxLength: 80 required: - slackChannelId - slackChannelName BacklogItemChannelCreateResource.BacklogItemChannelRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - backlogItem BacklogItemChannelFilter: properties: backlogItemId: type: - string - "null" format: uuid BacklogItemChannelResource: properties: type: type: string pattern: backlogitem_channel id: type: string attributes: $ref: "#/components/schemas/BacklogItemChannelResource.BacklogItemChannelAttributes" relationships: $ref: "#/components/schemas/BacklogItemChannelResource.BacklogItemChannelRelationships" meta: $ref: "#/components/schemas/BacklogItemChannelResource.BacklogItemChannelMetadata" required: - attributes - id - meta - relationships - type BacklogItemChannelResource.BacklogItemChannelAttributes: properties: slackChannelId: type: string minLength: 1 slackChannelUrl: type: string required: - slackChannelId - slackChannelUrl BacklogItemChannelResource.BacklogItemChannelMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions BacklogItemChannelResource.BacklogItemChannelRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" required: - backlogItem BacklogItemChannelUpdateResource: properties: type: type: string pattern: backlogitem_channel id: type: string format: uuid attributes: $ref: "#/components/schemas/BacklogItemChannelUpdateResource.BacklogItemChannelAttributes" required: - attributes - id - type BacklogItemChannelUpdateResource.BacklogItemChannelAttributes: properties: slackChannelId: type: - string - "null" maxLength: 80 slackChannelName: type: - string - "null" maxLength: 80 required: - slackChannelId - slackChannelName BacklogItemContentChunk.ContentChunkType: description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story. enum: - DISPLAY_HTML - TEXT - PERSONA BacklogItemController.InclusionType: enum: - ACCEPTANCE_CRITERIA - ASSIGNEE - ATTACHMENTS - COMMENTS - CREATOR - CYCLE_TIME - ENVIRONMENTS - EPIC - EPIC_STORIES - FEATURE_FLAG - IS_FOLLOWED_ITEM - ITEM_TIMES_TEAM_STATS - LINKED_ITEMS - LINKED_ITEMS_STEPS - PRODUCT_THEME - RISK_RATING - SPRINT - STEP - STORY_POINT_TOTAL - STORY_POINT_TOTALS - SUBTASK_COUNT - SUBTASKS - TAG_VALUES - TEAM - TIMEBOX - VCS_PULL_REQUESTS BacklogItemController.RequestFilter: properties: savedViewId: type: - string - "null" format: uuid assigneeIds: type: - string - "null" createdAt: type: - string - "null" cycleTimeMode: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" doneAt: type: - string - "null" environmentIds: type: - string - "null" excludeLinkedItemId: type: - string - "null" format: uuid externalId: type: - string - "null" keywordSearch: type: - string - "null" productThemeIds: type: - string - "null" epicIds: type: - string - "null" riskRating: type: - string - "null" sizeIds: type: - string - "null" sprintIds: type: - string - "null" stepIds: type: - string - "null" teamIds: type: - string - "null" teams: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemController.TeamsType" timeboxIds: type: - string - "null" triageGroup: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemController.TriageGroup" type: type: - string - "null" updatedAt: type: - string - "null" isFollowedByUser: type: - string - "null" format: uuid isNotFollowedByUser: type: - string - "null" format: uuid tagValueIds: type: - string - "null" tagIds: type: - string - "null" excludeTagValueIds: type: - string - "null" excludeTagIds: type: - string - "null" BacklogItemController.TagValueInclusionType: enum: - TAG BacklogItemController.TeamsType: enum: - ALL - ACTIVE - PUBLIC - SPECIFIED - USER_RELATED - USER_RELATED_WITH_DELETED BacklogItemController.TriageGroup: enum: - TRIAGE - NOT_TRIAGED - INFO_REQUIRED - REJECTED BacklogItemCreationResource: properties: type: type: string pattern: backlog_item attributes: $ref: "#/components/schemas/BacklogItemCreationResource.BacklogItemAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemCreationResource.BacklogItemRelationships" required: - attributes - relationships - type BacklogItemCreationResource.BacklogItemAttributes: properties: title: type: string maxLength: 200 minLength: 1 itemType: $ref: "#/components/schemas/BacklogItem.ItemType" position: type: - integer - "null" format: int32 minimum: 0 content: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. additionalContent: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. backfillDate: type: - string - "null" format: date-time epicPosition: type: - integer - "null" format: int32 minimum: 0 aiAgentName: type: - string - "null" required: - additionalContent - aiAgentName - backfillDate - content - epicPosition - itemType - position - title BacklogItemCreationResource.BacklogItemRelationships: properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/AcceptanceCriteriaCreationResource" size: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" productTheme: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" linkedItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" timebox: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" sprint: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" impact: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" probability: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" reporter: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" duplicatedFrom: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" required: - acceptanceCriteria - assignee - duplicatedFrom - environments - epic - impact - linkedItems - probability - productTheme - reporter - size - sprint - team - timebox - workflowStep BacklogItemFilterResource: properties: type: type: string pattern: backlog_item_filter attributes: $ref: "#/components/schemas/BacklogItemFilterResource.BacklogItemFilterAttributes" required: - attributes - type BacklogItemFilterResource.BacklogItemFilterAttributes: properties: assigneeIds: type: - array - "null" items: type: string createdAt: type: - "null" - object allOf: - $ref: "#/components/schemas/DateRange" cycleTimeMode: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" doneAt: type: - "null" - object allOf: - $ref: "#/components/schemas/DateRange" environmentIds: type: - array - "null" items: type: string epicIds: type: - array - "null" items: type: string excludeLinkedItemId: type: - string - "null" format: uuid externalId: type: - array - "null" items: type: string productThemeIds: type: - array - "null" items: type: string riskRatings: type: - string - "null" keywordSearch: type: - string - "null" maxLength: 500 sizeIds: type: - array - "null" items: type: string stepCategories: type: - array - "null" items: $ref: "#/components/schemas/StepCategory" description: "The category of the workflow step. Valid values are `TODO`\ \ (To do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO`\ \ (Won't do). The category determines the general stage of work items\ \ in this step." stepIds: type: - array - "null" items: type: string format: uuid stepNames: type: - array - "null" items: type: string maxLength: 100 stepExpressions: type: - array - "null" items: type: string maxLength: 1000 teamIds: type: - array - "null" items: type: string timeboxIds: type: - array - "null" items: type: string itemType: type: - array - "null" items: $ref: "#/components/schemas/BacklogItem.ItemType" updatedAt: type: - "null" - object allOf: - $ref: "#/components/schemas/DateRange" teamsType: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemController.TeamsType" isFollowedByUser: type: - string - "null" format: uuid isNotFollowedByUser: type: - string - "null" format: uuid tagValueIds: type: - array - "null" items: type: string tagIds: type: - array - "null" items: type: string excludeTagValueIds: type: - array - "null" items: type: string excludeTagIds: type: - array - "null" items: type: string required: - assigneeIds - createdAt - cycleTimeMode - doneAt - environmentIds - epicIds - excludeLinkedItemId - excludeTagIds - excludeTagValueIds - externalId - isFollowedByUser - isNotFollowedByUser - itemType - keywordSearch - productThemeIds - riskRatings - sizeIds - stepCategories - stepExpressions - stepIds - stepNames - tagIds - tagValueIds - teamIds - teamsType - timeboxIds - updatedAt BacklogItemHistoryFilter: properties: changed: type: - string - "null" originalAssignee: type: - string - "null" format: uuid modifiedAssignee: type: - string - "null" format: uuid originalCreator: type: - string - "null" format: uuid modifiedCreator: type: - string - "null" format: uuid originalTeam: type: - string - "null" format: uuid modifiedTeam: type: - string - "null" format: uuid containsText: type: - string - "null" source: type: - string - "null" BacklogItemResource: properties: type: type: string pattern: backlog_item id: type: string format: uuid attributes: $ref: "#/components/schemas/BacklogItemResource.BacklogItemAttributes" relationships: $ref: "#/components/schemas/BacklogItemResource.BacklogItemRelationships" meta: $ref: "#/components/schemas/BacklogItemResource.BacklogItemMetadata" required: - attributes - id - meta - relationships - type BacklogItemResource.BacklogItemAttributes: properties: title: type: string maxLength: 200 minLength: 1 handle: type: string maxLength: 200 minLength: 1 position: type: integer format: int32 deleted: type: boolean itemType: $ref: "#/components/schemas/BacklogItem.ItemType" createdAt: type: string format: date-time updatedAt: type: string format: date-time triage: $ref: "#/components/schemas/BacklogItem.Triage" cycleTimeMode: $ref: "#/components/schemas/BacklogItem.CycleTimeMode" stalenessIndicatorSnoozeUntil: type: string format: date-time doneAt: type: string format: date-time externalId: type: string content: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. additionalContent: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. sizingMode: $ref: "#/components/schemas/BacklogItem.SizingMode" epicPosition: type: - integer - "null" format: int32 required: - additionalContent - content - createdAt - cycleTimeMode - deleted - doneAt - epicPosition - externalId - handle - itemType - position - sizingMode - stalenessIndicatorSnoozeUntil - title - triage - updatedAt BacklogItemResource.BacklogItemMetadata: properties: state: $ref: "#/components/schemas/State" riskRating: $ref: "#/components/schemas/BacklogItem.RiskRating" allowedActions: type: array items: type: string isFollowedItem: type: - boolean - "null" subtaskCount: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemResource.SubtaskCount" syncDate: type: - string - "null" format: date-time syncStatus: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.SyncStatus" jiraUpdatedAt: type: - string - "null" format: date-time required: - allowedActions - isFollowedItem - jiraUpdatedAt - riskRating - state - subtaskCount - syncDate - syncStatus BacklogItemResource.BacklogItemRelationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" workflowStep: $ref: "#/components/schemas/SingleRelationship" assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" attachments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" comments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" featureFlag: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" impact: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" probability: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" size: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" linkedItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" timebox: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" sprint: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" productTheme: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" vcsPullRequests: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" epicStories: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" subtasks: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" tagValues: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - acceptanceCriteria - assignee - attachments - comments - creator - environments - epic - epicStories - featureFlag - impact - linkedItems - probability - productTheme - size - sprint - subtasks - tagValues - team - timebox - vcsPullRequests - workflowStep BacklogItemResource.SubtaskCount: properties: undone: type: integer format: int32 required: - undone BacklogItemSnapshot: description: A shortened self-contained version of the BacklogItem for the purpose of storing a snapshot of the item at a point in time. It does not store the fields that never change or references to other objects that are not shown in the change deep dive UI. properties: title: type: string content: type: array items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. additionalContent: type: array items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. acceptanceCriteria: type: array items: $ref: "#/components/schemas/AcceptanceCriterionSnapshot" description: A shortened self-contained version of the AcceptanceCriterion for the purpose of storing a snapshot of the item at a point in time. It is almost identical and the main purpose is to isolate the API DTO object from ever using DB access objects directly. required: - acceptanceCriteria - additionalContent - content - title BacklogItemSplitSnapshot: description: A self-contained record of the information that goes into the split of the story. Records the direction of the split as well. properties: otherStoryId: type: string format: uuid otherStoryTitle: type: string otherStoryHandle: type: string required: - otherStoryHandle - otherStoryId - otherStoryTitle BacklogItemUpdateResource: properties: type: type: string pattern: backlog_item id: type: string format: uuid attributes: $ref: "#/components/schemas/BacklogItemUpdateResource.BacklogItemAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemUpdateResource.BacklogItemRelationships" required: - attributes - id - relationships - type BacklogItemUpdateResource.BacklogItemAttributes: properties: title: type: - string - "null" maxLength: 200 position: type: - integer - "null" format: int32 minimum: 0 triage: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.Triage" content: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. additionalContent: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. cycleTimeMode: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" stalenessIndicatorSnoozeUntil: type: - string - "null" format: date-time restoreVersion: type: - string - "null" format: uuid sizingMode: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.SizingMode" epicPosition: type: - integer - "null" format: int32 minimum: 0 aiAgentName: type: - string - "null" required: - additionalContent - aiAgentName - content - cycleTimeMode - epicPosition - position - restoreVersion - sizingMode - stalenessIndicatorSnoozeUntil - title - triage BacklogItemUpdateResource.BacklogItemRelationships: properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" creator: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/AcceptanceCriteriaReplaceResource" featureFlag: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" impact: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" probability: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" size: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" linkedItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" timebox: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" sprint: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" productTheme: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" required: - acceptanceCriteria - assignee - creator - environments - epic - featureFlag - impact - linkedItems - probability - productTheme - size - sprint - team - timebox - workflowStep BacklogItemsTaggingJobResource: properties: type: type: string pattern: backlog_items_tagging_job attributes: $ref: "#/components/schemas/BacklogItemsTaggingJobResource.Attributes" relationships: $ref: "#/components/schemas/BacklogItemsTaggingJobResource.Relationships" required: - attributes - relationships - type BacklogItemsTaggingJobResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" required: - state BacklogItemsTaggingJobResource.Relationships: properties: tagValue: $ref: "#/components/schemas/SingleRelationship" backlogItems: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - backlogItems - tagValue BacklogItemsTaggingJobResponse: description: "The returned resource, based on the request." properties: type: type: string pattern: backlog_items_tagging_job id: type: string attributes: $ref: "#/components/schemas/BacklogItemsTaggingJobResponse.Attributes" relationships: $ref: "#/components/schemas/BacklogItemsTaggingJobResponse.Relationships" meta: $ref: "#/components/schemas/BacklogItemsTaggingJobResponse.Metadata" required: - attributes - id - meta - relationships - type BacklogItemsTaggingJobResponse.Attributes: properties: state: $ref: "#/components/schemas/JobResponseState" required: - state BacklogItemsTaggingJobResponse.Metadata: properties: itemsUpdated: type: integer format: int32 itemsWithDifferentValues: type: integer format: int32 required: - itemsUpdated - itemsWithDifferentValues BacklogItemsTaggingJobResponse.Relationships: properties: tagValue: $ref: "#/components/schemas/SingleRelationship" tag: $ref: "#/components/schemas/SingleRelationship" backlogItems: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - tag - tagValue BacklogItemsUntaggingJobResource: properties: type: type: string pattern: backlog_items_untagging_job attributes: $ref: "#/components/schemas/BacklogItemsUntaggingJobResource.Attributes" relationships: $ref: "#/components/schemas/BacklogItemsUntaggingJobResource.Relationships" required: - attributes - relationships - type BacklogItemsUntaggingJobResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" allTags: type: - boolean - "null" required: - state BacklogItemsUntaggingJobResource.Relationships: properties: backlogItems: $ref: "#/components/schemas/MultipleRelationshipsUpdate" tag: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" tagValue: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - backlogItems BacklogItemsUntaggingJobResponse: description: "The returned resource, based on the request." properties: type: type: string pattern: backlog_items_untagging_job id: type: string attributes: $ref: "#/components/schemas/BacklogItemsUntaggingJobResponse.Attributes" relationships: $ref: "#/components/schemas/BacklogItemsUntaggingJobResponse.Relationships" meta: $ref: "#/components/schemas/BacklogItemsUntaggingJobResponse.Metadata" required: - attributes - id - meta - relationships - type BacklogItemsUntaggingJobResponse.Attributes: properties: state: $ref: "#/components/schemas/JobResponseState" allTags: type: - boolean - "null" required: - state BacklogItemsUntaggingJobResponse.Metadata: properties: itemsUpdated: type: integer format: int32 itemsToUpdate: type: integer format: int32 required: - itemsToUpdate - itemsUpdated BacklogItemsUntaggingJobResponse.Relationships: properties: backlogItems: $ref: "#/components/schemas/MultipleRelationships" tag: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" tagValue: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - backlogItems BillingDetailsResource: properties: type: type: string pattern: billing_details id: type: string attributes: $ref: "#/components/schemas/BillingDetailsResource.BillingDetailsResourceAttributes" required: - attributes - id - type BillingDetailsResource.BillingDetailsAddress: properties: city: type: string country: type: string line1: type: string line2: type: string postalCode: type: string state: type: string required: - city - country - line1 - line2 - postalCode - state BillingDetailsResource.BillingDetailsResourceAttributes: properties: cardBrand: type: string cardCountry: type: string expMonth: type: integer format: int64 expYear: type: integer format: int64 lastFour: type: string cardFunding: type: string billingName: type: string billingEmail: type: string billingPhone: type: string billingAddress: $ref: "#/components/schemas/BillingDetailsResource.BillingDetailsAddress" required: - billingAddress - billingEmail - billingName - billingPhone - cardBrand - cardCountry - cardFunding - expMonth - expYear - lastFour BillingSessionRequestResource: properties: returnUrl: type: string required: - returnUrl BillingSessionResource: description: "The returned resource, based on the request." properties: type: type: string pattern: billing_session attributes: $ref: "#/components/schemas/BillingSessionResource.BillingSessionAttributes" required: - attributes - type BillingSessionResource.BillingSessionAttributes: properties: url: type: string required: - url BugController.InclusionType: enum: - ASSIGNEE - CREATOR - TEAM - WORKFLOW_STEP - ENVIRONMENTS BugCreateResource: description: A bug is a tracked issue observed during use or testing that should be fixed. properties: type: type: string default: bug description: Identifies the type of resource. pattern: bug defaultValue: bug requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/BugCreateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/BugCreateResource.Relationships" description: Contains references to other related resources. required: - attributes - type writeOnly: true BugCreateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the bug. maxLength: 200 minLength: 1 requiredMode: REQUIRED content: type: - array - "null" description: "A description of the bug, including a summary, reproduction\ \ steps, and expected and actual behavior." example: "When calling the /bugs endpoint with a valid authentication token,\ \ the API intermittently returns a 500 Internal Server Error." items: $ref: "#/components/schemas/ContentChunk_37" description: A segment of content in the description of a story or a bug. exampleSetFlag: true requiredMode: NOT_REQUIRED required: - title BugCreateResource.Relationships: description: Contains references to other related resources. properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: user description: "A relationship object linking to the user assigned to the\ \ bug. If `null`, the bug is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: team description: "A relationship object linking to the team backlog the bug\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the bug is in Bug triage." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: workflow_step description: "A relationship object linking to the workflow step the bug\ \ is currently in. Includes a reference to the workflow step, along with\ \ related links and metadata." environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" default: "[{\"type\": \"environment\"}]" description: "A relationship object linking to the bug’s environments. The\ \ object includes resource identifiers, related links, and metadata." BugResource: description: A bug is a tracked issue observed during use or testing that should be fixed. properties: type: type: string default: bug description: Identifies the type of resource. pattern: bug defaultValue: bug id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/BugResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/BugResource.Relationships" description: Contains references to other related resources. readOnly: true BugResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the bug. handle: type: string description: "A unique identifier for the bug, shown in the Atono application\ \ as the item ID (e.g., `BUG-123`)." position: type: integer format: int32 description: "Indicates the bug’s position within its current workflow step,\ \ where `0` is the topmost item. Position is relative to the step and\ \ team backlog. Not relevant for bugs in Bug triage." content: type: - array - "null" description: "A description of the bug, including a summary, reproduction\ \ steps, and expected and actual behavior." example: "When calling the /bugs endpoint with a valid authentication token,\ \ the API intermittently returns a 500 Internal Server Error." items: $ref: "#/components/schemas/ContentChunk_33" description: A segment of content in the description of a story or a bug. readOnly: true exampleSetFlag: true cycleTimeMode: allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" description: "Indicates whether the bug is marked as an `OUTLIER` (excluded)\ \ or left as `NORMAL` (included) in average cycle time calculations, reports,\ \ and staleness indicators." stalenessIndicatorSnoozeUntil: type: string format: date-time description: "The date and time until which the staleness indicator is hidden\ \ for this bug in its current step and team backlog. Once the date passes,\ \ the indicator is shown again if the bug is still stale." createdAt: type: string format: date-time description: The date and time the bug was created. updatedAt: type: string format: date-time description: The date and time the bug was last updated. doneAt: type: string format: date-time description: The date and time the bug was fixed (completed). deleted: type: boolean description: Indicates whether the bug has been deleted. BugResource.Relationships: description: Contains references to other related resources. properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user assigned to the\ \ bug. If `null`, the bug is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the team backlog the bug\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the bug is in Bug triage." reporter: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user who reported the\ \ bug. Includes a reference to the user, along with related links and\ \ metadata." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the workflow step the bug\ \ is currently in. Includes a reference to the workflow step, along with\ \ related links and metadata." attachments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the bug’s attachments. The\ \ object includes resource identifiers, related links, and metadata." environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the bug’s environments. The\ \ object includes resource identifiers, related links, and metadata." BugTriageSnapshot: description: A snapshot of the bug triage state and risk rating properties: triage: $ref: "#/components/schemas/BacklogItem.Triage" riskRating: $ref: "#/components/schemas/BacklogItem.RiskRating" impact: $ref: "#/components/schemas/Impact" probability: $ref: "#/components/schemas/Probability" aiSuggested: type: - boolean - "null" required: - impact - probability - riskRating - triage BugUpdateResource: description: A bug is a tracked issue observed during use or testing that should be fixed. properties: type: type: string default: bug description: Identifies the type of resource. pattern: bug defaultValue: bug requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/BugUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/BugUpdateResource.Relationships" description: Contains references to other related resources. required: - id - type writeOnly: true BugUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: - string - "null" description: The title of the bug. maxLength: 200 requiredMode: NOT_REQUIRED content: type: - array - "null" description: "A description of the bug, including a summary, reproduction\ \ steps, and expected and actual behavior." example: "When calling the /bugs endpoint with a valid authentication token,\ \ the API intermittently returns a 500 Internal Server Error." items: $ref: "#/components/schemas/ContentChunk_39" description: A segment of content in the description of a story or a bug. exampleSetFlag: true requiredMode: NOT_REQUIRED BugUpdateResource.Relationships: description: Contains references to other related resources. properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: user description: "A relationship object linking to the user assigned to the\ \ bug. If `null`, the bug is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: team description: "A relationship object linking to the team backlog the bug\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the bug is in Bug triage." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: workflow_step description: "A relationship object linking to the workflow step the bug\ \ is currently in. Includes a reference to the workflow step, along with\ \ related links and metadata." reporter: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: user description: "A relationship object linking to the user who reported the\ \ bug. Includes a reference to the user, along with related links and\ \ metadata." environments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" default: data: - type: environment id: 00000000-0000-0000-0000-000000000000 description: "A relationship object linking to the bug’s environments. The\ \ object includes resource identifiers, related links, and metadata." linkedItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" default: data: - type: bug id: 00000000-0000-0000-0000-000000000000 description: A relationship object linking to the bug’s linked items. CheckoutSessionRequestResource: properties: data: type: array items: $ref: "#/components/schemas/CheckoutSessionRequestResource.CheckoutItemResource" required: - data CheckoutSessionRequestResource.CheckoutItemResource: properties: priceId: type: string quantity: type: integer format: int64 required: - priceId - quantity CheckoutSessionResource: description: "The returned resource, based on the request." properties: type: type: string pattern: checkout_session attributes: $ref: "#/components/schemas/CheckoutSessionResource.Attributes" required: - attributes - type CheckoutSessionResource.Attributes: properties: url: type: string required: - url CollectionFieldChangeSet_AcceptanceCriterionSnapshot.AcceptanceCriterionChangeSet_: properties: original: type: array items: $ref: "#/components/schemas/AcceptanceCriterionSnapshot" description: A shortened self-contained version of the AcceptanceCriterion for the purpose of storing a snapshot of the item at a point in time. It is almost identical and the main purpose is to isolate the API DTO object from ever using DB access objects directly. modified: type: array items: $ref: "#/components/schemas/AcceptanceCriterionSnapshot" description: A shortened self-contained version of the AcceptanceCriterion for the purpose of storing a snapshot of the item at a point in time. It is almost identical and the main purpose is to isolate the API DTO object from ever using DB access objects directly. changes: type: - array - "null" items: $ref: "#/components/schemas/AcceptanceCriterionChangeSet" required: - modified - original CollectionFieldChangeSet_BacklogItemContentChunk.BacklogItemContentChunk_: properties: original: type: array items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. modified: type: array items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. changes: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. required: - modified - original CollectionFieldChangeSet_EnvironmentHistoricalIdentifier.EnvironmentHistoricalIdentifier_: properties: original: type: array items: $ref: "#/components/schemas/EnvironmentHistoricalIdentifier" modified: type: array items: $ref: "#/components/schemas/EnvironmentHistoricalIdentifier" changes: type: - array - "null" items: $ref: "#/components/schemas/EnvironmentHistoricalIdentifier" required: - modified - original CollectionFieldChangeSet_SubtaskSnapshot.SubtaskChangeSet_: properties: original: type: array items: $ref: "#/components/schemas/SubtaskSnapshot" description: A shortened self-contained version of the Subtask to store a snapshot of the subtask at a point in time. The main purpose is to isolate the API DTO object from ever using DB access objects directly. modified: type: array items: $ref: "#/components/schemas/SubtaskSnapshot" description: A shortened self-contained version of the Subtask to store a snapshot of the subtask at a point in time. The main purpose is to isolate the API DTO object from ever using DB access objects directly. changes: type: - array - "null" items: $ref: "#/components/schemas/SubtaskChangeSet" required: - modified - original CollectionFieldDiffChangeSet_HistoricalIdentifier_: properties: added: type: array items: $ref: "#/components/schemas/HistoricalIdentifier" removed: type: array items: $ref: "#/components/schemas/HistoricalIdentifier" required: - added - removed CollectionFieldDiffChangeSet_UUID_: properties: added: type: array items: type: string format: uuid removed: type: array items: type: string format: uuid required: - added - removed Comment.Status: enum: - ACTIVE - DELETED - ADDRESSED - REJECTED CommentChangeSet: properties: id: type: string format: uuid content: $ref: "#/components/schemas/TextFieldChangeSet" status: $ref: "#/components/schemas/SimpleFieldChangeSet_Comment.Status_" originalAuthor: type: string format: uuid originalCreatedAt: type: string format: date-time required: - content - id - originalAuthor - originalCreatedAt - status CommentController.CommentsFilter: properties: backlogItemId: type: string format: uuid required: - backlogItemId CommentController.InclusionType: enum: - UPDATED_BY CommentCreationResource: properties: type: type: string pattern: comment attributes: $ref: "#/components/schemas/CommentCreationResource.CommentAttributes" relationships: $ref: "#/components/schemas/CommentCreationResource.CommentRelationships" required: - attributes - relationships - type CommentCreationResource.CommentAttributes: properties: content: type: string maxLength: 2000 minLength: 1 startIndex: type: integer format: int64 minimum: 0 endIndex: type: integer format: int64 minimum: 0 required: - content - endIndex - startIndex CommentCreationResource.CommentRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion - backlogItem CommentResource: properties: type: type: string pattern: comment id: type: string format: uuid attributes: $ref: "#/components/schemas/CommentResource.CommentAttributes" relationships: $ref: "#/components/schemas/CommentResource.CommentRelationships" meta: $ref: "#/components/schemas/CommentResource.CommentMetadata" required: - attributes - id - meta - relationships - type CommentResource.CommentAttributes: properties: status: $ref: "#/components/schemas/Comment.Status" content: type: string startIndex: type: integer format: int64 endIndex: type: integer format: int64 createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - content - createdAt - endIndex - startIndex - status - updatedAt CommentResource.CommentMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions CommentResource.CommentRelationships: properties: author: $ref: "#/components/schemas/SingleRelationship" backlogItem: $ref: "#/components/schemas/SingleRelationship" acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" updatedBy: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion - author - backlogItem - updatedBy CommentUpdateResource: properties: type: type: string pattern: comment id: type: string format: uuid attributes: $ref: "#/components/schemas/CommentUpdateResource.CommentAttributes" relationships: $ref: "#/components/schemas/CommentUpdateResource.CommentRelationships" required: - attributes - id - relationships - type CommentUpdateResource.CommentAttributes: properties: status: type: - "null" - object allOf: - $ref: "#/components/schemas/Comment.Status" content: type: - string - "null" maxLength: 2000 startIndex: type: - integer - "null" format: int64 minimum: 0 endIndex: type: - integer - "null" format: int64 minimum: 0 required: - content - endIndex - startIndex - status CommentUpdateResource.CommentRelationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" acceptanceCriterion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - acceptanceCriterion - backlogItem ContentChunk: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/BacklogItemContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: A persona for a user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_1: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_11: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_13: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_15: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_17: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_19: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_25: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_27: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_29: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_3: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_31: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_33: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_37: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_39: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/GenericContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContentChunk_9: description: A segment of content in the description of a story or a bug. properties: type: allOf: - $ref: "#/components/schemas/StoryContentChunk.ContentChunkType" description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. value: type: string description: The content in this chunk. minLength: 1 required: - type - value ContextChangeSet: properties: rationale: $ref: "#/components/schemas/BacklogItemChangeRationale" step: $ref: "#/components/schemas/SimpleFieldChangeSet_WorkflowStepSnapshot_" team: $ref: "#/components/schemas/SimpleFieldChangeSet_HistoricalIdentifier_" required: - rationale - step - team ConversationCreationResource: properties: type: type: string pattern: conversation attributes: $ref: "#/components/schemas/ConversationCreationResource.Attributes" required: - attributes - type ConversationCreationResource.Attributes: properties: userMessage: type: string maxLength: 200 minLength: 1 maxResults: type: - integer - "null" format: int32 maximum: 20 minimum: 1 devString: type: string required: - devString - maxResults - userMessage ConversationResource: description: "The returned resource, based on the request." properties: type: type: string pattern: conversation id: type: string format: uuid attributes: $ref: "#/components/schemas/ConversationResource.Attributes" relationships: $ref: "#/components/schemas/ConversationResource.Relationships" required: - attributes - id - relationships - type ConversationResource.Attributes: properties: userMessage: type: string botMessage: type: string required: - botMessage - userMessage ConversationResource.Relationships: properties: backlogItems: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems CreateUsersJobResource: properties: type: type: string pattern: create_users_job attributes: $ref: "#/components/schemas/CreateUsersJobResource.Attributes" required: - attributes - type CreateUsersJobResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" users: type: array items: $ref: "#/components/schemas/UserCreationResource" required: - state - users CreateUsersJobResponse: description: "The returned resource, based on the request." properties: type: type: string pattern: create_users_job id: type: string attributes: $ref: "#/components/schemas/CreateUsersJobResponse.Attributes" relationships: $ref: "#/components/schemas/CreateUsersJobResponse.Relationships" meta: $ref: "#/components/schemas/CreateUsersJobResponse.Metadata" required: - attributes - id - meta - relationships - type CreateUsersJobResponse.Attributes: properties: state: $ref: "#/components/schemas/JobResponseState" required: - state CreateUsersJobResponse.Metadata: properties: outcome: additionalProperties: type: array items: type: string required: - outcome CreateUsersJobResponse.Relationships: properties: usersInvited: $ref: "#/components/schemas/MultipleRelationships" required: - usersInvited CursorPageFilter: properties: cursor: type: - string - "null" size: type: - integer - "null" format: int32 CycleTimeReport: properties: dayBins: type: array items: $ref: "#/components/schemas/CycleTimeReport.RecordBin" averageFromDate: type: string format: date-time reportTimezone: type: string required: - averageFromDate - dayBins - reportTimezone CycleTimeReport.Filter: properties: team: type: string format: uuid itemType: $ref: "#/components/schemas/BacklogItem.ItemType" required: - itemType - team CycleTimeReport.RecordBin: properties: doneBin: type: string format: date-time sizeName: type: - string - "null" itemsCount: type: - integer - "null" format: int32 sumCycleTime: type: - number - "null" format: double avgCycleTime: type: - number - "null" format: double required: - doneBin CycleTimeReportController.Interval: properties: fromDate: type: - string - "null" format: date-time toDate: type: - string - "null" format: date-time CycleTimeReportController.Resolution: enum: - DAY - WEEK - MONTH CycleTimeStepReport: properties: dayBins: type: array items: $ref: "#/components/schemas/CycleTimeStepReport.RecordBin" averageFromDate: type: string format: date-time reportTimezone: type: string required: - averageFromDate - dayBins - reportTimezone CycleTimeStepReport.Filter: properties: team: type: string format: uuid required: - team CycleTimeStepReport.RecordBin: properties: doneBin: type: string format: date-time itemType: $ref: "#/components/schemas/BacklogItem.ItemType" sizeName: type: - string - "null" stepName: type: - string - "null" stepColor: type: - string - "null" itemsCount: type: - integer - "null" format: int32 sumSliceHours: type: - number - "null" format: double avgSliceHours: type: - number - "null" format: double required: - doneBin - itemType DashboardWidgetController.InclusionType: enum: - TEAMS - AUTO_WIDGETS DashboardWidgetCreationResource: properties: type: type: string pattern: dashboard_widget attributes: $ref: "#/components/schemas/DashboardWidgetCreationResource.DashboardWidgetAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/DashboardWidgetResource.DashboardWidgetRelationships" required: - attributes - relationships - type DashboardWidgetCreationResource.DashboardWidgetAttributes: properties: widgetType: type: string maxLength: 100 minLength: 1 row: type: - integer - "null" format: int32 column: type: - integer - "null" format: int32 width: type: - integer - "null" format: int32 height: type: - integer - "null" format: int32 required: - widgetType DashboardWidgetResource: description: "The returned resource, based on the request." properties: type: type: string pattern: dashboard_widget id: type: string format: uuid attributes: $ref: "#/components/schemas/DashboardWidgetResource.DashboardWidgetAttributes" relationships: $ref: "#/components/schemas/DashboardWidgetResource.DashboardWidgetRelationships" required: - attributes - id - relationships - type DashboardWidgetResource.DashboardWidgetAttributes: properties: widgetType: type: string maxLength: 100 minLength: 1 createdAt: type: string format: date-time updatedAt: type: string format: date-time row: type: - integer - "null" format: int32 column: type: - integer - "null" format: int32 width: type: - integer - "null" format: int32 height: type: - integer - "null" format: int32 required: - createdAt - updatedAt - widgetType DashboardWidgetResource.DashboardWidgetRelationships: properties: team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" savedView: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - savedView - team DateRange: properties: mode: type: - "null" - object allOf: - $ref: "#/components/schemas/DateRange.Mode" from: type: - string - "null" format: date-time to: type: - string - "null" format: date-time days: type: - integer - "null" format: int32 period: type: - "null" - object allOf: - $ref: "#/components/schemas/DateRange.RelativePeriod" timezone: type: - string - "null" DateRange.Mode: enum: - DATE_RANGE - RELATIVE_DAYS_MORE - RELATIVE_DAYS_LESS - RELATIVE_MONTHS_MORE - RELATIVE_MONTHS_LESS - RELATIVE_PERIOD x-type: String DateRange.RelativePeriod: enum: - TODAY - YESTERDAY - THIS_WEEK - LAST_WEEK - THIS_MONTH - LAST_MONTH - THIS_QUARTER - LAST_QUARTER - THIS_YEAR - LAST_YEAR x-type: String DeleteUserJobResource: properties: type: type: string pattern: delete_user_job attributes: $ref: "#/components/schemas/DeleteUserJobResource.Attributes" required: - attributes - type DeleteUserJobResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" user: $ref: "#/components/schemas/ResourceIdentifier" required: - state - user DeleteUserJobResponse: description: "The returned resource, based on the request." properties: type: type: string pattern: delete_user_job id: type: string attributes: $ref: "#/components/schemas/DeleteUserJobResponse.Attributes" meta: $ref: "#/components/schemas/DeleteUserJobResponse.Metadata" required: - attributes - id - meta - type DeleteUserJobResponse.Attributes: properties: state: $ref: "#/components/schemas/JobResponseState" required: - state DeleteUserJobResponse.Metadata: properties: outcome: additionalProperties: type: array items: type: string required: - outcome DocumentationSite: properties: name: type: string minLength: 1 url: type: string minLength: 1 required: - name - url EnvironmentController.InclusionType: enum: - API_KEY EnvironmentCreateResource: properties: type: type: string pattern: environment attributes: $ref: "#/components/schemas/EnvironmentCreateResource.Attributes" required: - attributes - type EnvironmentCreateResource.Attributes: properties: code: type: string maxLength: 25 minLength: 1 pattern: "^[a-z0-9-_]+$" description: type: - string - "null" isRestricted: type: - boolean - "null" position: type: - integer - "null" format: int32 minimum: 0 slackNotificationEnabled: type: - boolean - "null" required: - code - description - isRestricted - position - slackNotificationEnabled EnvironmentHistoricalIdentifier: properties: id: type: string format: uuid code: type: string required: - code - id EnvironmentResource: properties: type: type: string pattern: environment id: type: string attributes: $ref: "#/components/schemas/EnvironmentResource.Attributes" relationships: $ref: "#/components/schemas/EnvironmentResource.Relationships" required: - attributes - id - relationships - type EnvironmentResource.Attributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time code: type: string maxLength: 25 minLength: 1 pattern: "^[a-z0-9-_]+$" description: type: string isRestricted: type: boolean position: type: integer format: int32 slackNotificationEnabled: type: boolean required: - code - createdAt - description - isRestricted - position - slackNotificationEnabled - updatedAt EnvironmentResource.Relationships: properties: apiKey: $ref: "#/components/schemas/SingleRelationship" required: - apiKey EnvironmentUpdateResource: properties: type: type: string pattern: environment id: type: string attributes: $ref: "#/components/schemas/EnvironmentUpdateResource.Attributes" required: - attributes - id - type EnvironmentUpdateResource.Attributes: properties: code: type: - string - "null" maxLength: 25 minLength: 1 pattern: "^[a-z0-9-_]+$" description: type: - string - "null" isRestricted: type: - boolean - "null" position: type: - integer - "null" format: int32 minimum: 0 slackNotificationEnabled: type: - boolean - "null" required: - code - description - isRestricted - position - slackNotificationEnabled EpicController.InclusionType: enum: - CREATOR - EPIC_STORIES EpicCreateResource: description: An epic is a large body of work that can be broken down into smaller stories and bugs. properties: type: type: string default: epic description: Identifies the type of resource. pattern: epic defaultValue: epic requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/EpicCreateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - type writeOnly: true EpicCreateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the epic. maxLength: 200 minLength: 1 requiredMode: REQUIRED content: type: - array - "null" description: "A description of the epic, providing additional context and\ \ details." items: $ref: "#/components/schemas/ContentChunk_9" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." items: $ref: "#/components/schemas/ContentChunk_11" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED required: - title EpicResource: description: An epic is a large body of work that can be broken down into smaller stories and bugs. properties: type: type: string default: epic description: Identifies the type of resource. pattern: epic defaultValue: epic id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/EpicResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/EpicResource.Relationships" description: Contains references to other related resources. readOnly: true EpicResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the epic. handle: type: string description: "A unique identifier for the epic, shown in the Atono application\ \ as the item ID (e.g., `EPIC-123`)." position: type: integer format: int32 description: "Indicates the epic's position within its current workflow\ \ step, where `0` is the topmost item. Position is relative to the step\ \ and team backlog." content: type: - array - "null" description: "A description of the epic, providing additional context and\ \ details." items: $ref: "#/components/schemas/ContentChunk_1" description: A segment of content in the description of a story or a bug. readOnly: true additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." example: "An epic to build a new user authentication system that includes\ \ login, logout, and password reset functionality." items: $ref: "#/components/schemas/ContentChunk_3" description: A segment of content in the description of a story or a bug. readOnly: true exampleSetFlag: true createdAt: type: string format: date-time description: The date and time the epic was created. updatedAt: type: string format: date-time description: The date and time the epic was last updated. deleted: type: boolean description: Indicates whether the epic has been deleted. EpicResource.Relationships: description: Contains references to other related resources. properties: creator: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user who created the\ \ epic. Includes a reference to the user, along with related links and\ \ metadata." attachments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the epic's attachments. The\ \ object includes resource identifiers, related links, and metadata." epicStories: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the stories associated with\ \ the epic. The object includes resource identifiers, related links, and\ \ metadata." EpicUpdateResource: description: An epic is a large body of work that can be broken down into smaller stories and bugs. properties: type: type: string default: epic description: Identifies the type of resource. pattern: epic defaultValue: epic requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/EpicUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/EpicUpdateResource.Relationships" description: Contains references to other related resources. required: - id - type writeOnly: true EpicUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: - string - "null" description: The title of the epic. maxLength: 200 requiredMode: NOT_REQUIRED content: type: - array - "null" description: "A description of the epic, providing additional context and\ \ details." items: $ref: "#/components/schemas/ContentChunk_13" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." items: $ref: "#/components/schemas/ContentChunk_15" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED EpicUpdateResource.Relationships: description: Contains references to other related resources. properties: epicStories: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" default: data: - type: story id: 00000000-0000-0000-0000-000000000000 description: "A relationship object linking to the stories associated with\ \ the epic. The object includes resource identifiers, related links, and\ \ metadata." FeatureFlag.ValueType: enum: - BOOLEAN FeatureFlagChangeSetResource: properties: type: type: string pattern: flags_change_set id: type: string format: uuid attributes: $ref: "#/components/schemas/FeatureFlagChangeSetResource.FeatureFlagChangeSetAttributes" relationships: $ref: "#/components/schemas/FeatureFlagChangeSetResource.FeatureFlagChangeSetRelationships" required: - attributes - id - relationships - type FeatureFlagChangeSetResource.FeatureFlagChangeSetAttributes: properties: operation: type: string createdAt: type: string format: date-time snapshot: $ref: "#/components/schemas/FeatureFlagSnapshot" key: $ref: "#/components/schemas/SimpleFieldChangeSet_String_" summary: $ref: "#/components/schemas/TextFieldChangeSet" isActive: $ref: "#/components/schemas/SimpleFieldChangeSet_Boolean_" defaultVariant: $ref: "#/components/schemas/SimpleFieldChangeSet_String_" variants: $ref: "#/components/schemas/SimpleFieldChangeSet_Map_String.Object__" ruleset: $ref: "#/components/schemas/FlagRulesetChangeSet" backlogItems: $ref: "#/components/schemas/CollectionFieldDiffChangeSet_UUID_" required: - backlogItems - createdAt - defaultVariant - isActive - key - operation - ruleset - snapshot - summary - variants FeatureFlagChangeSetResource.FeatureFlagChangeSetRelationships: properties: featureFlag: $ref: "#/components/schemas/SingleRelationship" actor: $ref: "#/components/schemas/SingleRelationship" items: $ref: "#/components/schemas/MultipleRelationships" addedItems: $ref: "#/components/schemas/MultipleRelationships" removedItems: $ref: "#/components/schemas/MultipleRelationships" required: - actor - addedItems - featureFlag - items - removedItems FeatureFlagController.EvaluationStateGroup: enum: - ALL - ACTIVE FeatureFlagController.FlagListFilter: properties: steps: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagController.StepGroup" evaluationState: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagController.EvaluationStateGroup" FeatureFlagController.InclusionType: enum: - BACKLOG_ITEMS - BACKLOG_ITEM_TEAMS - ENVIRONMENTS - RULES - OWNERS - FLIPPERS FeatureFlagController.MetricType: enum: - LATEST_EVALUATIONS FeatureFlagController.SingleFlagFilter: properties: steps: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagController.StepGroup" FeatureFlagController.StepGroup: enum: - ALL - ACCEPTED - REJECTED FeatureFlagCreateResource: properties: type: type: string pattern: feature_flag attributes: $ref: "#/components/schemas/FeatureFlagCreateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagCreateResource.Relationships" required: - attributes - relationships - type FeatureFlagCreateResource.Attributes: properties: key: type: string maxLength: 60 minLength: 4 pattern: "^[a-z_][a-z0-9_]+$" summary: type: string maxLength: 500 isActive: type: boolean valueType: $ref: "#/components/schemas/FeatureFlag.ValueType" variants: additionalProperties: true defaultVariant: type: string minLength: 1 required: - defaultVariant - isActive - key - summary - valueType - variants FeatureFlagCreateResource.Relationships: properties: backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - backlogItems FeatureFlagHistoricalIdentifier: properties: id: type: string format: uuid key: type: string required: - id - key FeatureFlagHistoryFilter: properties: changed: type: - string - "null" containsText: type: - string - "null" FeatureFlagResource: properties: type: type: string pattern: feature_flag id: type: string attributes: $ref: "#/components/schemas/FeatureFlagResource.Attributes" relationships: $ref: "#/components/schemas/FeatureFlagResource.Relationships" meta: $ref: "#/components/schemas/FeatureFlagResource.Metadata" required: - attributes - id - meta - relationships - type FeatureFlagResource.Attributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time key: type: string maxLength: 60 minLength: 4 pattern: "^[a-z_][a-z0-9_]+$" summary: type: string isActive: type: boolean valueType: $ref: "#/components/schemas/FeatureFlag.ValueType" variants: additionalProperties: true defaultVariant: type: string minLength: 1 required: - createdAt - defaultVariant - isActive - key - summary - updatedAt - valueType - variants FeatureFlagResource.EvaluationMetrics: properties: acrossEnvironments: $ref: "#/components/schemas/FeatureFlagResource.LatestEvaluations" perEnvironment: additionalProperties: $ref: "#/components/schemas/FeatureFlagResource.LatestEvaluations" required: - acrossEnvironments - perEnvironment FeatureFlagResource.EvaluationState: enum: - NEVER_EVALUATED - SINGLE_VARIANT - MIXED_VARIANTS - NO_LONGER_EVALUATED FeatureFlagResource.LatestEvaluations: properties: state: $ref: "#/components/schemas/FeatureFlagResource.EvaluationState" perVariant: additionalProperties: type: string format: date-time required: - perVariant - state FeatureFlagResource.Metadata: properties: state: $ref: "#/components/schemas/State" evaluationMetrics: $ref: "#/components/schemas/FeatureFlagResource.EvaluationMetrics" lastUpdate: type: string format: date-time allowedActions: type: array items: type: string required: - allowedActions - evaluationMetrics - lastUpdate - state FeatureFlagResource.Relationships: properties: backlogItems: $ref: "#/components/schemas/MultipleRelationships" rules: $ref: "#/components/schemas/MultipleRelationships" flippers: $ref: "#/components/schemas/MultipleRelationships" owners: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - flippers - owners - rules FeatureFlagSnapshot: description: A shortened self-contained version of the FeatureFlag for the purpose of storing a snapshot of the item at a point in time. It does not store the fields that never change or references to other objects. properties: code: type: string summary: type: string isActive: type: boolean defaultVariant: type: string variants: additionalProperties: true backlogItemIds: type: array items: type: string format: uuid required: - backlogItemIds - code - defaultVariant - isActive - summary - variants FeatureFlagUpdateResource: properties: type: type: string pattern: feature_flag id: type: string attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/FeatureFlagUpdateResource.Relationships" required: - attributes - id - relationships - type FeatureFlagUpdateResource.Attributes: properties: key: type: - string - "null" maxLength: 60 minLength: 4 pattern: "^[a-z_][a-z0-9_]+$" summary: type: - string - "null" maxLength: 500 isActive: type: - boolean - "null" variants: type: - "null" - object additionalProperties: true defaultVariant: type: - string - "null" required: - defaultVariant - isActive - key - summary - variants FeatureFlagUpdateResource.Relationships: properties: flippers: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" owners: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - flippers - owners FileUrl: description: "The returned resource, based on the request." properties: path: type: string required: - path FlagEnvironmentResource: description: The configuration for a flag in a specific environment. properties: type: type: string default: flag_environment description: Identifies the type of resource. pattern: flag_environment defaultValue: flag_environment id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/FlagEnvironmentResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/FlagEnvironmentResource.Relationships" description: Contains references to other related resources. meta: allOf: - $ref: "#/components/schemas/FlagEnvironmentResource.Metadata" description: "Extra information about the resource, including calculated\ \ values or non-standard fields." readOnly: true FlagEnvironmentResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: configuration: type: string description: "Indicates how the flag is currently configured in the environment.\ \ `on`: The flag always evaluates to ON. `off`: The flag always evaluates\ \ to OFF. `MIXED`: The environment uses slices that evaluate to different\ \ values (ON or OFF) based on customer or location." example: "on" exampleSetFlag: true FlagEnvironmentResource.Metadata: description: "Extra information about the resource, including calculated values\ \ or non-standard fields." properties: environmentCode: type: string description: "The name of the environment this configuration applies to.\ \ This matches the environment name shown in the UI (e.g., `dev`)." FlagEnvironmentResource.Relationships: description: Contains references to other related resources. properties: flag: allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the feature flag associated\ \ with this environment configuration. Includes a reference to the flag,\ \ along with related links and metadata." FlagEnvironmentUpdateResource: description: The configuration for a flag in a specific environment. properties: type: type: string default: flag_environment description: Identifies the type of resource. pattern: flag_environment defaultValue: flag_environment requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/FlagEnvironmentUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - id - type writeOnly: true FlagEnvironmentUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: configuration: type: string description: The feature flag configuration for the environment (`on` or `off`). Setting this will remove all slices for the environment and set the flag to return the specified variant. example: "on" exampleSetFlag: true requiredMode: REQUIRED required: - configuration FlagResource: description: "A feature flag controls the behavior of a feature in Atono. It\ \ includes a unique name (key), a list of possible variants, a summary of\ \ what the flag controls, and environment-specific configuration (slices)\ \ that determines how the flag evaluates across environments." properties: type: type: string default: flag description: Identifies the type of resource. pattern: flag defaultValue: flag id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/FlagResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/FlagResource.Relationships" description: Contains references to other related resources. readOnly: true FlagResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: key: type: string description: The flag name used to identify this feature flag in your codebase or SDK configuration. This name is unique within your workspace. summary: type: string description: A human-readable summary describing what this flag controls. Useful for understanding the intent or behavior behind the flag. variants: additionalProperties: true description: "A list of named variants the flag can evaluate to. Each variant\ \ maps to a value used in your application. For boolean flags, variants\ \ include `\"on\": true` and `\"off\": false`." createdAt: type: string format: date-time description: The date and time the feature flag was created. updatedAt: type: string format: date-time description: The date and time the feature flag was last updated. FlagResource.Relationships: description: Contains references to other related resources. properties: slices: allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the environment-specific\ \ configurations for the flag. Includes a reference to each environment\ \ (slice), along with related links and metadata. Each slice defines the\ \ variant the flag will evaluate to in that environment." FlagRuleUpdateResource: properties: type: type: string pattern: flag_ruleset id: type: string attributes: $ref: "#/components/schemas/FlagRuleUpdateResource.Attributes" required: - attributes - id - type FlagRuleUpdateResource.Attributes: properties: slices: type: - array - "null" items: $ref: "#/components/schemas/FlagRulesetResource.Slice" defaultVariant: type: - string - "null" required: - defaultVariant - slices FlagRulesetChangeSet: description: A representation of a feature flag ruleset change. properties: featureFlagId: $ref: "#/components/schemas/FeatureFlagHistoricalIdentifier" original: $ref: "#/components/schemas/FlagRulesetSnapshot" modified: $ref: "#/components/schemas/FlagRulesetSnapshot" stateChange: $ref: "#/components/schemas/SimpleFieldChangeSet_String_" environmentCode: $ref: "#/components/schemas/EnvironmentHistoricalIdentifier" required: - environmentCode - featureFlagId - modified - original - stateChange FlagRulesetResource: properties: type: type: string pattern: flag_ruleset id: type: string attributes: $ref: "#/components/schemas/FlagRulesetResource.Attributes" relationships: $ref: "#/components/schemas/FlagRulesetResource.Relationships" required: - attributes - id - relationships - type FlagRulesetResource.Attributes: properties: slices: type: array items: $ref: "#/components/schemas/FlagRulesetResource.Slice" defaultVariant: type: string minLength: 1 required: - defaultVariant - slices FlagRulesetResource.Relationships: properties: flag: $ref: "#/components/schemas/SingleRelationship" environment: $ref: "#/components/schemas/SingleRelationship" required: - environment - flag FlagRulesetResource.Slice: properties: targeting: additionalProperties: type: array items: {} maxItems: 1 variant: type: string required: - targeting - variant FlagRulesetSnapshot: description: A historical representation of a feature flag ruleset per environment. properties: id: type: string format: uuid defaultVariant: type: string slices: type: array items: $ref: "#/components/schemas/FlagRulesetSnapshot.Slice" required: - defaultVariant - id - slices FlagRulesetSnapshot.Slice: properties: targeting: additionalProperties: type: array items: {} maxItems: 1 variant: type: string required: - targeting - variant FollowedItemController.DeleteFilter: properties: filter[backlogItemId]: type: - string - "null" format: uuid description: ID of the backlog item to unfollow. name: "filter[backlogItemId]" requiredMode: REQUIRED required: - "filter[backlogItemId]" FollowedItemCreationResource: properties: type: type: string pattern: followed_item relationships: $ref: "#/components/schemas/FollowedItemCreationResource.Relationships" required: - relationships - type FollowedItemCreationResource.Relationships: properties: target: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - target FollowedItemResource: description: "The returned resource, based on the request." properties: type: type: string pattern: followed_item id: type: string relationships: $ref: "#/components/schemas/FollowedItemResource.FollowedItemRelationships" required: - id - relationships - type FollowedItemResource.FollowedItemRelationships: properties: follower: $ref: "#/components/schemas/SingleRelationship" target: $ref: "#/components/schemas/SingleRelationship" required: - follower - target GenericContentChunk.ContentChunkType: description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. enum: - DISPLAY_HTML - TEXT Glossary.BuildMode: enum: - CRAWL - TSV_UPLOAD GlossaryCreationResource: properties: type: type: string pattern: glossary attributes: $ref: "#/components/schemas/GlossaryCreationResource.Attributes" required: - attributes - type GlossaryCreationResource.Attributes: properties: name: type: - string - "null" maxLength: 200 buildMode: type: - "null" - object allOf: - $ref: "#/components/schemas/Glossary.BuildMode" documentationSites: type: - array - "null" items: $ref: "#/components/schemas/DocumentationSite" prompt: type: - string - "null" tsvFilePath: type: - string - "null" owners: type: - array - "null" items: type: string format: uuid contributors: type: - array - "null" items: type: string format: uuid required: - buildMode - contributors - documentationSites - name - owners - prompt - tsvFilePath GlossaryEntry.Status: enum: - ACTIVE - INACTIVE GlossaryEntryCreationResource: properties: type: type: string pattern: glossary-entry attributes: $ref: "#/components/schemas/GlossaryEntryCreationResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/GlossaryEntryCreationResource.Relationships" required: - attributes - relationships - type GlossaryEntryCreationResource.Attributes: properties: term: type: string maxLength: 100 minLength: 1 definition: type: string maxLength: 1000 minLength: 1 synonyms: type: - array - "null" items: type: string relatedTerms: type: - array - "null" items: $ref: "#/components/schemas/ResourceIdentifier" required: - definition - relatedTerms - synonyms - term GlossaryEntryCreationResource.Relationships: properties: relatedTerms: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - relatedTerms GlossaryEntryDiffResource: description: "The returned resource, based on the request." properties: type: type: string pattern: glossary-entry-diff attributes: $ref: "#/components/schemas/GlossaryEntryDiffResource.Attributes" meta: type: - "null" - object allOf: - $ref: "#/components/schemas/GlossaryEntryDiffResource.Metadata" required: - attributes - meta - type GlossaryEntryDiffResource.Attributes: properties: operations: type: array items: $ref: "#/components/schemas/GlossaryEntryPatch" minItems: 1 required: - operations GlossaryEntryDiffResource.Metadata: properties: jobId: type: - string - "null" required: - jobId GlossaryEntryPatch: properties: entryId: type: - string - "null" format: uuid operation: $ref: "#/components/schemas/GlossaryEntryPatch.Operation" term: type: string definition: type: - string - "null" synonyms: type: - array - "null" items: type: string relatedTerms: type: - array - "null" items: type: string required: - operation - term GlossaryEntryPatch.Operation: enum: - CREATE - UPDATE - DELETE GlossaryEntryResource: properties: type: type: string pattern: glossary-entry id: type: string format: uuid attributes: $ref: "#/components/schemas/GlossaryEntryResource.Attributes" meta: $ref: "#/components/schemas/GlossaryEntryResource.Metadata" relationships: $ref: "#/components/schemas/GlossaryEntryResource.Relationships" required: - attributes - id - meta - relationships - type GlossaryEntryResource.Attributes: properties: term: type: string definition: type: string status: type: string synonyms: type: - array - "null" items: type: string meta: $ref: "#/components/schemas/GlossaryEntryResource.Metadata" required: - definition - meta - status - synonyms - term GlossaryEntryResource.Metadata: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time updatedBy: type: - string - "null" required: - createdAt - updatedAt - updatedBy GlossaryEntryResource.Relationships: properties: updatedBy: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" relatedTerms: $ref: "#/components/schemas/MultipleRelationships" required: - relatedTerms - updatedBy GlossaryEntryUpdateResource: properties: type: type: string pattern: glossary-entry id: type: string format: uuid attributes: $ref: "#/components/schemas/GlossaryEntryUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/GlossaryEntryUpdateResource.Relationships" required: - attributes - id - relationships - type GlossaryEntryUpdateResource.Attributes: properties: term: type: - string - "null" maxLength: 100 definition: type: - string - "null" maxLength: 1000 status: type: - "null" - object allOf: - $ref: "#/components/schemas/GlossaryEntry.Status" synonyms: type: - array - "null" items: type: string relatedTerms: type: - array - "null" items: $ref: "#/components/schemas/ResourceIdentifier" required: - definition - relatedTerms - status - synonyms - term GlossaryEntryUpdateResource.Relationships: properties: relatedTerms: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" restoreVersion: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" required: - relatedTerms - restoreVersion GlossaryEntryValidationCode: enum: - DEFINITION_EMPTY - DEFINITION_TRUNCATED - INVALID_RELATED_TERM - ROW_EMPTY - SYNONYMS_TRUNCATED - TERM_EMPTY - TERM_TRUNCATED - TERM_DUPLICATE - UNEXPECTED_ERROR GlossaryResource: description: "The returned resource, based on the request." properties: type: type: string pattern: glossary id: type: string format: uuid attributes: $ref: "#/components/schemas/GlossaryResource.Attributes" meta: $ref: "#/components/schemas/GlossaryResource.Metadata" relationships: $ref: "#/components/schemas/GlossaryResource.Relationships" required: - attributes - id - meta - relationships - type GlossaryResource.Attributes: properties: name: type: string buildMode: $ref: "#/components/schemas/Glossary.BuildMode" tsvFilePath: type: string meta: $ref: "#/components/schemas/GlossaryResource.Metadata" required: - buildMode - meta - name - tsvFilePath GlossaryResource.Metadata: properties: allowedActions: type: array items: type: string importErrors: type: array items: $ref: "#/components/schemas/TsvImportFileError" importRowStatuses: type: array items: $ref: "#/components/schemas/TsvImportRowStatus" createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - allowedActions - createdAt - importErrors - importRowStatuses - updatedAt GlossaryResource.Relationships: properties: owners: $ref: "#/components/schemas/MultipleRelationships" contributors: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" entries: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - contributors - entries - owners GlossaryUpdateResource: properties: type: type: string pattern: glossary id: type: string attributes: $ref: "#/components/schemas/GlossaryUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/GlossaryUpdateResource.Relationships" required: - attributes - id - relationships - type GlossaryUpdateResource.Attributes: properties: name: type: - string - "null" maxLength: 200 required: - name GlossaryUpdateResource.Relationships: properties: owners: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" contributors: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - contributors - owners HierarchyLevel: enum: - CONTINENT - SUBCONTINENT - COUNTRY - REGION HistoricalIdentifier: properties: id: type: string format: uuid label: type: string required: - id - label Impact: properties: id: type: integer format: int32 name: type: string value: type: integer format: int32 required: - id - name - value ImpactResource: properties: type: type: string pattern: impact id: type: string attributes: $ref: "#/components/schemas/ImpactResource.ImpactAttributes" required: - attributes - id - type ImpactResource.ImpactAttributes: properties: name: type: string minLength: 1 value: type: integer format: int32 required: - name - value ImportInfo: properties: importObjects: type: array items: $ref: "#/components/schemas/ImportInfo.ImportObject" sideEffects: type: array items: $ref: "#/components/schemas/ImportInfo.SideEffect" errors: type: array items: $ref: "#/components/schemas/PreflightResult.Entry" required: - errors - importObjects - sideEffects ImportInfo.ImportObject: properties: type: type: string meta: additionalProperties: true required: - meta - type ImportInfo.SideEffect: properties: code: type: string title: type: string detail: type: string source: additionalProperties: true required: - code - detail - source - title ImportJob.HostConfig: properties: host: type: string minLength: 1 user: type: string format: email minLength: 1 apiToken: type: string minLength: 1 required: - apiToken - host - user ImportJob.ImportSource: enum: - LINEAR - JIRA - JIRA_SYNC - SAMPLE_DATA - ATONO_IMPORT ImportJobController.RequestFilter: properties: source: type: - "null" - object allOf: - $ref: "#/components/schemas/ImportJob.ImportSource" ImportJobCreationResource: properties: type: type: string pattern: import_job attributes: $ref: "#/components/schemas/ImportJobCreationResource.Attributes" required: - attributes - type ImportJobCreationResource.Attributes: properties: source: $ref: "#/components/schemas/ImportJob.ImportSource" path: type: string hostConfig: type: - "null" - object allOf: - $ref: "#/components/schemas/ImportJob.HostConfig" importOptions: type: - "null" - object allOf: - $ref: "#/components/schemas/ImportOptions" required: - hostConfig - importOptions - path - source ImportJobResource: description: "The returned resource, based on the request." properties: type: type: string pattern: import_job id: type: string format: uuid attributes: $ref: "#/components/schemas/ImportJobResource.Attributes" relationships: $ref: "#/components/schemas/ImportJobResource.Relationships" meta: $ref: "#/components/schemas/ImportJobResource.Metadata" required: - attributes - id - meta - relationships - type ImportJobResource.Attributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time path: type: string minLength: 1 size: type: integer format: int64 contentType: type: string state: $ref: "#/components/schemas/JobResponseState" importOptions: $ref: "#/components/schemas/ImportOptions" source: $ref: "#/components/schemas/ImportJob.ImportSource" hostConfig: $ref: "#/components/schemas/ImportJob.HostConfig" required: - contentType - createdAt - hostConfig - importOptions - path - size - source - state - updatedAt ImportJobResource.Metadata: properties: preflightResult: $ref: "#/components/schemas/ImportInfo" jobResult: $ref: "#/components/schemas/ImportInfo" required: - jobResult - preflightResult ImportJobResource.Relationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" required: - creator ImportJobUpdateResource: properties: type: type: string pattern: import_job id: type: string format: uuid attributes: $ref: "#/components/schemas/ImportJobUpdateResource.Attributes" required: - attributes - id - type ImportJobUpdateResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" importOptions: $ref: "#/components/schemas/ImportOptions" required: - importOptions - state ImportOptions: properties: userOption: $ref: "#/components/schemas/ImportOptions.NewUserOption" itemTypeOption: $ref: "#/components/schemas/ImportOptions.UnknownItemTypeOption" duplicateItemOption: $ref: "#/components/schemas/ImportOptions.DuplicateItemOption" projectKeys: type: array items: type: string projectMappings: type: - array - "null" items: $ref: "#/components/schemas/ImportOptions.ProjectMapping" description: "Mapping of Jira project ID to Atono team ID. When teamId\ \ is provided, items from the project are assigned directly to that\ \ team. When teamId is null, team is created/matched by project name." teamMemberOption: $ref: "#/components/schemas/ImportOptions.TeamMemberOption" templateName: type: string markAsSampleData: type: boolean referenceDate: type: - string - "null" format: date-time required: - duplicateItemOption - itemTypeOption - markAsSampleData - projectKeys - teamMemberOption - templateName - userOption ImportOptions.DuplicateItemOption: enum: - IMPORT - SKIP ImportOptions.NewUserOption: enum: - ADD_AS_INACTIVE - ADD_WITH_INVITATION ImportOptions.ProjectMapping: description: "Mapping of Jira project ID to Atono team ID. When teamId is provided,\ \ items from the project are assigned directly to that team. When teamId is\ \ null, team is created/matched by project name." properties: projectId: type: string minLength: 1 teamId: type: - string - "null" format: uuid required: - projectId ImportOptions.TeamMemberOption: enum: - IMPORT_INVOLVED_USERS - IMPORT_ALL_TEAM_MEMBERS ImportOptions.UnknownItemTypeOption: enum: - ADD_AS_STORIES - ADD_AS_BUGS - SKIP IntegrationConfig: description: Base interface for integration-specific configuration stored in WorkspaceIntegration. Each integration type can define its own config record implementing this interface. discriminator: propertyName: type mapping: JIRA_SYNC: "#/components/schemas/IntegrationConfig.JiraSyncConfig" oneOf: - $ref: "#/components/schemas/IntegrationConfig.JiraSyncConfig" IntegrationConfig.JiraSyncConfig: description: "Configuration for Jira Sync integration. Stores the Jira host\ \ configuration, site name, selected project keys, and project details for\ \ synchronization." properties: host: type: string user: type: string apiToken: type: string siteName: type: string projects: type: array items: $ref: "#/components/schemas/Project" type: type: string required: - apiToken - host - projects - siteName - user IntegrationController.WorkspaceIntegrationFilter: properties: type: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkspaceIntegrationTypeFilter" IntegrationStatus: enum: - NOT_INSTALLED - ACTIVE - REVOKED InvoiceResource: properties: type: type: string pattern: invoice id: type: string attributes: $ref: "#/components/schemas/InvoiceResource.InvoiceResourceAttributes" required: - attributes - id - type InvoiceResource.InvoiceResourceAttributes: properties: currency: type: string amountDue: type: integer format: int64 amountPaid: type: integer format: int64 total: type: integer format: int64 status: type: string created: type: string format: date-time required: - amountDue - amountPaid - created - currency - status - total ItemSizeIdentifier: properties: id: type: string format: uuid label: type: string sizeSuggested: type: boolean required: - id - label - sizeSuggested ItemSizeResource: properties: type: type: string pattern: role id: type: string attributes: $ref: "#/components/schemas/ItemSizeResource.Attributes" required: - attributes - id - type ItemSizeResource.Attributes: properties: name: type: string minLength: 1 position: type: integer format: int32 required: - name - position JiraSpaceResource: description: JSON:API resource representing a Jira space (project) available for import. properties: type: type: string pattern: jira_space id: type: string attributes: $ref: "#/components/schemas/JiraSpaceResource.Attributes" required: - attributes - id - type JiraSpaceResource.Attributes: properties: key: type: string minLength: 1 name: type: string minLength: 1 required: - key - name JiraSyncJobResource: description: JSON:API resource for Jira sync job requests. properties: type: type: string pattern: jira_sync_job attributes: $ref: "#/components/schemas/JiraSyncJobResource.Attributes" relationships: $ref: "#/components/schemas/JiraSyncJobResource.Relationships" required: - attributes - relationships - type JiraSyncJobResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" forceSync: type: boolean required: - forceSync - state JiraSyncJobResource.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" required: - backlogItem JiraSyncJobResponse: description: "The returned resource, based on the request." properties: type: type: string pattern: jira_sync_job id: type: string attributes: $ref: "#/components/schemas/JiraSyncJobResponse.Attributes" relationships: $ref: "#/components/schemas/JiraSyncJobResponse.Relationships" meta: $ref: "#/components/schemas/JiraSyncJobResponse.Metadata" required: - attributes - id - meta - relationships - type JiraSyncJobResponse.Attributes: properties: state: $ref: "#/components/schemas/JobResponseState" required: - state JiraSyncJobResponse.Metadata: properties: errorCode: type: string errorMessage: type: string required: - errorCode - errorMessage JiraSyncJobResponse.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" required: - backlogItem JobRequestState: enum: - VALIDATE - SCHEDULE - CLEANUP JobResponseState: enum: - SUBMITTED - VALIDATING - VALID - SCHEDULED - RUNNING - COMPLETED - COMPLETED_WITH_ERRORS - FAILED - CLEANING - CLEANUP_COMPLETED - CLEANUP_FAILED LocationResource: properties: type: type: string pattern: location id: type: string attributes: $ref: "#/components/schemas/LocationResource.Attributes" relationships: $ref: "#/components/schemas/LocationResource.Relationships" required: - attributes - id - relationships - type LocationResource.Attributes: properties: name: type: string minLength: 1 isoCode: type: - string - "null" level: $ref: "#/components/schemas/HierarchyLevel" unicodeFlag: type: - string - "null" required: - level - name LocationResource.Relationships: properties: parent: $ref: "#/components/schemas/SingleRelationship" required: - parent LoginRequest: description: A request to start log in flow properties: email: type: string description: Email of the user that wants to login minLength: 1 extra: type: string description: Extra information to include in the user's login link required: - email LoginResponse: description: Tokens that frontend needs to perform authenticated API calls properties: token: type: string description: Access token. Use on every request. refresh: type: string description: Refresh token. Use only to get a new access token. MultiResourceBody_AiActivityResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/AiActivityResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ApiKeyResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ApiKeyResource_1" description: An API key to perform calls on the behalf of the user who created the key. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_BacklogItemChangeSetResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/BacklogItemChangeSetResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_BacklogItemChannelResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/BacklogItemChannelResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_BacklogItemResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/BacklogItemResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_BillingDetailsResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/BillingDetailsResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_BugResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/BugResource" description: A bug is a tracked issue observed during use or testing that should be fixed. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_CommentResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/CommentResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ConversationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ConversationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_DashboardWidgetResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/DashboardWidgetResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_EnvironmentResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/EnvironmentResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_EpicResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/EpicResource" description: An epic is a large body of work that can be broken down into smaller stories and bugs. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FeatureFlagChangeSetResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FeatureFlagChangeSetResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FeatureFlagResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FeatureFlagResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FlagEnvironmentResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FlagEnvironmentResource" description: The configuration for a flag in a specific environment. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FlagResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FlagResource" description: "A feature flag controls the behavior of a feature in Atono.\ \ It includes a unique name (key), a list of possible variants, a summary\ \ of what the flag controls, and environment-specific configuration\ \ (slices) that determines how the flag evaluates across environments." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FlagRulesetResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FlagRulesetResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_FollowedItemResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/FollowedItemResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_GlossaryEntryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/GlossaryEntryResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_GlossaryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/GlossaryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ImpactResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ImpactResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ImportJobResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ImportJobResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_InvoiceResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/InvoiceResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ItemSizeResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ItemSizeResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_JiraSpaceResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/JiraSpaceResource" description: JSON:API resource representing a Jira space (project) available for import. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_LocationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/LocationResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_PersonaItemResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/PersonaItemResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_PersonaResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/PersonaResource" description: A persona represents the type of user identified in the "As a…" portion of a user story and defines whose need or problem the story addresses. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_PriceResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/PriceResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ProbabilityResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ProbabilityResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ProductResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ProductResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ProductThemeResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ProductThemeResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_PullRequestResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/PullRequestResource" description: A pull request from a version control system (such as GitHub) that is connected to the workspace via an integration. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ReleaseMarkerResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ReleaseMarkerResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_ResourceIdentifier_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/ResourceIdentifier" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_RoleResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/RoleResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SavedViewResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SavedViewResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SavedViewTeamResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SavedViewTeamResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SavedViewUserResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SavedViewUserResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SharedIntegrationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SharedIntegrationResource" description: An integration published by Atono that can be installed in a workspace. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SlackChannelResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SlackChannelResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SlackConnectionResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SlackConnectionResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SlackIntegrationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SlackIntegrationResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SliceAttributeValueResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SliceAttributeValueResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SliceLocationValueResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SliceLocationValueResource" description: "This is the same shape as a SliceAttributeValueResource,\ \ but the \\`value\\` attribute is expanded to define specific fields\ \ instead of a plain object," errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SprintEntryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SprintEntryResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SprintResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SprintResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_StoryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/StoryResource" description: "A story represents a piece of planned work in Atono, typically\ \ written from the user's perspective. It includes a user story statement,\ \ acceptance criteria, and optional context to guide implementation\ \ or review." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_StoryReviewFindingResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/StoryReviewFindingResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_StoryWriterConversationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/StoryWriterConversationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SubscriptionItemResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SubscriptionItemResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SubscriptionResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SubscriptionResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SubtaskResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SubtaskResource" description: A subtask is a small unit of work nested within a story or bug. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_SyncedJiraSpaceResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/SyncedJiraSpaceResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TagResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TagResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TagSuggestionResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TagSuggestionResource" description: JSON API resource for tag suggestions. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TagValueResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TagValueResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TeamChannelMemberResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TeamChannelMemberResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TeamChannelResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TeamChannelResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TeamResourceV1_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TeamResourceV1" description: "A team represents a group of people responsible for delivering\ \ and supporting work in Atono. Each team has its own backlog, workflow,\ \ and membership, and may be linked to a Slack channel for communication." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TeamResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TeamResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TimeboxResourceV1_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TimeboxResourceV1" description: "A timebox (sprint, iteration, or release) that organizes\ \ backlog items within a specific timeframe." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TimeboxResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TimeboxResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TimelineEntryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TimelineEntryResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_TimelineResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/TimelineResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_UserResourceV1_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/UserResourceV1" description: "A user is an individual with access to Atono, defined by\ \ a unique email address and optional profile details." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_UserResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/UserResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_UserSettingEntryResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/UserSettingEntryResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_WorkflowResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/WorkflowResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_WorkflowStepResourceV1_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/WorkflowStepResourceV1" description: "A workflow step represents a stage in the team's workflow\ \ process. Stories and bugs move through these steps as they progress\ \ from creation to completion. Each step has a category (To do, In progress,\ \ Done, or Won't do) and can be configured to accept stories, bugs,\ \ or both." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_WorkflowStepResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/WorkflowStepResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_WorkspaceIntegrationResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/WorkspaceIntegrationResource" description: An integration that was installed in the workspace. errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceBody_WorkspaceResource_: properties: data: type: array description: "A list of returned resources, based on the request." items: $ref: "#/components/schemas/WorkspaceResource" errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an `include` parameter in\ \ the request. Each item contains a full resource object (e.g., users,\ \ teams, acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true MultiResourceRequest_DashboardWidgetResource_: properties: data: type: array items: $ref: "#/components/schemas/DashboardWidgetResource" description: "The returned resource, based on the request." required: - data MultiResourceRequest_FlagRuleUpdateResource_: properties: data: type: array items: $ref: "#/components/schemas/FlagRuleUpdateResource" required: - data MultiResourceRequest_ResourceIdentifier_: properties: data: type: array items: $ref: "#/components/schemas/ResourceIdentifier" required: - data MultiResourceRequest_StoryReviewFindingUpdateResource_: properties: data: type: array items: $ref: "#/components/schemas/StoryReviewFindingUpdateResource" required: - data MultiResourceRequest_SubscriptionItemUpdateResource_: properties: data: type: array items: $ref: "#/components/schemas/SubscriptionItemUpdateResource" required: - data MultiResourceRequest_TeamDeletionResource_: properties: data: type: array items: $ref: "#/components/schemas/TeamDeletionResource" required: - data MultiResourceRequest_WorkflowStepResetResource_: properties: data: type: array items: $ref: "#/components/schemas/WorkflowStepResetResource" required: - data MultipleRelationships: properties: links: $ref: "#/components/schemas/RelationshipLinks" data: type: - array - "null" items: $ref: "#/components/schemas/ResourceIdentifier" meta: additionalProperties: true required: - data - links - meta MultipleRelationshipsUpdate: properties: data: type: array items: $ref: "#/components/schemas/ResourceIdentifier" required: - data NoResourceBody: properties: errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true PageFilter: properties: page[number]: type: - integer - "null" format: int32 description: "Returns a specific page of results, starting from page `0`.\ \ Use with `page[size]` to control how many items are returned per page.\ \ For example, if `page[size]` is `20`, then `page[number]=2` returns\ \ items 21-40." minimum: 0 name: "page[number]" page[size]: type: - integer - "null" format: int32 description: Controls how many items are returned in each response page. minimum: 0 name: "page[size]" page[offset]: type: - integer - "null" format: int32 description: "Skips the specified number of items before starting the result\ \ set. For example, if `page[offset]` is `30` and `page[size]` is `10`,\ \ the response returns items 31-40." minimum: 0 name: "page[offset]" PersonaItemResource: properties: type: type: string pattern: persona attributes: $ref: "#/components/schemas/PersonaItemResource.PersonaItemAttributes" required: - attributes - type PersonaItemResource.PersonaItemAttributes: properties: value: type: string minLength: 1 required: - value PersonaResource: description: A persona represents the type of user identified in the "As a…" portion of a user story and defines whose need or problem the story addresses. properties: type: type: string default: persona description: Identifies the type of resource. pattern: persona defaultValue: persona attributes: allOf: - $ref: "#/components/schemas/PersonaResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." readOnly: true required: - attributes - type PersonaResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: The unique name or role used in the "As a…" portion of the user story. example: Operations Engineer minLength: 1 exampleSetFlag: true required: - name PreSignedUrl: description: "The returned resource, based on the request." properties: path: type: string url: type: string required: - path - url PreflightResult.Entry: properties: type: $ref: "#/components/schemas/PreflightResult.EntryType" code: type: string title: type: string detail: type: string source: additionalProperties: true required: - code - detail - source - title - type PreflightResult.EntryType: enum: - NOTICE - SIDE_EFFECT - NO_OP - ERROR PriceResource: properties: type: type: string pattern: price id: type: string attributes: $ref: "#/components/schemas/PriceResource.Attributes" relationships: $ref: "#/components/schemas/PriceResource.Relationships" required: - attributes - id - relationships - type PriceResource.Attributes: properties: active: type: boolean billingScheme: type: string currency: type: string recurring: $ref: "#/components/schemas/SubscriptionPrice.Recurring" tiers: type: array items: $ref: "#/components/schemas/SubscriptionPrice.Tier" tiersMode: type: string unitAmount: type: integer format: int64 unitAmountDecimal: type: number lookupKey: type: string metadata: additionalProperties: type: string required: - active - billingScheme - currency - lookupKey - metadata - recurring - tiers - tiersMode - unitAmount - unitAmountDecimal PriceResource.Relationships: properties: product: $ref: "#/components/schemas/SingleRelationship" required: - product Probability: properties: id: type: integer format: int32 name: type: string value: type: integer format: int32 required: - id - name - value ProbabilityResource: properties: type: type: string pattern: probability id: type: string attributes: $ref: "#/components/schemas/ProbabilityResource.ImpactAttributes" required: - attributes - id - type ProbabilityResource.ImpactAttributes: properties: name: type: string minLength: 1 value: type: integer format: int32 required: - name - value ProblemDetail: description: A problem detail object is a way to convey information about an error that occurred while processing a request. properties: id: type: string description: A unique identifier for this specific error occurrence. Useful for debugging and support. links: additionalProperties: type: string format: uri allOf: - type: - "null" - object description: Links related to the error. May include a URL to relevant documentation or support resources. status: type: integer format: int32 description: "The HTTP status code associated with the error (e.g., 400,\ \ 404, 422)." code: type: string description: An internal code that identifies the type or category of the error. title: type: string description: A short summary of the problem. source: type: - "null" - object allOf: - $ref: "#/components/schemas/ProblemSource" readOnly: true detail: type: string description: "Additional information about the error, intended to provide\ \ more context than the title." meta: additionalProperties: true description: "Additional information about the error, which may be useful\ \ for debugging. The contents vary depending on the error type." readOnly: true ProblemSource: description: Identifies the part of the request that caused the error. Only one source is present per error. properties: pointer: type: - string - "null" description: Specifies the path to the field in the request body that caused the error. parameter: type: - string - "null" description: Identifies a query parameter in the request URL that caused the error. header: type: - string - "null" description: Identifies the request header that caused the error. readOnly: true ProductResource: properties: type: type: string pattern: product id: type: string attributes: $ref: "#/components/schemas/ProductResource.Attributes" relationships: $ref: "#/components/schemas/ProductResource.Relationships" required: - attributes - id - relationships - type ProductResource.Attributes: properties: active: type: boolean name: type: string description: type: string tier: $ref: "#/components/schemas/Subscription.SubscriptionTier" productType: $ref: "#/components/schemas/SubscriptionProduct.ProductType" entitledStorageMB: type: integer format: int64 maxUserSeats: type: integer format: int32 minUserSeats: type: integer format: int32 marketingFeatures: type: array items: type: string required: - active - description - entitledStorageMB - marketingFeatures - maxUserSeats - minUserSeats - name - productType - tier ProductResource.Relationships: properties: defaultPrice: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - defaultPrice ProductThemeController.InclusionType: enum: - BACKLOG_ITEMS ProductThemeCreationResource: properties: type: type: string pattern: product_theme attributes: $ref: "#/components/schemas/ProductThemeCreationResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/ProductThemeCreationResource.Relationships" required: - attributes - relationships - type ProductThemeCreationResource.Attributes: properties: name: type: string maxLength: 100 minLength: 1 description: type: - string - "null" maxLength: 2000 required: - description - name ProductThemeCreationResource.Relationships: properties: stories: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - stories ProductThemeResource: properties: type: type: string pattern: product_theme id: type: string attributes: $ref: "#/components/schemas/ProductThemeResource.Attributes" relationships: $ref: "#/components/schemas/ProductThemeResource.Relationships" meta: $ref: "#/components/schemas/ProductThemeResource.Metadata" required: - attributes - id - meta - relationships - type ProductThemeResource.Attributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string minLength: 1 description: type: string required: - createdAt - description - name - updatedAt ProductThemeResource.Metadata: properties: state: $ref: "#/components/schemas/State" allowedActions: type: array items: type: string required: - allowedActions - state ProductThemeResource.Relationships: properties: stories: $ref: "#/components/schemas/MultipleRelationships" required: - stories ProductThemeUpdateResource: properties: type: type: string pattern: product_theme id: type: string attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/ProductThemeUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/ProductThemeUpdateResource.Relationships" required: - attributes - id - relationships - type ProductThemeUpdateResource.Attributes: properties: name: type: - string - "null" maxLength: 100 minLength: 1 description: type: - string - "null" maxLength: 2000 required: - description - name ProductThemeUpdateResource.Relationships: properties: stories: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - stories Project: properties: id: type: string name: type: string key: type: string uuid: type: string format: uuid required: - id - key - name - uuid PullRequestResource: description: A pull request from a version control system (such as GitHub) that is connected to the workspace via an integration. properties: type: type: string default: vcs_pull_request description: Identifies the type of resource. pattern: vcs_pull_request defaultValue: vcs_pull_request id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/PullRequestResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/PullRequestResource.Relationships" description: Contains references to other related resources. meta: allOf: - $ref: "#/components/schemas/PullRequestResource.Metadata" description: "Extra information about the resource, including calculated\ \ values or non-standard fields." readOnly: true PullRequestResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: summary: type: string pullRequestExternalId: type: string url: type: string format: uri repositoryDisplayName: type: string repositoryUrl: type: string format: uri required: - pullRequestExternalId - repositoryDisplayName - repositoryUrl - summary - url PullRequestResource.Metadata: description: "Extra information about the resource, including calculated values\ \ or non-standard fields." properties: status: type: string buildStatus: type: string lastUpdated: type: string format: date-time externalUserAccountName: type: string externalUserDisplayName: type: string externalUserEmail: type: string externalUserProfileUrl: type: string format: uri required: - buildStatus - externalUserAccountName - externalUserDisplayName - externalUserEmail - externalUserProfileUrl - lastUpdated - status PullRequestResource.Relationships: description: Contains references to other related resources. properties: backlogItems: $ref: "#/components/schemas/MultipleRelationships" createdBy: $ref: "#/components/schemas/SingleRelationship" workspaceIntegration: $ref: "#/components/schemas/SingleRelationship" required: - backlogItems - createdBy - workspaceIntegration RefreshTokenRequest: description: A request to refresh an access token properties: refresh: type: string description: Refresh token that was issued during the login flow minLength: 1 required: - refresh RelatedItemsSearchResource: properties: type: type: string pattern: related_items_search attributes: $ref: "#/components/schemas/RelatedItemsSearchResource.Attributes" required: - attributes - type RelatedItemsSearchResource.Attributes: properties: itemType: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.ItemType" title: type: - string - "null" content: type: - string - "null" acceptanceCriteria: type: - string - "null" additionalContent: type: - string - "null" linkedItems: type: - array - "null" items: type: string format: uuid maxResults: type: - integer - "null" format: int32 maximum: 10 minimum: 1 required: - acceptanceCriteria - additionalContent - content - itemType - linkedItems - maxResults - title RelationshipLinks: properties: self: type: - string - "null" format: uri related: type: - string - "null" format: uri required: - related - self ReleaseMarkerController.InclusionType: enum: - TIMELINES ReleaseMarkerController.RequestFilter: properties: date: type: - string - "null" autocomplete: type: - string - "null" ReleaseMarkerCreationResource: properties: type: type: string pattern: release_marker attributes: $ref: "#/components/schemas/ReleaseMarkerCreationResource.Attributes" relationships: $ref: "#/components/schemas/ReleaseMarkerCreationResource.Relationships" required: - attributes - relationships - type ReleaseMarkerCreationResource.Attributes: properties: name: type: string maxLength: 100 minLength: 1 date: type: string format: date-time required: - date - name ReleaseMarkerCreationResource.Relationships: properties: timelines: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - timelines ReleaseMarkerResource: properties: type: type: string pattern: release_marker id: type: string format: uuid attributes: $ref: "#/components/schemas/ReleaseMarkerResource.Attributes" relationships: $ref: "#/components/schemas/ReleaseMarkerResource.Relationships" meta: $ref: "#/components/schemas/ReleaseMarkerResource.Metadata" required: - attributes - id - meta - relationships - type ReleaseMarkerResource.Attributes: properties: name: type: string date: type: string format: date-time required: - date - name ReleaseMarkerResource.Metadata: properties: state: $ref: "#/components/schemas/State" allowedActions: type: array items: type: string required: - allowedActions - state ReleaseMarkerResource.Relationships: properties: timelines: $ref: "#/components/schemas/MultipleRelationships" required: - timelines ReleaseMarkerUpdateResource: properties: type: type: string pattern: release_marker id: type: string format: uuid attributes: $ref: "#/components/schemas/ReleaseMarkerUpdateResource.Attributes" relationships: $ref: "#/components/schemas/ReleaseMarkerUpdateResource.Relationships" required: - attributes - id - relationships - type ReleaseMarkerUpdateResource.Attributes: properties: name: type: - string - "null" maxLength: 100 date: type: - string - "null" format: date-time required: - date - name ReleaseMarkerUpdateResource.Relationships: properties: timelines: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - timelines Request_AcceptanceCriterionCreationResource_: properties: data: $ref: "#/components/schemas/AcceptanceCriterionCreationResource" required: - data Request_AcceptanceCriterionUpdateResource_: properties: data: $ref: "#/components/schemas/AcceptanceCriterionUpdateResource" required: - data Request_AiActivityCreationResource_: properties: data: $ref: "#/components/schemas/AiActivityCreationResource" required: - data Request_ApiKeyCreationResource_: properties: data: $ref: "#/components/schemas/ApiKeyCreationResource" required: - data Request_ApiKeyUpdateResource_: properties: data: $ref: "#/components/schemas/ApiKeyUpdateResource" required: - data Request_AttachmentCreationResource_: properties: data: $ref: "#/components/schemas/AttachmentCreationResource" required: - data Request_AttachmentUpdateResource_: properties: data: $ref: "#/components/schemas/AttachmentUpdateResource" required: - data Request_BacklogItemChannelCreateResource_: properties: data: $ref: "#/components/schemas/BacklogItemChannelCreateResource" required: - data Request_BacklogItemChannelUpdateResource_: properties: data: $ref: "#/components/schemas/BacklogItemChannelUpdateResource" required: - data Request_BacklogItemCreationResource_: properties: data: $ref: "#/components/schemas/BacklogItemCreationResource" required: - data Request_BacklogItemUpdateResource_: properties: data: $ref: "#/components/schemas/BacklogItemUpdateResource" required: - data Request_BacklogItemsTaggingJobResource_: properties: data: $ref: "#/components/schemas/BacklogItemsTaggingJobResource" required: - data Request_BacklogItemsUntaggingJobResource_: properties: data: $ref: "#/components/schemas/BacklogItemsUntaggingJobResource" required: - data Request_BugCreateResource_: properties: data: $ref: "#/components/schemas/BugCreateResource" required: - data Request_BugUpdateResource_: properties: data: $ref: "#/components/schemas/BugUpdateResource" required: - data Request_CommentCreationResource_: properties: data: $ref: "#/components/schemas/CommentCreationResource" required: - data Request_CommentUpdateResource_: properties: data: $ref: "#/components/schemas/CommentUpdateResource" required: - data Request_ConversationCreationResource_: properties: data: $ref: "#/components/schemas/ConversationCreationResource" required: - data Request_CreateUsersJobResource_: properties: data: $ref: "#/components/schemas/CreateUsersJobResource" required: - data Request_DashboardWidgetCreationResource_: properties: data: $ref: "#/components/schemas/DashboardWidgetCreationResource" required: - data Request_DeleteUserJobResource_: properties: data: $ref: "#/components/schemas/DeleteUserJobResource" required: - data Request_EnvironmentCreateResource_: properties: data: $ref: "#/components/schemas/EnvironmentCreateResource" required: - data Request_EnvironmentUpdateResource_: properties: data: $ref: "#/components/schemas/EnvironmentUpdateResource" required: - data Request_EpicCreateResource_: properties: data: $ref: "#/components/schemas/EpicCreateResource" required: - data Request_EpicUpdateResource_: properties: data: $ref: "#/components/schemas/EpicUpdateResource" required: - data Request_FeatureFlagCreateResource_: properties: data: $ref: "#/components/schemas/FeatureFlagCreateResource" required: - data Request_FeatureFlagUpdateResource_: properties: data: $ref: "#/components/schemas/FeatureFlagUpdateResource" required: - data Request_FlagEnvironmentUpdateResource_: properties: data: $ref: "#/components/schemas/FlagEnvironmentUpdateResource" required: - data Request_FlagRuleUpdateResource_: properties: data: $ref: "#/components/schemas/FlagRuleUpdateResource" required: - data Request_FollowedItemCreationResource_: properties: data: $ref: "#/components/schemas/FollowedItemCreationResource" required: - data Request_GlossaryCreationResource_: properties: data: $ref: "#/components/schemas/GlossaryCreationResource" required: - data Request_GlossaryEntryCreationResource_: properties: data: $ref: "#/components/schemas/GlossaryEntryCreationResource" required: - data Request_GlossaryEntryUpdateResource_: properties: data: $ref: "#/components/schemas/GlossaryEntryUpdateResource" required: - data Request_GlossaryUpdateResource_: properties: data: $ref: "#/components/schemas/GlossaryUpdateResource" required: - data Request_ImportJobCreationResource_: properties: data: $ref: "#/components/schemas/ImportJobCreationResource" required: - data Request_ImportJobUpdateResource_: properties: data: $ref: "#/components/schemas/ImportJobUpdateResource" required: - data Request_JiraSyncJobResource_: properties: data: $ref: "#/components/schemas/JiraSyncJobResource" required: - data Request_ProductThemeCreationResource_: properties: data: $ref: "#/components/schemas/ProductThemeCreationResource" required: - data Request_ProductThemeUpdateResource_: properties: data: $ref: "#/components/schemas/ProductThemeUpdateResource" required: - data Request_RelatedItemsSearchResource_: properties: data: $ref: "#/components/schemas/RelatedItemsSearchResource" required: - data Request_ReleaseMarkerCreationResource_: properties: data: $ref: "#/components/schemas/ReleaseMarkerCreationResource" required: - data Request_ReleaseMarkerUpdateResource_: properties: data: $ref: "#/components/schemas/ReleaseMarkerUpdateResource" required: - data Request_SavedViewCreationResource_: properties: data: $ref: "#/components/schemas/SavedViewCreationResource" required: - data Request_SavedViewUpdateResource_: properties: data: $ref: "#/components/schemas/SavedViewUpdateResource" required: - data Request_SlackConnectionCreateResource_: properties: data: $ref: "#/components/schemas/SlackConnectionCreateResource" required: - data Request_SlackConnectionUpdateResource_: properties: data: $ref: "#/components/schemas/SlackConnectionUpdateResource" required: - data Request_SplitStoryJobCreationResource_: properties: data: $ref: "#/components/schemas/SplitStoryJobCreationResource" required: - data Request_SplitStoryJobUpdateResource_: properties: data: $ref: "#/components/schemas/SplitStoryJobUpdateResource" required: - data Request_SprintCreationResource_: properties: data: $ref: "#/components/schemas/SprintCreationResource" required: - data Request_SprintEntryUpdateResource_: properties: data: $ref: "#/components/schemas/SprintEntryUpdateResource" required: - data Request_SprintSeriesCreationResource_: properties: data: $ref: "#/components/schemas/SprintSeriesCreationResource" required: - data Request_SprintUpdateResource_: properties: data: $ref: "#/components/schemas/SprintUpdateResource" required: - data Request_SsoSamlConfigurationUpdateResource_: properties: data: $ref: "#/components/schemas/SsoSamlConfigurationUpdateResource" required: - data Request_StoryCreateResource_: properties: data: $ref: "#/components/schemas/StoryCreateResource" required: - data Request_StoryReviewCreationResource_: properties: data: $ref: "#/components/schemas/StoryReviewCreationResource" required: - data Request_StoryReviewFindingUpdateResource_: properties: data: $ref: "#/components/schemas/StoryReviewFindingUpdateResource" required: - data Request_StoryUpdateResource_: properties: data: $ref: "#/components/schemas/StoryUpdateResource" required: - data Request_StoryWriterConversationCreationResource_: properties: data: $ref: "#/components/schemas/StoryWriterConversationCreationResource" required: - data Request_SubtaskCreateResource_: properties: data: $ref: "#/components/schemas/SubtaskCreateResource" required: - data Request_SubtaskCreationResource_: properties: data: $ref: "#/components/schemas/SubtaskCreationResource" required: - data Request_SubtaskUpdateResource_: properties: data: $ref: "#/components/schemas/SubtaskUpdateResource" required: - data Request_SyncedJiraSpaceCreateResource_: properties: data: $ref: "#/components/schemas/SyncedJiraSpaceCreateResource" required: - data Request_SyncedJiraSpaceUpdateResource_: properties: data: $ref: "#/components/schemas/SyncedJiraSpaceUpdateResource" required: - data Request_TagCreationResource_: properties: data: $ref: "#/components/schemas/TagCreationResource" required: - data Request_TagCreationSettingsUpdateResource_: properties: data: $ref: "#/components/schemas/TagCreationSettingsUpdateResource" required: - data Request_TagUpdateResource_: properties: data: $ref: "#/components/schemas/TagUpdateResource" required: - data Request_TagValueCreationResource_: properties: data: $ref: "#/components/schemas/TagValueCreationResource" required: - data Request_TagValueUpdateResource_: properties: data: $ref: "#/components/schemas/TagValueUpdateResource" required: - data Request_TeamChangePreviewResource_: properties: data: $ref: "#/components/schemas/TeamChangePreviewResource" required: - data Request_TeamChannelCreateResource_: properties: data: $ref: "#/components/schemas/TeamChannelCreateResource" required: - data Request_TeamChannelUpdateResource_: properties: data: $ref: "#/components/schemas/TeamChannelUpdateResource" required: - data Request_TeamCreateResourceV1_: properties: data: $ref: "#/components/schemas/TeamCreateResourceV1" required: - data Request_TeamCreationResource_: properties: data: $ref: "#/components/schemas/TeamCreationResource" required: - data Request_TeamUpdateResourceV1_: properties: data: $ref: "#/components/schemas/TeamUpdateResourceV1" required: - data Request_TeamUpdateResource_: properties: data: $ref: "#/components/schemas/TeamUpdateResource" required: - data Request_TimeboxCreationResource_: properties: data: $ref: "#/components/schemas/TimeboxCreationResource" required: - data Request_TimeboxUpdateResource_: properties: data: $ref: "#/components/schemas/TimeboxUpdateResource" required: - data Request_TimelineCreationResource_: properties: data: $ref: "#/components/schemas/TimelineCreationResource" required: - data Request_TimelineEntryCreationResource_: properties: data: $ref: "#/components/schemas/TimelineEntryCreationResource" required: - data Request_TimelineEntryUpdateResource_: properties: data: $ref: "#/components/schemas/TimelineEntryUpdateResource" required: - data Request_TimelineUpdateResource_: properties: data: $ref: "#/components/schemas/TimelineUpdateResource" required: - data Request_UsageConfigurationResourceCreate_: properties: data: $ref: "#/components/schemas/UsageConfigurationResourceCreate" required: - data Request_UsageConfigurationResourceUpdate_: properties: data: $ref: "#/components/schemas/UsageConfigurationResourceUpdate" required: - data Request_UserCreateResourceV1_: properties: data: $ref: "#/components/schemas/UserCreateResourceV1" required: - data Request_UserCreationResource_: properties: data: $ref: "#/components/schemas/UserCreationResource" required: - data Request_UserSettingEntryCreationResource_: properties: data: $ref: "#/components/schemas/UserSettingEntryCreationResource" required: - data Request_UserSettingsUpdateResource_: properties: data: $ref: "#/components/schemas/UserSettingsUpdateResource" required: - data Request_UserUpdateResourceV1_: properties: data: $ref: "#/components/schemas/UserUpdateResourceV1" required: - data Request_UserUpdateResource_: properties: data: $ref: "#/components/schemas/UserUpdateResource" required: - data Request_WorkflowStepCreationResource_: properties: data: $ref: "#/components/schemas/WorkflowStepCreationResource" required: - data Request_WorkflowStepItemTypeChangeResource_: properties: data: $ref: "#/components/schemas/WorkflowStepItemTypeChangeResource" required: - data Request_WorkflowStepRemovalResource_: properties: data: $ref: "#/components/schemas/WorkflowStepRemovalResource" required: - data Request_WorkflowStepUpdateResource_: properties: data: $ref: "#/components/schemas/WorkflowStepUpdateResource" required: - data Request_WorkspaceIntegrationUpdateResource_: properties: data: $ref: "#/components/schemas/WorkspaceIntegrationUpdateResource" required: - data Request_WorkspaceUpdateResource_: properties: data: $ref: "#/components/schemas/WorkspaceUpdateResource" required: - data ResourceIdentifier: properties: type: type: string description: Identifies the type of the linked resource. id: type: string description: The unique identifier of the linked resource. required: - id - type RiskRatingSuggestion.RequestType: enum: - USER - AUTO RiskRatingSuggestionResource: description: "The returned resource, based on the request." properties: type: type: string pattern: risk_rating_suggestion id: type: string format: uuid attributes: $ref: "#/components/schemas/RiskRatingSuggestionResource.Attributes" relationships: $ref: "#/components/schemas/RiskRatingSuggestionResource.Relationships" required: - attributes - id - relationships - type RiskRatingSuggestionResource.Attributes: properties: createdAt: type: string format: date-time requestType: $ref: "#/components/schemas/RiskRatingSuggestion.RequestType" impactExplanation: type: string probabilityExplanation: type: string required: - createdAt - impactExplanation - probabilityExplanation - requestType RiskRatingSuggestionResource.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" suggestedImpact: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" suggestedProbability: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - backlogItem - suggestedImpact - suggestedProbability RoleResource: properties: type: type: string pattern: role id: type: string attributes: $ref: "#/components/schemas/RoleResource.RoleAttributes" required: - attributes - id - type RoleResource.RoleAttributes: properties: name: type: string minLength: 1 roleType: type: string minLength: 1 required: - name - roleType SavedView.ColumnOption: properties: name: type: string maxLength: 100 minLength: 1 isSelected: type: boolean showIcon: type: - boolean - "null" order: type: integer format: int32 currentWidth: type: integer format: int32 required: - currentWidth - isSelected - name - order SavedView.SortOrder: properties: columns: type: array items: type: string maxLength: 100 minLength: 1 maxItems: 100 minItems: 1 required: - columns SavedViewController.InclusionType: enum: - CREATOR - USERS - TEAMS SavedViewController.SavedViewRequestFilter: properties: creator: type: - string - "null" format: uuid user: type: - string - "null" format: uuid team: type: - string - "null" format: uuid SavedViewCreationResource: properties: type: type: string pattern: saved_view attributes: $ref: "#/components/schemas/SavedViewCreationResource.SavedViewAttributes" required: - attributes - type SavedViewCreationResource.SavedViewAttributes: properties: viewName: type: string maxLength: 100 minLength: 1 filterValues: $ref: "#/components/schemas/BacklogItemFilterResource" sortOrder: $ref: "#/components/schemas/SavedViewCreationResource.SortOrder" columnOptions: type: array items: $ref: "#/components/schemas/SavedView.ColumnOption" maxItems: 50 minItems: 1 required: - columnOptions - filterValues - sortOrder - viewName SavedViewCreationResource.SortOrder: properties: columns: type: array items: type: string maxLength: 100 maxItems: 100 minItems: 1 required: - columns SavedViewResource: description: "The returned resource, based on the request." properties: type: type: string pattern: saved_view id: type: string format: uuid attributes: $ref: "#/components/schemas/SavedViewResource.SavedViewAttributes" relationships: $ref: "#/components/schemas/SavedViewResource.SavedViewRelationships" meta: $ref: "#/components/schemas/SavedViewResource.SavedViewMetadata" required: - attributes - id - meta - relationships - type SavedViewResource.SavedViewAttributes: properties: viewName: type: string maxLength: 100 minLength: 1 filterValues: $ref: "#/components/schemas/BacklogItemFilterResource" sortOrder: $ref: "#/components/schemas/SavedView.SortOrder" columnOptions: type: array items: $ref: "#/components/schemas/SavedView.ColumnOption" required: - columnOptions - filterValues - sortOrder - viewName SavedViewResource.SavedViewMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions SavedViewResource.SavedViewRelationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" sharedUsers: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" sharedTeams: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - creator - sharedTeams - sharedUsers SavedViewTeamResource: properties: type: type: string pattern: saved_view_team id: type: string format: uuid relationships: $ref: "#/components/schemas/SavedViewTeamResource.SavedViewTeamRelationships" meta: $ref: "#/components/schemas/SavedViewTeamResource.SavedViewTeamMetadata" required: - id - meta - relationships - type SavedViewTeamResource.SavedViewTeamMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions SavedViewTeamResource.SavedViewTeamRelationships: properties: savedView: $ref: "#/components/schemas/SingleRelationship" team: $ref: "#/components/schemas/SingleRelationship" sharer: $ref: "#/components/schemas/SingleRelationship" required: - savedView - sharer - team SavedViewUpdateResource: properties: type: type: string pattern: saved_view id: type: string format: uuid attributes: $ref: "#/components/schemas/SavedViewUpdateResource.SavedViewAttributes" required: - attributes - id - type SavedViewUpdateResource.SavedViewAttributes: properties: viewName: type: - string - "null" maxLength: 100 minLength: 1 filterValues: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemFilterResource" sortOrder: type: - "null" - object allOf: - $ref: "#/components/schemas/SavedViewUpdateResource.SortOrder" columnOptions: type: - array - "null" items: $ref: "#/components/schemas/SavedView.ColumnOption" required: - columnOptions - filterValues - sortOrder - viewName SavedViewUpdateResource.SortOrder: properties: columns: type: array items: type: string maxLength: 100 maxItems: 100 minItems: 1 required: - columns SavedViewUserResource: properties: type: type: string pattern: saved_view_user id: type: string format: uuid relationships: $ref: "#/components/schemas/SavedViewUserResource.SavedViewUserRelationships" meta: $ref: "#/components/schemas/SavedViewUserResource.SavedViewUserMetadata" required: - id - meta - relationships - type SavedViewUserResource.SavedViewUserMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions SavedViewUserResource.SavedViewUserRelationships: properties: savedView: $ref: "#/components/schemas/SingleRelationship" user: $ref: "#/components/schemas/SingleRelationship" sharer: $ref: "#/components/schemas/SingleRelationship" required: - savedView - sharer - user ScopeChangeItem: description: Represents a backlog item that was added to or removed from a sprint. Used in burndown chart scope line data. properties: itemId: type: string format: uuid points: type: integer format: int32 required: - itemId - points SearchController.RequestFilter: properties: keywordSearch: type: - string - "null" assigneeIds: type: - string - "null" createdAt: type: - string - "null" cycleTimeMode: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" doneAt: type: - string - "null" environmentIds: type: - string - "null" epicIds: type: - string - "null" excludeLinkedItemId: type: - string - "null" format: uuid excludeTagIds: type: - string - "null" excludeTagValueIds: type: - string - "null" externalId: type: - string - "null" handle: type: - string - "null" productThemeIds: type: - string - "null" riskRating: type: - string - "null" sizeIds: type: - string - "null" stepIds: type: - string - "null" tagIds: type: - string - "null" tagValueIds: type: - string - "null" teamIds: type: - string - "null" timeboxIds: type: - string - "null" triageGroup: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemController.TriageGroup" type: type: - string - "null" updatedAt: type: - string - "null" SharedIntegrationResource: description: An integration published by Atono that can be installed in a workspace. properties: type: type: string default: shared_integration description: Identifies the type of resource. pattern: shared_integration defaultValue: shared_integration id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/SharedIntegrationResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/SharedIntegrationResource.Relationships" description: Contains references to other related resources. meta: allOf: - $ref: "#/components/schemas/SharedIntegrationResource.Metadata" description: "Extra information about the resource, including calculated\ \ values or non-standard fields." readOnly: true SharedIntegrationResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: key: type: string name: type: string required: - key - name SharedIntegrationResource.Metadata: description: "Extra information about the resource, including calculated values\ \ or non-standard fields." properties: status: $ref: "#/components/schemas/IntegrationStatus" installedAt: type: - string - "null" format: date-time required: - installedAt - status SharedIntegrationResource.Relationships: description: Contains references to other related resources. properties: workspaceIntegration: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - workspaceIntegration SignUpRequest: description: A request to provision new workspace properties: email: type: string format: email description: Email of the user that wants to signup example: johndoe@example.com minLength: 1 exampleSetFlag: true fullName: type: string description: Full name of the user that wants to signup example: John Doe minLength: 1 exampleSetFlag: true workspaceName: type: string description: Desired workspace name example: mycompany minLength: 1 exampleSetFlag: true workspaceUrl: type: string description: Desired workspace URL example: https://mycompany.atono.io minLength: 1 exampleSetFlag: true skipSampleData: type: boolean description: "If true, skip populating sample data even if populateTrialData\ \ is enabled" required: - email - fullName - workspaceName - workspaceUrl SignUpResponse: properties: message: type: string required: - message SimpleFieldChangeSet_BacklogItem.CycleTimeMode_: properties: original: $ref: "#/components/schemas/BacklogItem.CycleTimeMode" modified: $ref: "#/components/schemas/BacklogItem.CycleTimeMode" required: - modified - original SimpleFieldChangeSet_BacklogItem.ImportMetadata_: properties: original: $ref: "#/components/schemas/BacklogItem.ImportMetadata" modified: $ref: "#/components/schemas/BacklogItem.ImportMetadata" required: - modified - original SimpleFieldChangeSet_Boolean_: properties: original: type: boolean modified: type: boolean required: - modified - original SimpleFieldChangeSet_BugTriageSnapshot_: properties: original: $ref: "#/components/schemas/BugTriageSnapshot" modified: $ref: "#/components/schemas/BugTriageSnapshot" required: - modified - original SimpleFieldChangeSet_Comment.Status_: properties: original: $ref: "#/components/schemas/Comment.Status" modified: $ref: "#/components/schemas/Comment.Status" required: - modified - original SimpleFieldChangeSet_FeatureFlagHistoricalIdentifier_: properties: original: $ref: "#/components/schemas/FeatureFlagHistoricalIdentifier" modified: $ref: "#/components/schemas/FeatureFlagHistoricalIdentifier" required: - modified - original SimpleFieldChangeSet_HistoricalIdentifier_: properties: original: $ref: "#/components/schemas/HistoricalIdentifier" modified: $ref: "#/components/schemas/HistoricalIdentifier" required: - modified - original SimpleFieldChangeSet_Integer_: properties: original: type: integer format: int32 modified: type: integer format: int32 required: - modified - original SimpleFieldChangeSet_ItemSizeIdentifier_: properties: original: $ref: "#/components/schemas/ItemSizeIdentifier" modified: $ref: "#/components/schemas/ItemSizeIdentifier" required: - modified - original SimpleFieldChangeSet_Map_String.Object__: properties: original: additionalProperties: true modified: additionalProperties: true required: - modified - original SimpleFieldChangeSet_String_: properties: original: type: string modified: type: string required: - modified - original SimpleFieldChangeSet_Subtask.Step_: properties: original: $ref: "#/components/schemas/Subtask.Step" modified: $ref: "#/components/schemas/Subtask.Step" required: - modified - original SimpleFieldChangeSet_UUID_: properties: original: type: string format: uuid modified: type: string format: uuid required: - modified - original SimpleFieldChangeSet_WorkflowStepSnapshot_: properties: original: $ref: "#/components/schemas/WorkflowStepSnapshot" modified: $ref: "#/components/schemas/WorkflowStepSnapshot" required: - modified - original SingleRelationship: properties: links: $ref: "#/components/schemas/RelationshipLinks" data: $ref: "#/components/schemas/ResourceIdentifier" meta: additionalProperties: true required: - data - links - meta SingleRelationshipUpdate: properties: data: $ref: "#/components/schemas/ResourceIdentifier" required: - data SingleResourceBody_AiActivityResource_: properties: data: allOf: - $ref: "#/components/schemas/AiActivityResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ApiKeyResource_: properties: data: allOf: - $ref: "#/components/schemas/ApiKeyResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_AttachmentResource_: properties: data: allOf: - $ref: "#/components/schemas/AttachmentResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BacklogItemChannelResource_: properties: data: allOf: - $ref: "#/components/schemas/BacklogItemChannelResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BacklogItemResource_: properties: data: allOf: - $ref: "#/components/schemas/BacklogItemResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BacklogItemsTaggingJobResponse_: properties: data: allOf: - $ref: "#/components/schemas/BacklogItemsTaggingJobResponse" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BacklogItemsUntaggingJobResponse_: properties: data: allOf: - $ref: "#/components/schemas/BacklogItemsUntaggingJobResponse" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BillingSessionResource_: properties: data: allOf: - $ref: "#/components/schemas/BillingSessionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_BugResource_: properties: data: allOf: - $ref: "#/components/schemas/BugResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_CheckoutSessionResource_: properties: data: allOf: - $ref: "#/components/schemas/CheckoutSessionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_CommentResource_: properties: data: allOf: - $ref: "#/components/schemas/CommentResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ConversationResource_: properties: data: allOf: - $ref: "#/components/schemas/ConversationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_CreateUsersJobResponse_: properties: data: allOf: - $ref: "#/components/schemas/CreateUsersJobResponse" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_DashboardWidgetResource_: properties: data: allOf: - $ref: "#/components/schemas/DashboardWidgetResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_DeleteUserJobResponse_: properties: data: allOf: - $ref: "#/components/schemas/DeleteUserJobResponse" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_EnvironmentResource_: properties: data: allOf: - $ref: "#/components/schemas/EnvironmentResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_EpicResource_: properties: data: allOf: - $ref: "#/components/schemas/EpicResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FeatureFlagResource_: properties: data: allOf: - $ref: "#/components/schemas/FeatureFlagResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FileUrl_: properties: data: allOf: - $ref: "#/components/schemas/FileUrl" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FlagEnvironmentResource_: properties: data: allOf: - $ref: "#/components/schemas/FlagEnvironmentResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FlagResource_: properties: data: allOf: - $ref: "#/components/schemas/FlagResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FlagRulesetResource_: properties: data: allOf: - $ref: "#/components/schemas/FlagRulesetResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_FollowedItemResource_: properties: data: allOf: - $ref: "#/components/schemas/FollowedItemResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_GlossaryEntryDiffResource_: properties: data: allOf: - $ref: "#/components/schemas/GlossaryEntryDiffResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_GlossaryEntryResource_: properties: data: allOf: - $ref: "#/components/schemas/GlossaryEntryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_GlossaryResource_: properties: data: allOf: - $ref: "#/components/schemas/GlossaryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ImportJobResource_: properties: data: allOf: - $ref: "#/components/schemas/ImportJobResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_JiraSyncJobResponse_: properties: data: allOf: - $ref: "#/components/schemas/JiraSyncJobResponse" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_LocationResource_: properties: data: allOf: - $ref: "#/components/schemas/LocationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_PreSignedUrl_: properties: data: allOf: - $ref: "#/components/schemas/PreSignedUrl" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_PriceResource_: properties: data: allOf: - $ref: "#/components/schemas/PriceResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ProductResource_: properties: data: allOf: - $ref: "#/components/schemas/ProductResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ProductThemeResource_: properties: data: allOf: - $ref: "#/components/schemas/ProductThemeResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_ReleaseMarkerResource_: properties: data: allOf: - $ref: "#/components/schemas/ReleaseMarkerResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_RiskRatingSuggestionResource_: properties: data: allOf: - $ref: "#/components/schemas/RiskRatingSuggestionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SavedViewResource_: properties: data: allOf: - $ref: "#/components/schemas/SavedViewResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SharedIntegrationResource_: properties: data: allOf: - $ref: "#/components/schemas/SharedIntegrationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SizeSuggestionResource_: properties: data: allOf: - $ref: "#/components/schemas/SizeSuggestionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SlackChannelResource_: properties: data: allOf: - $ref: "#/components/schemas/SlackChannelResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SlackConnectionResource_: properties: data: allOf: - $ref: "#/components/schemas/SlackConnectionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SplitStoryJobResource_: properties: data: allOf: - $ref: "#/components/schemas/SplitStoryJobResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SprintCalendarResource_: properties: data: allOf: - $ref: "#/components/schemas/SprintCalendarResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SprintEntryResource_: properties: data: allOf: - $ref: "#/components/schemas/SprintEntryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SprintResource_: properties: data: allOf: - $ref: "#/components/schemas/SprintResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SsoConfigurationResource_: properties: data: allOf: - $ref: "#/components/schemas/SsoConfigurationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SsoSamlConfigurationResource_: properties: data: allOf: - $ref: "#/components/schemas/SsoSamlConfigurationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_StoryResource_: properties: data: allOf: - $ref: "#/components/schemas/StoryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_StoryReviewFindingResource_: properties: data: allOf: - $ref: "#/components/schemas/StoryReviewFindingResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_StoryReviewResource_: properties: data: allOf: - $ref: "#/components/schemas/StoryReviewResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_StoryWriterConversationResource_: properties: data: allOf: - $ref: "#/components/schemas/StoryWriterConversationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SubscriptionMetadataResource_: properties: data: allOf: - $ref: "#/components/schemas/SubscriptionMetadataResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SubscriptionResource_: properties: data: allOf: - $ref: "#/components/schemas/SubscriptionResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SubtaskResource_: properties: data: allOf: - $ref: "#/components/schemas/SubtaskResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_SyncedJiraSpaceResource_: properties: data: allOf: - $ref: "#/components/schemas/SyncedJiraSpaceResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TagCreationSettingsResource_: properties: data: allOf: - $ref: "#/components/schemas/TagCreationSettingsResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TagResource_: properties: data: allOf: - $ref: "#/components/schemas/TagResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TagValueResource_: properties: data: allOf: - $ref: "#/components/schemas/TagValueResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TeamChangePreviewResultResource_: properties: data: allOf: - $ref: "#/components/schemas/TeamChangePreviewResultResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TeamChannelResource_: properties: data: allOf: - $ref: "#/components/schemas/TeamChannelResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TeamResourceV1_: properties: data: allOf: - $ref: "#/components/schemas/TeamResourceV1" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TeamResource_: properties: data: allOf: - $ref: "#/components/schemas/TeamResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TimeboxResourceV1_: properties: data: allOf: - $ref: "#/components/schemas/TimeboxResourceV1" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TimeboxResource_: properties: data: allOf: - $ref: "#/components/schemas/TimeboxResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TimelineEntryResource_: properties: data: allOf: - $ref: "#/components/schemas/TimelineEntryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_TimelineResource_: properties: data: allOf: - $ref: "#/components/schemas/TimelineResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_UserResourceV1_: properties: data: allOf: - $ref: "#/components/schemas/UserResourceV1" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_UserResource_: properties: data: allOf: - $ref: "#/components/schemas/UserResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_UserSettingEntryResource_: properties: data: allOf: - $ref: "#/components/schemas/UserSettingEntryResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_UserSettingsResource_: properties: data: allOf: - $ref: "#/components/schemas/UserSettingsResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_WorkflowResource_: properties: data: allOf: - $ref: "#/components/schemas/WorkflowResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_WorkflowStepResourceV1_: properties: data: allOf: - $ref: "#/components/schemas/WorkflowStepResourceV1" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_WorkflowStepResource_: properties: data: allOf: - $ref: "#/components/schemas/WorkflowStepResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_WorkspaceIntegrationResource_: properties: data: allOf: - $ref: "#/components/schemas/WorkspaceIntegrationResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SingleResourceBody_WorkspaceResource_: properties: data: allOf: - $ref: "#/components/schemas/WorkspaceResource" description: "The returned resource, based on the request." errors: type: array description: "A list of errors returned with the response, if the request\ \ could not be completed. Each object includes details about a specific\ \ issue." items: $ref: "#/components/schemas/ProblemDetail" description: A problem detail object is a way to convey information about an error that occurred while processing a request. meta: additionalProperties: true description: "Additional contextual information about the response. May\ \ include summary data such as item counts, timestamps, or other calculated\ \ values." included: type: array description: "A list of related resources included in the response, either\ \ automatically by the API or in response to an include parameter in the\ \ request. Each item contains a full resource object (e.g., users, teams,\ \ acceptance criteria)." items: {} links: additionalProperties: type: string format: uri description: "Pagination or navigation links related to the response. May\ \ include keys such as `self`, `next`, `prev`, `first`, or `last`." readOnly: true SizeSuggestion.RequestType: enum: - USER - AUTO SizeSuggestionResource: description: "The returned resource, based on the request." properties: type: type: string pattern: size_suggestion id: type: string format: uuid attributes: $ref: "#/components/schemas/SizeSuggestionResource.Attributes" relationships: $ref: "#/components/schemas/SizeSuggestionResource.Relationships" required: - attributes - id - relationships - type SizeSuggestionResource.Attributes: properties: sizeName: type: string createdAt: type: string format: date-time requestType: $ref: "#/components/schemas/SizeSuggestion.RequestType" required: - createdAt - requestType - sizeName SizeSuggestionResource.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" suggestedSize: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" referenceItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItem - referenceItems - suggestedSize SlackChannelResource: properties: type: type: string pattern: channel id: type: string attributes: $ref: "#/components/schemas/SlackChannelResource.SlackChannelAttributes" relationships: $ref: "#/components/schemas/SlackChannelResource.SlackChannelRelationships" required: - attributes - id - relationships - type SlackChannelResource.SlackChannelAttributes: properties: name: type: string maxLength: 200 minLength: 1 isPrivate: type: boolean isMember: type: boolean required: - isMember - isPrivate - name SlackChannelResource.SlackChannelRelationships: properties: members: $ref: "#/components/schemas/MultipleRelationships" required: - members SlackConnectionCreateResource: properties: type: type: string pattern: slack_connection attributes: $ref: "#/components/schemas/SlackConnectionCreateResource.SlackConnectionAttributes" relationships: $ref: "#/components/schemas/SlackConnectionCreateResource.SlackConnectionRelationships" required: - attributes - relationships - type SlackConnectionCreateResource.SlackConnectionAttributes: properties: reminderTime: type: string format: date-time required: - reminderTime SlackConnectionCreateResource.SlackConnectionRelationships: properties: user: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - user SlackConnectionFilter: properties: userId: type: - string - "null" format: uuid SlackConnectionResource: properties: type: type: string pattern: slack_connection id: type: string attributes: $ref: "#/components/schemas/SlackConnectionResource.SlackConnectionAttributes" relationships: $ref: "#/components/schemas/SlackConnectionResource.SlackConnectionRelationships" meta: $ref: "#/components/schemas/SlackConnectionResource.Metadata" required: - attributes - id - meta - relationships - type SlackConnectionResource.Metadata: properties: allowedActions: type: array items: type: string required: - allowedActions SlackConnectionResource.SlackConnectionAttributes: properties: slackUserId: type: string minLength: 1 slackTeamId: type: string minLength: 1 slackUserName: type: string connected: type: boolean reminderTime: type: string format: date-time required: - connected - reminderTime - slackTeamId - slackUserId - slackUserName SlackConnectionResource.SlackConnectionRelationships: properties: user: $ref: "#/components/schemas/SingleRelationship" required: - user SlackConnectionUpdateResource: properties: type: type: string pattern: slack_connection id: type: string format: uuid attributes: $ref: "#/components/schemas/SlackConnectionUpdateResource.SlackConnectionAttributes" required: - attributes - id - type SlackConnectionUpdateResource.SlackConnectionAttributes: properties: reminderTime: type: string format: date-time required: - reminderTime SlackIntegrationResource: properties: type: type: string pattern: slack_integration id: type: string attributes: $ref: "#/components/schemas/SlackIntegrationResource.Attributes" relationships: $ref: "#/components/schemas/SlackIntegrationResource.SlackIntegrationRelationships" meta: $ref: "#/components/schemas/SlackIntegrationResource.Metadata" required: - attributes - id - meta - relationships - type SlackIntegrationResource.Attributes: properties: slackTeamId: type: string minLength: 1 name: type: string minLength: 1 domain: type: string minLength: 1 required: - domain - name - slackTeamId SlackIntegrationResource.Metadata: properties: allowedActions: type: array items: type: string required: - allowedActions SlackIntegrationResource.SlackIntegrationRelationships: properties: user: $ref: "#/components/schemas/SingleRelationship" required: - user SliceAttributeValueResource: properties: type: type: string pattern: attribute_values id: type: string attributes: $ref: "#/components/schemas/SliceAttributeValueResource.Attributes" relationships: $ref: "#/components/schemas/SliceAttributeValueResource.Relationships" meta: $ref: "#/components/schemas/SliceAttributeValueResource.Metadata" required: - attributes - id - meta - relationships - type SliceAttributeValueResource.Attributes: properties: value: {} required: - value SliceAttributeValueResource.Metadata: properties: evaluationOccurrences: type: integer format: int32 flagOccurrences: type: integer format: int32 lastSeen: type: string format: date-time required: - evaluationOccurrences - flagOccurrences - lastSeen SliceAttributeValueResource.Relationships: properties: environment: $ref: "#/components/schemas/SingleRelationship" required: - environment SliceLocationValueResource: description: "This is the same shape as a SliceAttributeValueResource, but the\ \ \\`value\\` attribute is expanded to define specific fields instead of a\ \ plain object," properties: type: type: string pattern: attribute_values id: type: string attributes: $ref: "#/components/schemas/SliceLocationValueResource.Attributes" relationships: $ref: "#/components/schemas/SliceLocationValueResource.Relationships" meta: $ref: "#/components/schemas/SliceLocationValueResource.Metadata" required: - attributes - id - meta - relationships - type SliceLocationValueResource.Attributes: properties: value: $ref: "#/components/schemas/SliceLocationValueResource.LocationValue" required: - value SliceLocationValueResource.LocationField: properties: name: type: string minLength: 1 isoCode: type: - string - "null" unicodeFlag: type: - string - "null" required: - name SliceLocationValueResource.LocationValue: properties: continent: type: - "null" - object allOf: - $ref: "#/components/schemas/SliceLocationValueResource.LocationField" subcontinent: type: - "null" - object allOf: - $ref: "#/components/schemas/SliceLocationValueResource.LocationField" country: type: - "null" - object allOf: - $ref: "#/components/schemas/SliceLocationValueResource.LocationField" region: type: - "null" - object allOf: - $ref: "#/components/schemas/SliceLocationValueResource.LocationField" required: - continent - country - region - subcontinent SliceLocationValueResource.Metadata: properties: evaluationOccurrences: type: integer format: int32 flagOccurrences: type: integer format: int32 lastSeen: type: string format: date-time required: - evaluationOccurrences - flagOccurrences - lastSeen SliceLocationValueResource.Relationships: properties: environment: $ref: "#/components/schemas/SingleRelationship" required: - environment SplitStoryJobCreationResource: properties: type: type: string pattern: split_story_job attributes: $ref: "#/components/schemas/SplitStoryJobCreationResource.Attributes" relationships: $ref: "#/components/schemas/SplitStoryJobResource.Relationships" required: - attributes - relationships - type SplitStoryJobCreationResource.Attributes: properties: state: $ref: "#/components/schemas/JobRequestState" title: type: string moveAcceptanceCriteria: additionalProperties: type: string content: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. copyAdditionalContent: type: boolean copyGeneralAttachments: type: boolean required: - content - copyAdditionalContent - copyGeneralAttachments - moveAcceptanceCriteria - state - title SplitStoryJobResource: description: "The returned resource, based on the request." properties: type: type: string pattern: split_story_job id: type: string format: uuid attributes: $ref: "#/components/schemas/SplitStoryJobResource.Attributes" relationships: $ref: "#/components/schemas/SplitStoryJobResource.Relationships" meta: $ref: "#/components/schemas/SplitStoryJobResource.Metadata" required: - attributes - id - meta - relationships - type SplitStoryJobResource.Attributes: properties: createdAt: type: string format: date-time title: type: string moveAcceptanceCriteria: additionalProperties: type: string content: type: - array - "null" items: $ref: "#/components/schemas/ContentChunk" description: A segment of content in the description of a story or a bug. copyAdditionalContent: type: boolean copyGeneralAttachments: type: boolean required: - content - copyAdditionalContent - copyGeneralAttachments - createdAt - moveAcceptanceCriteria - title SplitStoryJobResource.Metadata: properties: sideEffects: type: array items: type: string required: - sideEffects SplitStoryJobResource.Relationships: properties: original: $ref: "#/components/schemas/SingleRelationship" created: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - created - original SplitStoryJobUpdateResource: properties: type: type: string pattern: split_story_job id: type: string format: uuid attributes: $ref: "#/components/schemas/SplitStoryJobCreationResource.Attributes" required: - attributes - id - type SprintCalendarController.InclusionType: enum: - STORY_POINT_TOTALS - VELOCITY_PROJECTION SprintCalendarResource: description: "The returned resource, based on the request." properties: type: type: string pattern: sprint_calendar id: type: string format: uuid attributes: $ref: "#/components/schemas/SprintCalendarResource.Attributes" relationships: $ref: "#/components/schemas/SprintCalendarResource.Relationships" required: - attributes - id - relationships - type SprintCalendarResource.Attributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - updatedAt SprintCalendarResource.Relationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" team: $ref: "#/components/schemas/SingleRelationship" sprintEntries: $ref: "#/components/schemas/MultipleRelationships" required: - creator - sprintEntries - team SprintController.InclusionType: enum: - STORY_POINT_TOTALS SprintCreationResource: properties: type: type: string pattern: sprint attributes: $ref: "#/components/schemas/SprintCreationResource.SprintAttributes" relationships: $ref: "#/components/schemas/SprintCreationResource.SprintRelationships" required: - attributes - relationships - type SprintCreationResource.SprintAttributes: properties: name: type: string maxLength: 100 minLength: 1 startDate: type: string format: date-time endDate: type: string format: date-time description: type: string maxLength: 2000 required: - description - endDate - name - startDate SprintCreationResource.SprintRelationships: properties: team: $ref: "#/components/schemas/SingleRelationship" backlogItems: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - team SprintDateCalculator.DurationType: enum: - WEEKDAYS - WEEKS SprintEntryResource: properties: type: type: string pattern: sprint_entry id: type: string format: uuid attributes: $ref: "#/components/schemas/SprintEntryResource.Attributes" relationships: $ref: "#/components/schemas/SprintEntryResource.Relationships" required: - attributes - id - relationships - type SprintEntryResource.Attributes: properties: color: type: string height: type: integer format: int32 position: type: integer format: int32 required: - color - height - position SprintEntryResource.Relationships: properties: sprintCalendar: $ref: "#/components/schemas/SingleRelationship" sprint: $ref: "#/components/schemas/SingleRelationship" required: - sprint - sprintCalendar SprintEntryUpdateResource: properties: type: type: string pattern: sprint_entry id: type: string format: uuid attributes: $ref: "#/components/schemas/SprintEntryUpdateResource.Attributes" required: - attributes - id - type SprintEntryUpdateResource.Attributes: properties: color: type: - string - "null" height: type: - integer - "null" format: int32 required: - color - height SprintResource: properties: type: type: string pattern: sprint id: type: string format: uuid attributes: $ref: "#/components/schemas/SprintResource.SprintAttributes" relationships: $ref: "#/components/schemas/SprintResource.SprintRelationships" meta: $ref: "#/components/schemas/SprintResource.SprintMetadata" required: - attributes - id - meta - relationships - type SprintResource.SprintAttributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string maxLength: 100 minLength: 1 startDate: type: string format: date-time endDate: type: string format: date-time description: type: string maxLength: 2000 required: - createdAt - description - endDate - name - startDate - updatedAt SprintResource.SprintMetadata: properties: storyCount: type: integer format: int64 bugCount: type: integer format: int64 storyPointTotal: type: - integer - "null" format: int64 projectedCapacity: type: - integer - "null" format: int64 allowedActions: type: array items: type: string required: - allowedActions - bugCount - storyCount SprintResource.SprintRelationships: properties: team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" creator: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - creator - team SprintSeriesCreationResource: properties: type: type: string pattern: sprint attributes: $ref: "#/components/schemas/SprintSeriesCreationResource.Attributes" relationships: $ref: "#/components/schemas/SprintSeriesCreationResource.Relationships" required: - attributes - relationships - type SprintSeriesCreationResource.Attributes: properties: firstSprintName: type: string maxLength: 100 minLength: 1 sprintCount: type: integer format: int32 maximum: 52 minimum: 1 firstSprintStartDate: type: string format: date-time durationType: $ref: "#/components/schemas/SprintDateCalculator.DurationType" durationValue: type: integer format: int32 required: - durationType - durationValue - firstSprintName - firstSprintStartDate - sprintCount SprintSeriesCreationResource.Relationships: properties: team: $ref: "#/components/schemas/SingleRelationship" required: - team SprintStoryPointsResponse: properties: snapshots: type: array items: $ref: "#/components/schemas/StoryPointSnapshot" itemsToPush: type: - array - "null" items: $ref: "#/components/schemas/BacklogItemResource" itemsToPull: type: - array - "null" items: $ref: "#/components/schemas/BacklogItemResource" scopeChangeItems: type: array items: $ref: "#/components/schemas/BacklogItemResource" reportTimezone: type: string required: - itemsToPull - itemsToPush - reportTimezone - scopeChangeItems - snapshots SprintUpdateResource: properties: type: type: string pattern: sprint id: type: string format: uuid attributes: $ref: "#/components/schemas/SprintUpdateResource.SprintAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/SprintUpdateResource.SprintRelationships" required: - attributes - id - relationships - type SprintUpdateResource.SprintAttributes: properties: name: type: - string - "null" maxLength: 100 startDate: type: - string - "null" format: date-time endDate: type: - string - "null" format: date-time description: type: - string - "null" maxLength: 2000 required: - description - endDate - name - startDate SprintUpdateResource.SprintRelationships: properties: backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems SsoConfigurationMode: description: "SSO configuration mode. A value between 'INACTIVE', 'TEST', or\ \ 'ACTIVE'." enum: - INACTIVE - TEST - ACTIVE SsoConfigurationResource: description: The configuration for the SSO provider. properties: type: type: string default: sso_configuration description: Identifies the type of resource. defaultValue: sso_configuration id: allOf: - $ref: "#/components/schemas/SsoProtocol" description: |2 Protocol for SSO configuration: - `SAML`: Supports SAML 2.0. attributes: allOf: - $ref: "#/components/schemas/SsoConfigurationResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - id SsoConfigurationResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: loginUrl: type: string format: uri description: URL to use for SSO login mode: allOf: - $ref: "#/components/schemas/SsoConfigurationMode" description: "SSO configuration mode. A value between 'INACTIVE', 'TEST',\ \ or 'ACTIVE'." SsoProtocol: description: |2 Protocol for SSO configuration: - `SAML`: Supports SAML 2.0. enum: - SAML SsoSamlConfigurationResource: description: The configuration for the SSO provider. properties: type: type: string default: sso_configuration description: Identifies the type of resource. defaultValue: sso_configuration id: allOf: - $ref: "#/components/schemas/SsoProtocol" description: |2 Protocol for SSO configuration: - `SAML`: Supports SAML 2.0. attributes: allOf: - $ref: "#/components/schemas/SsoSamlConfigurationResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." meta: allOf: - $ref: "#/components/schemas/SsoSamlConfigurationResource.Metadata" description: "Extra information about the resource, including calculated\ \ values or non-standard fields." required: - id SsoSamlConfigurationResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: loginUrl: type: string format: uri description: URL to use for SSO login providerMetadataUrl: type: string format: uri description: The metadata URL from the IdP for SSO configuration mode: allOf: - $ref: "#/components/schemas/SsoConfigurationMode" description: "SSO configuration mode. A value between 'INACTIVE', 'TEST',\ \ or 'ACTIVE'." SsoSamlConfigurationResource.Metadata: description: "Extra information about the resource, including calculated values\ \ or non-standard fields." properties: setupCompleted: type: boolean samlResponseUrl: type: string format: uri description: URL where the IdP must send the SAML auth response samlAudience: type: string description: Audience for the SAML auth response validation required: - setupCompleted SsoSamlConfigurationUpdateResource: description: The configuration for the SSO provider. properties: type: type: string default: sso_configuration description: Identifies the type of resource. pattern: sso_configuration defaultValue: sso_configuration requiredMode: REQUIRED id: allOf: - $ref: "#/components/schemas/SsoProtocol" description: |2 Protocol for SSO configuration: - `SAML`: Supports SAML 2.0. attributes: allOf: - $ref: "#/components/schemas/SsoSamlConfigurationUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - id - type writeOnly: true SsoSamlConfigurationUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: providerMetadataUrl: type: string format: uri description: The metadata URL from the IdP for SSO configuration requiredMode: REQUIRED mode: type: - "null" - object allOf: - $ref: "#/components/schemas/SsoConfigurationMode" description: "SSO configuration mode. A value between 'INACTIVE', 'TEST',\ \ or 'ACTIVE'." required: - providerMetadataUrl State: description: Represents the state of an entity in the system. enum: - REGULAR - SAMPLE_DATA - JIRA_SYNC x-enum-descriptions: - Regular entity created by users or application - Sample data entity created during trial setup or import. Sample data entities are read-only. - Entity imported via Jira Sync integration. These entities can be synced back to Jira. StepCategory: description: "The category of the workflow step. Valid values are `TODO` (To\ \ do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO` (Won't do).\ \ The category determines the general stage of work items in this step." enum: - TODO - IN_PROGRESS - DONE - WONT_DO StepType: description: "The high-level classification of the workflow step. Determines\ \ the default color shown in the Atono application if no custom color is set,\ \ and helps identify the most appropriate step to move items to when a step\ \ is deleted or the workflow is reset." enum: - TODO - DESIGN - DEV - TEST - REVIEW - DONE - WONTDO - REPORTED - INFO_REQUIRED - CUSTOM StoryContentChunk.ContentChunkType: description: |2 The type of content chunk. - `DISPLAY_HTML`: HTML-formatted content. - `TEXT`: Plain text content. - `PERSONA`: The "As a..." persona from the user story. enum: - DISPLAY_HTML - TEXT - PERSONA StoryController.FetchInclusionType: enum: - ACCEPTANCE_CRITERIA - ASSIGNEE - CREATOR - FEATURE_FLAG - TEAM - WORKFLOW_STEP - FULL_TEXT StoryController.ListInclusionType: enum: - ASSIGNEE - CREATOR - FEATURE_FLAG - TEAM - WORKFLOW_STEP - FULL_TEXT StoryCreateResource: description: "A story represents a piece of planned work in Atono, typically\ \ written from the user's perspective. It includes a user story statement,\ \ acceptance criteria, and optional context to guide implementation or review." properties: type: type: string default: story description: Identifies the type of resource. pattern: story defaultValue: story requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/StoryCreateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/StoryCreateResource.Relationships" description: Contains references to other related resources. required: - attributes - type writeOnly: true StoryCreateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the story. maxLength: 200 minLength: 1 requiredMode: REQUIRED content: type: - array - "null" description: "The user story statement shown at the top of the story (e.g.,\ \ \"As a… I want to… so that…\")." example: "As a user, I want to be able to log in so that I can access my\ \ account." items: $ref: "#/components/schemas/ContentChunk_25" description: A segment of content in the description of a story or a bug. exampleSetFlag: true requiredMode: NOT_REQUIRED additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." items: $ref: "#/components/schemas/ContentChunk_27" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED required: - title StoryCreateResource.Relationships: description: Contains references to other related resources. properties: acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/AcceptanceCriteriaCreationResource" description: "A relationship object linking to the story's acceptance criteria.\ \ The object includes resource identifiers, related links, and metadata." assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: user description: "A relationship object linking to the user assigned to the\ \ story. If `null`, the story is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: team description: "A relationship object linking to the team backlog the story\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the story is in Story refinement\ \ (not assigned to a team)." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: workflow_step description: "A relationship object linking to the workflow step that the\ \ story is currently assigned to. Includes a reference to the workflow\ \ step, along with related links and metadata." epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: epic description: "A relationship object linking to the epic that the story is\ \ associated with. Includes a reference to the epic, along with related\ \ links and metadata. If `null`, the story is not associated with any\ \ epic." StoryPointSnapshot: properties: date: type: string format: date-time totalStoryPoints: type: integer format: int64 remainingPoints: type: integer format: int64 guideLineValue: type: number format: double guideLineDelta: type: number format: double trendLineValue: type: number format: double scopePoints: type: integer format: int64 scopeAdded: type: array items: $ref: "#/components/schemas/ScopeChangeItem" description: Represents a backlog item that was added to or removed from a sprint. Used in burndown chart scope line data. scopeRemoved: type: array items: $ref: "#/components/schemas/ScopeChangeItem" description: Represents a backlog item that was added to or removed from a sprint. Used in burndown chart scope line data. required: - date - guideLineDelta - guideLineValue - remainingPoints - scopeAdded - scopePoints - scopeRemoved - totalStoryPoints - trendLineValue StoryResource: description: "A story represents a piece of planned work in Atono, typically\ \ written from the user's perspective. It includes a user story statement,\ \ acceptance criteria, and optional context to guide implementation or review." properties: type: type: string default: story description: Identifies the type of resource. pattern: story defaultValue: story id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/StoryResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/StoryResource.Relationships" description: Contains references to other related resources. readOnly: true StoryResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the story. handle: type: string description: "A unique identifier for the story, shown in the Atono application\ \ as the item ID (e.g., `STORY-123`)." position: type: integer format: int32 description: "Indicates the story's position within its current workflow\ \ step, where `0` is the topmost item. Position is relative to the step\ \ and team backlog." content: type: - array - "null" description: "The user story statement shown at the top of the story (e.g.,\ \ \"As a… I want to… so that…\")." example: "As a user, I want to be able to log in so that I can access my\ \ account." items: $ref: "#/components/schemas/ContentChunk_17" description: A segment of content in the description of a story or a bug. readOnly: true exampleSetFlag: true additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." items: $ref: "#/components/schemas/ContentChunk_19" description: A segment of content in the description of a story or a bug. readOnly: true cycleTimeMode: allOf: - $ref: "#/components/schemas/BacklogItem.CycleTimeMode" description: "Indicates whether the story is marked as an `OUTLIER` (excluded)\ \ or remains `NORMAL` (included) in average cycle time calculations, reports,\ \ and staleness indicators." stalenessIndicatorSnoozeUntil: type: string format: date-time description: "The date and time until which the staleness indicator is hidden\ \ for this story in its current step and team backlog. Once the date passes,\ \ the indicator is shown again if the story is still stale." createdAt: type: string format: date-time description: The date and time the story was created. updatedAt: type: string format: date-time description: The date and time the story was last updated. doneAt: type: string format: date-time description: The date and time when the story was completed. deleted: type: boolean description: Indicates whether the story has been deleted. StoryResource.Relationships: description: Contains references to other related resources. properties: acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the story's acceptance criteria.\ \ The object includes resource identifiers, related links, and metadata." assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user assigned to the\ \ story. If `null`, the story is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the team backlog the story\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the story is in Story refinement\ \ (not assigned to a team)." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the workflow step that the\ \ story is currently assigned to. Includes a reference to the workflow\ \ step, along with related links and metadata." featureFlag: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the feature flag associated\ \ with the story. Includes a reference to the flag along with related\ \ links and metadata. If `null`, no feature flag is associated with the\ \ story." creator: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user who created the\ \ story. Includes a reference to the user, along with related links and\ \ metadata." attachments: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the story's attachments.\ \ The object includes resource identifiers, related links, and metadata." epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the epic that the story is\ \ associated with. Includes a reference to the epic, along with related\ \ links and metadata. If `null`, the story is not associated with any\ \ epic." StoryReviewCreationResource: properties: type: type: string pattern: story_review attributes: $ref: "#/components/schemas/StoryReviewCreationResource.Attributes" relationships: $ref: "#/components/schemas/StoryReviewCreationResource.Relationships" required: - attributes - relationships - type StoryReviewCreationResource.Attributes: properties: reReview: type: boolean required: - reReview StoryReviewCreationResource.Relationships: properties: story: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - story StoryReviewFindingResource: description: "The returned resource, based on the request." properties: type: type: string pattern: story_review_finding id: type: string format: uuid attributes: $ref: "#/components/schemas/StoryReviewFindingResource.Attributes" required: - attributes - id - type StoryReviewFindingResource.Attributes: properties: status: type: string dimension: type: string severity: type: string summary: type: string detail: type: string suggestedAction: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - detail - dimension - severity - status - suggestedAction - summary - updatedAt StoryReviewFindingUpdateResource: properties: type: type: string pattern: story_review_finding id: type: string format: uuid attributes: $ref: "#/components/schemas/StoryReviewFindingUpdateResource.Attributes" required: - attributes - id - type StoryReviewFindingUpdateResource.Attributes: properties: status: type: string minLength: 1 required: - status StoryReviewResource: description: "The returned resource, based on the request." properties: type: type: string pattern: story_review id: type: string format: uuid attributes: $ref: "#/components/schemas/StoryReviewResource.Attributes" relationships: $ref: "#/components/schemas/StoryReviewResource.Relationships" required: - attributes - id - relationships - type StoryReviewResource.Attributes: properties: status: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - status - updatedAt StoryReviewResource.Relationships: properties: story: $ref: "#/components/schemas/SingleRelationship" findings: $ref: "#/components/schemas/MultipleRelationships" createdBy: $ref: "#/components/schemas/SingleRelationship" required: - createdBy - findings - story StoryUpdateResource: description: "A story represents a piece of planned work in Atono, typically\ \ written from the user's perspective. It includes a user story statement,\ \ acceptance criteria, and optional context to guide implementation or review." properties: type: type: string default: story description: Identifies the type of resource. pattern: story defaultValue: story requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/StoryUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/StoryUpdateResource.Relationships" description: Contains references to other related resources. required: - id - type writeOnly: true StoryUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: - string - "null" description: The title of the story. maxLength: 200 requiredMode: NOT_REQUIRED content: type: - array - "null" description: "The user story statement shown at the top of the story (e.g.,\ \ \"As a… I want to… so that…\")." example: "As a user, I want to be able to log in so that I can access my\ \ account." items: $ref: "#/components/schemas/ContentChunk_29" description: A segment of content in the description of a story or a bug. exampleSetFlag: true requiredMode: NOT_REQUIRED additionalContent: type: - array - "null" description: "Optional notes added below the acceptance criteria, often\ \ used for background info, technical notes, decisions, or context for\ \ the team." items: $ref: "#/components/schemas/ContentChunk_31" description: A segment of content in the description of a story or a bug. requiredMode: NOT_REQUIRED StoryUpdateResource.Relationships: description: Contains references to other related resources. properties: acceptanceCriteria: type: - "null" - object allOf: - $ref: "#/components/schemas/AcceptanceCriteriaReplaceResource" description: "A relationship object linking to the story's acceptance criteria.\ \ The object includes resource identifiers, related links, and metadata." assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: user description: "A relationship object linking to the user assigned to the\ \ story. If `null`, the story is currently unassigned. Includes a reference\ \ to the user and optional related links and metadata." team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: team description: "A relationship object linking to the team backlog the story\ \ is currently assigned to. Includes a reference to the team, along with\ \ related links and metadata. If `null`, the story is in Story refinement\ \ (not assigned to a team)." workflowStep: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: workflow_step description: "A relationship object linking to the workflow step that the\ \ story is currently assigned to. Includes a reference to the workflow\ \ step, along with related links and metadata." linkedItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" default: data: - type: story id: 00000000-0000-0000-0000-000000000000 description: A relationship object linking to the story's linked items. epic: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" default: type: epic description: "A relationship object linking to the epic that the story is\ \ associated with. Includes a reference to the epic, along with related\ \ links and metadata. If `null`, the story is not associated with any\ \ epic." StoryWriterController.RequestFilter: properties: storyId: type: string format: uuid required: - storyId StoryWriterConversation.CompactionStatus: properties: totalTokenCount: type: integer format: int32 reachedWarnThreshold: type: boolean required: - reachedWarnThreshold - totalTokenCount StoryWriterConversationCreationResource: properties: type: type: string pattern: story_writer_conversation attributes: $ref: "#/components/schemas/StoryWriterConversationCreationResource.Attributes" relationships: $ref: "#/components/schemas/StoryWriterConversationCreationResource.Relationships" required: - attributes - relationships - type StoryWriterConversationCreationResource.Attributes: properties: userMessage: type: string maxLength: 2000 action: type: string maxLength: 100 arguments: type: string maxLength: 2000 required: - action - arguments - userMessage StoryWriterConversationCreationResource.Relationships: properties: story: $ref: "#/components/schemas/SingleRelationshipUpdate" draft: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItemCreationResource" required: - draft - story StoryWriterConversationResource: description: "The returned resource, based on the request." properties: type: type: string pattern: story_writer_conversation id: type: string format: uuid attributes: $ref: "#/components/schemas/StoryWriterConversationResource.Attributes" relationships: $ref: "#/components/schemas/StoryWriterConversationResource.Relationships" required: - attributes - id - relationships - type StoryWriterConversationResource.Attributes: properties: userMessage: type: string botMessage: type: string action: type: string arguments: type: string choices: type: array items: type: string suggestedTitle: type: string suggestedStory: $ref: "#/components/schemas/StoryWriterConversationResult.SuggestedStory" suggestedAcceptanceCriteria: type: array items: $ref: "#/components/schemas/StoryWriterConversationResult.SuggestedAcceptanceCriterion" structuredQuestions: type: array items: $ref: "#/components/schemas/StoryWriterConversationResult.StructuredQuestion" designNotesUpdate: type: string needsCompaction: type: boolean compactionStatus: $ref: "#/components/schemas/StoryWriterConversation.CompactionStatus" required: - action - arguments - botMessage - choices - compactionStatus - designNotesUpdate - needsCompaction - structuredQuestions - suggestedAcceptanceCriteria - suggestedStory - suggestedTitle - userMessage StoryWriterConversationResource.Relationships: properties: story: $ref: "#/components/schemas/SingleRelationship" referencedStories: $ref: "#/components/schemas/MultipleRelationships" required: - referencedStories - story StoryWriterConversationResult.StructuredQuestion: properties: question: type: string multipleChoice: type: boolean answers: type: array items: type: string required: - answers - multipleChoice - question StoryWriterConversationResult.SuggestedAcceptanceCriterion: properties: id: type: - string - "null" format: uuid description: type: string position: type: integer format: int32 level: type: integer format: int32 required: - description - level - position StoryWriterConversationResult.SuggestedStory: properties: text: type: string persona: type: string required: - persona - text Subscription.SubscribedItem: properties: id: type: string productId: type: string priceId: type: string quantity: type: integer format: int64 recurringInterval: type: string recurringIntervalCount: type: integer format: int64 required: - id - priceId - productId - quantity - recurringInterval - recurringIntervalCount Subscription.SubscriptionStatus: enum: - ACTIVE - CANCELED Subscription.SubscriptionTier: enum: - INTERNAL - TRIAL - FREE - STARTER - BUSINESS - ENTERPRISE SubscriptionController.ProductInclusionType: enum: - DEFAULT_PRICE - ACTIVE_PRICES SubscriptionController.SubscriptionInclusionType: enum: - PRODUCT - PRICE SubscriptionItemResource: properties: type: type: string pattern: subscription_item id: type: string attributes: $ref: "#/components/schemas/SubscriptionItemResource.Attributes" relationships: $ref: "#/components/schemas/SubscriptionItemResource.Relationships" required: - attributes - id - relationships - type SubscriptionItemResource.Attributes: properties: productId: type: string priceId: type: string quantity: type: integer format: int64 recurringInterval: type: string recurringIntervalCount: type: integer format: int64 required: - priceId - productId - quantity - recurringInterval - recurringIntervalCount SubscriptionItemResource.Relationships: properties: subscription: $ref: "#/components/schemas/SingleRelationship" required: - subscription SubscriptionItemUpdateResource: properties: type: type: string pattern: subscription_item attributes: $ref: "#/components/schemas/SubscriptionItemUpdateResource.Attributes" required: - attributes - type SubscriptionItemUpdateResource.Attributes: properties: priceId: type: string quantity: type: integer format: int64 required: - priceId - quantity SubscriptionMetadataResource: description: "The returned resource, based on the request." properties: type: type: string pattern: subscription_metadata attributes: $ref: "#/components/schemas/SubscriptionMetadataResource.SubscriptionMetadataAttributes" required: - attributes - type SubscriptionMetadataResource.SubscriptionMetadataAttributes: properties: featureMaxStorage: type: integer format: int64 trialPeriodDays: type: integer format: int64 trialUserSeats: type: integer format: int64 required: - featureMaxStorage - trialPeriodDays - trialUserSeats SubscriptionPrice.Recurring: properties: interval: type: string intervalCount: type: integer format: int64 required: - interval - intervalCount SubscriptionPrice.Tier: properties: flatAmount: type: integer format: int64 flatAmountDecimal: type: number unitAmount: type: integer format: int64 unitAmountDecimal: type: number upTo: type: integer format: int64 required: - flatAmount - flatAmountDecimal - unitAmount - unitAmountDecimal - upTo SubscriptionProduct.ProductType: enum: - BASE - ADDON SubscriptionResource: properties: type: type: string pattern: subscription id: type: string format: uuid attributes: $ref: "#/components/schemas/SubscriptionResource.SubscriptionAttributes" relationships: $ref: "#/components/schemas/SubscriptionResource.SubscriptionRelationships" required: - attributes - id - relationships - type SubscriptionResource.SubscriptionAttributes: properties: subscriptionId: type: string subscriptionTier: $ref: "#/components/schemas/Subscription.SubscriptionTier" subscriptionStatus: $ref: "#/components/schemas/Subscription.SubscriptionStatus" customerId: type: string trialCount: type: integer format: int32 startDate: type: string format: date-time endDate: type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time entitledUserSeats: type: integer format: int32 entitledStorage: type: integer format: int64 entitledCapyUsage: type: integer format: int32 entitledActiveItemCount: type: integer format: int32 items: type: array items: $ref: "#/components/schemas/Subscription.SubscribedItem" required: - createdAt - customerId - endDate - entitledActiveItemCount - entitledCapyUsage - entitledStorage - entitledUserSeats - items - startDate - subscriptionId - subscriptionStatus - subscriptionTier - trialCount - updatedAt SubscriptionResource.SubscriptionRelationships: properties: workspace: $ref: "#/components/schemas/SingleRelationship" products: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" prices: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" subscriptionItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - prices - products - subscriptionItems - workspace Subtask.Step: description: "The current completion step of the subtask. One of `TODO`, `IN_PROGRESS`,\ \ `DONE`, or `WONT_DO`." enum: - TODO - IN_PROGRESS - DONE - WONT_DO SubtaskChangeSet: properties: id: type: string format: uuid state: $ref: "#/components/schemas/SubtaskChangeSet.State" title: $ref: "#/components/schemas/TextFieldChangeSet" step: $ref: "#/components/schemas/SimpleFieldChangeSet_Subtask.Step_" assignee: $ref: "#/components/schemas/SimpleFieldChangeSet_UUID_" required: - assignee - id - state - step - title SubtaskChangeSet.State: enum: - CREATE - DELETE - UPDATE SubtaskController.InclusionType: enum: - ASSIGNEE SubtaskCreateResource: description: A subtask is a small unit of work nested within a story or bug. properties: type: type: string default: subtask description: Identifies the type of resource. pattern: subtask defaultValue: subtask requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/SubtaskCreateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/SubtaskCreateResource.Relationships" description: Contains references to other related resources. required: - attributes - type writeOnly: true SubtaskCreateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the subtask. maxLength: 200 minLength: 1 requiredMode: REQUIRED description: type: - string - "null" description: An optional description providing additional detail about the subtask. requiredMode: NOT_REQUIRED step: type: - "null" - object allOf: - $ref: "#/components/schemas/Subtask.Step" description: "The current completion step of the subtask. One of `TODO`,\ \ `IN_PROGRESS`, `DONE`, or `WONT_DO`." position: type: - integer - "null" format: int32 description: "The subtask's position within its parent backlog item, where\ \ `0` is the topmost item." minimum: 0 requiredMode: NOT_REQUIRED required: - title SubtaskCreateResource.Relationships: description: Contains references to other related resources. properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" description: "A relationship object linking to the user assigned to the\ \ subtask. If `null`, the subtask is currently unassigned." SubtaskCreationResource: properties: type: type: string pattern: subtask attributes: $ref: "#/components/schemas/SubtaskCreationResource.SubtaskAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/SubtaskCreationResource.SubtaskRelationships" required: - attributes - relationships - type writeOnly: true SubtaskCreationResource.SubtaskAttributes: properties: title: type: string maxLength: 200 minLength: 1 description: type: - string - "null" step: type: - "null" - object allOf: - $ref: "#/components/schemas/Subtask.Step" position: type: - integer - "null" format: int32 minimum: 0 required: - position - step - title SubtaskCreationResource.SubtaskRelationships: properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" required: - assignee SubtaskResource: description: A subtask is a small unit of work nested within a story or bug. properties: type: type: string default: subtask description: Identifies the type of resource. pattern: subtask defaultValue: subtask id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/SubtaskResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/SubtaskResource.Relationships" description: Contains references to other related resources. readOnly: true SubtaskResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: title: type: string description: The title of the subtask. description: type: - string - "null" description: An optional description providing additional detail about the subtask. step: allOf: - $ref: "#/components/schemas/Subtask.Step" description: "The current completion step of the subtask. One of `TODO`,\ \ `IN_PROGRESS`, `DONE`, or `WONT_DO`." position: type: integer format: int32 description: "The subtask's position within its parent backlog item, where\ \ `0` is the topmost item." createdAt: type: string format: date-time description: The date and time the subtask was created. updatedAt: type: string format: date-time description: The date and time the subtask was last updated. SubtaskResource.Relationships: description: Contains references to other related resources. properties: backlogItem: allOf: - $ref: "#/components/schemas/SingleRelationship" description: A relationship object linking to the parent story or bug this subtask belongs to. assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the user assigned to the\ \ subtask. If `null`, the subtask is currently unassigned." SubtaskSnapshot: description: A shortened self-contained version of the Subtask to store a snapshot of the subtask at a point in time. The main purpose is to isolate the API DTO object from ever using DB access objects directly. properties: id: type: string format: uuid title: type: string step: $ref: "#/components/schemas/Subtask.Step" assigneeId: type: string format: uuid required: - assigneeId - id - step - title SubtaskUpdateResource: description: A subtask is a small unit of work nested within a story or bug. properties: type: type: string default: subtask description: Identifies the type of resource. pattern: subtask defaultValue: subtask requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/SubtaskUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps. Fields that are not specified\ \ in the request will not be updated. To remove a relationship, set its\ \ `data` field to `null`." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/SubtaskUpdateResource.Relationships" description: "Contains references to other related resources. Fields that\ \ are not specified in the request will not be updated. To remove a relationship,\ \ set its `data` field to `null`." required: - id - type writeOnly: true SubtaskUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps. Fields that are not specified\ \ in the request will not be updated. To remove a relationship, set its `data`\ \ field to `null`." properties: title: type: - string - "null" description: The title of the subtask. maxLength: 200 requiredMode: NOT_REQUIRED description: type: - string - "null" description: An optional description providing additional detail about the subtask. requiredMode: NOT_REQUIRED step: type: - "null" - object allOf: - $ref: "#/components/schemas/Subtask.Step" description: "The current completion step of the subtask. One of `TODO`,\ \ `IN_PROGRESS`, `DONE`, or `WONT_DO`." position: type: - integer - "null" format: int32 description: "The subtask's position within its parent backlog item, where\ \ `0` is the topmost item." minimum: 0 requiredMode: NOT_REQUIRED SubtaskUpdateResource.Relationships: description: "Contains references to other related resources. Fields that are\ \ not specified in the request will not be updated. To remove a relationship,\ \ set its `data` field to `null`." properties: assignee: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" description: "A relationship object linking to the user assigned to the\ \ subtask. If `null`, the subtask is currently unassigned." SyncedJiraSpaceCreateResource: properties: type: type: string pattern: synced_jira_space attributes: $ref: "#/components/schemas/SyncedJiraSpaceCreateResource.Attributes" relationships: $ref: "#/components/schemas/SyncedJiraSpaceCreateResource.Relationships" required: - attributes - relationships - type SyncedJiraSpaceCreateResource.Attributes: properties: jiraSpaceId: type: string minLength: 1 jiraSpaceKey: type: string minLength: 1 jiraSpaceName: type: string minLength: 1 required: - jiraSpaceId - jiraSpaceKey - jiraSpaceName SyncedJiraSpaceCreateResource.Relationships: properties: team: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - team SyncedJiraSpaceResource: properties: type: type: string pattern: synced_jira_space id: type: string format: uuid attributes: $ref: "#/components/schemas/SyncedJiraSpaceResource.Attributes" relationships: $ref: "#/components/schemas/SyncedJiraSpaceResource.Relationships" required: - attributes - id - relationships - type SyncedJiraSpaceResource.Attributes: properties: jiraSpaceId: type: string jiraSpaceKey: type: string jiraSpaceName: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - jiraSpaceId - jiraSpaceKey - jiraSpaceName - updatedAt SyncedJiraSpaceResource.Relationships: properties: team: $ref: "#/components/schemas/SingleRelationship" required: - team SyncedJiraSpaceUpdateResource: properties: type: type: string pattern: synced_jira_space id: type: string format: uuid relationships: $ref: "#/components/schemas/SyncedJiraSpaceUpdateResource.Relationships" required: - id - relationships - type SyncedJiraSpaceUpdateResource.Relationships: properties: team: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - team Tag.DefaultSort: enum: - ALPHABETICAL - RECENTLY_USED - MANUAL Tag.TagScope: enum: - WORKSPACE - TEAM TagController.InclusionType: enum: - CREATOR - TAG_VALUES - TEAM TagController.RequestFilter: properties: autocomplete: type: - string - "null" keyword: type: - string - "null" scope: type: - "null" - object allOf: - $ref: "#/components/schemas/TagScopeFilter" teamId: type: - string - "null" format: uuid TagCreationMode: enum: - UNRESTRICTED - KEY_CREATORS - KEY_AND_VALUE_CREATORS TagCreationResource: properties: type: type: string pattern: tag attributes: $ref: "#/components/schemas/TagCreationResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TagCreationResource.Relationships" required: - attributes - type TagCreationResource.Attributes: properties: key: type: string maxLength: 32 minLength: 1 description: type: - string - "null" maxLength: 255 values: type: - array - "null" items: type: string maxLength: 32 defaultSort: type: - "null" - object allOf: - $ref: "#/components/schemas/Tag.DefaultSort" allowMultipleValues: type: - boolean - "null" required: - allowMultipleValues - defaultSort - description - key TagCreationResource.Relationships: properties: initialBacklogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - initialBacklogItems - team TagCreationSettingsResource: description: "The returned resource, based on the request." properties: type: type: string pattern: tag_creation_settings id: type: string attributes: $ref: "#/components/schemas/TagCreationSettingsResource.Attributes" relationships: $ref: "#/components/schemas/TagCreationSettingsResource.Relationships" required: - attributes - id - relationships - type TagCreationSettingsResource.Attributes: properties: tagCreationMode: $ref: "#/components/schemas/TagCreationMode" required: - tagCreationMode TagCreationSettingsResource.Relationships: properties: tagCreators: $ref: "#/components/schemas/MultipleRelationships" tagValueCreators: $ref: "#/components/schemas/MultipleRelationships" required: - tagCreators - tagValueCreators TagCreationSettingsUpdateResource: properties: type: type: string pattern: tag_creation_settings id: type: string attributes: $ref: "#/components/schemas/TagCreationSettingsUpdateResource.Attributes" required: - attributes - id - type TagCreationSettingsUpdateResource.Attributes: properties: tagCreationMode: type: - "null" - object allOf: - $ref: "#/components/schemas/TagCreationMode" required: - tagCreationMode TagResource: properties: type: type: string pattern: tag id: type: string attributes: $ref: "#/components/schemas/TagResource.Attributes" relationships: $ref: "#/components/schemas/TagResource.Relationships" meta: $ref: "#/components/schemas/TagResource.Meta" required: - attributes - id - meta - relationships - type TagResource.Attributes: properties: key: type: string description: type: - string - "null" createdAt: type: string format: date-time lastUsedAt: type: - string - "null" format: date-time defaultSort: $ref: "#/components/schemas/Tag.DefaultSort" scope: $ref: "#/components/schemas/Tag.TagScope" allowMultipleValues: type: boolean required: - allowMultipleValues - createdAt - defaultSort - key - scope TagResource.Match: properties: field: type: string match: type: string required: - field - match TagResource.Meta: properties: itemCount: type: - integer - "null" format: int32 keyword: type: - "null" - object additionalProperties: type: array items: $ref: "#/components/schemas/TagResource.Match" TagResource.Relationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" tagValues: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - creator - tagValues - team TagScopeFilter: enum: - WORKSPACE - TEAM - WORKSPACE_AND_TEAM TagSuggestionController.RequestFilter: properties: scope: type: - "null" - object allOf: - $ref: "#/components/schemas/TagScopeFilter" teamId: type: - string - "null" format: uuid TagSuggestionResource: description: JSON API resource for tag suggestions. properties: type: type: string pattern: tag_suggestion id: type: string attributes: $ref: "#/components/schemas/TagSuggestionResource.Attributes" required: - attributes - id - type TagSuggestionResource.Attributes: properties: tagId: type: string tagValueId: type: string text: type: string suggestionType: type: string matchType: type: string score: type: number format: double required: - matchType - score - suggestionType - tagId - tagValueId - text TagUpdateResource: properties: type: type: string pattern: tag id: type: string attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TagUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TagUpdateResource.Relationships" required: - attributes - id - relationships - type TagUpdateResource.Attributes: properties: key: type: - string - "null" maxLength: 32 minLength: 1 description: type: - string - "null" maxLength: 255 defaultSort: type: - "null" - object allOf: - $ref: "#/components/schemas/Tag.DefaultSort" allowMultipleValues: type: - boolean - "null" required: - allowMultipleValues - defaultSort - description - key TagUpdateResource.Relationships: properties: transitionTagValue: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" required: - transitionTagValue TagValueController.InclusionType: enum: - CREATOR TagValueController.RequestFilter: properties: autocomplete: type: - string - "null" TagValueCreationResource: properties: type: type: string pattern: tag_value attributes: $ref: "#/components/schemas/TagValueCreationResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TagValueCreationResource.Relationships" required: - attributes - type TagValueCreationResource.Attributes: properties: value: type: string maxLength: 32 minLength: 1 required: - value TagValueCreationResource.Relationships: properties: backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - backlogItems TagValueResource: properties: type: type: string pattern: tag_value id: type: string attributes: $ref: "#/components/schemas/TagValueResource.TagValueAttributes" relationships: $ref: "#/components/schemas/TagValueResource.TagValueRelationships" meta: $ref: "#/components/schemas/TagValueResource.TagValueMeta" required: - attributes - id - meta - relationships - type TagValueResource.TagValueAttributes: properties: value: type: string position: type: integer format: int32 createdAt: type: string format: date-time lastUsedAt: type: - string - "null" format: date-time required: - createdAt - position - value TagValueResource.TagValueMeta: properties: itemCount: type: - integer - "null" format: int32 itemStats: additionalProperties: type: integer format: int32 required: - itemStats TagValueResource.TagValueRelationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" tag: $ref: "#/components/schemas/SingleRelationship" backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - creator - tag TagValueUpdateResource: properties: type: type: string pattern: tag_value id: type: string attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TagValueUpdateResource.Attributes" required: - attributes - id - type TagValueUpdateResource.Attributes: properties: value: type: - string - "null" maxLength: 32 minLength: 1 position: type: - integer - "null" format: int32 minimum: 0 required: - position - value Team.CycleTimeAveragingMode: enum: - DEFAULT - RANGE - FIXED_DATE Team.CycleTimeConfig: properties: averagingMode: $ref: "#/components/schemas/Team.CycleTimeAveragingMode" monthRange: type: integer format: int32 fromDate: type: string format: date-time required: - averagingMode - fromDate - monthRange Team.Status: enum: - ACTIVE - INACTIVE TeamChangePreviewResource: description: JSON:API request resource for the team change preview endpoint. Used to preview which tags will be retained or dropped when a backlog item is reassigned to a different team. properties: type: type: string pattern: team_change_preview relationships: $ref: "#/components/schemas/TeamChangePreviewResource.Relationships" required: - relationships - type TeamChangePreviewResource.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" team: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - backlogItem - team TeamChangePreviewResultResource: description: "The returned resource, based on the request." properties: type: type: string pattern: team_change_preview id: type: string attributes: $ref: "#/components/schemas/TeamChangePreviewResultResource.Attributes" relationships: $ref: "#/components/schemas/TeamChangePreviewResultResource.Relationships" required: - attributes - id - relationships - type TeamChangePreviewResultResource.Attributes: properties: matchedTags: type: array items: $ref: "#/components/schemas/TeamChangePreviewResultResource.TagInfo" description: Summary information about a tag and its value. droppedTags: type: array items: $ref: "#/components/schemas/TeamChangePreviewResultResource.TagInfo" description: Summary information about a tag and its value. required: - droppedTags - matchedTags TeamChangePreviewResultResource.Relationships: properties: backlogItem: $ref: "#/components/schemas/SingleRelationship" team: $ref: "#/components/schemas/SingleRelationship" required: - backlogItem - team TeamChangePreviewResultResource.TagInfo: description: Summary information about a tag and its value. properties: tagId: type: string tagKey: type: string tagValueId: type: string tagValue: type: string required: - tagId - tagKey - tagValue - tagValueId TeamChannelCreateResource: properties: type: type: string pattern: team_channel attributes: $ref: "#/components/schemas/TeamChannelCreateResource.TeamChannelAttributes" relationships: $ref: "#/components/schemas/TeamChannelCreateResource.TeamChannelRelationships" required: - attributes - relationships - type TeamChannelCreateResource.TeamChannelAttributes: properties: slackChannelId: type: - string - "null" maxLength: 80 slackChannelName: type: - string - "null" maxLength: 80 required: - slackChannelId - slackChannelName TeamChannelCreateResource.TeamChannelRelationships: properties: team: $ref: "#/components/schemas/SingleRelationshipUpdate" required: - team TeamChannelFilter: properties: teamId: type: - string - "null" format: uuid TeamChannelMemberResource: properties: type: type: string pattern: user id: type: string format: uuid meta: $ref: "#/components/schemas/TeamChannelMemberResource.Metadata" required: - id - meta - type TeamChannelMemberResource.Metadata: properties: isChannelMember: type: boolean hasSlackConnection: type: boolean required: - hasSlackConnection - isChannelMember TeamChannelResource: properties: type: type: string pattern: team_channel id: type: string attributes: $ref: "#/components/schemas/TeamChannelResource.TeamChannelAttributes" relationships: $ref: "#/components/schemas/TeamChannelResource.TeamChannelRelationships" meta: $ref: "#/components/schemas/TeamChannelResource.TeamChannelMetadata" required: - attributes - id - meta - relationships - type TeamChannelResource.TeamChannelAttributes: properties: slackChannelId: type: string minLength: 1 slackChannelUrl: type: string required: - slackChannelId - slackChannelUrl TeamChannelResource.TeamChannelMetadata: properties: allowedActions: type: array items: type: string required: - allowedActions TeamChannelResource.TeamChannelRelationships: properties: team: $ref: "#/components/schemas/SingleRelationship" members: $ref: "#/components/schemas/MultipleRelationships" required: - members - team TeamChannelUpdateResource: properties: type: type: string pattern: team_channel id: type: string format: uuid attributes: $ref: "#/components/schemas/TeamChannelUpdateResource.TeamChannelAttributes" required: - attributes - id - type TeamChannelUpdateResource.TeamChannelAttributes: properties: slackChannelId: type: - string - "null" maxLength: 80 slackChannelName: type: - string - "null" maxLength: 80 required: - slackChannelId - slackChannelName TeamController.InclusionType: enum: - MEMBERS - ADMINS - BACKLOG_OWNERS - TEAM_CHANNEL - SPRINTS TeamController.ListInclusionType: enum: - MEMBERS - ADMINS - BACKLOG_OWNERS TeamController.TimezoneInfo: properties: zoneId: type: string displayName: type: string offset: type: string region: type: string required: - displayName - offset - region - zoneId TeamCreateResourceV1: description: "A team represents a group of people responsible for delivering\ \ and supporting work in Atono. Each team has its own backlog, workflow, and\ \ membership, and may be linked to a Slack channel for communication." properties: type: type: string default: team description: Identifies the type of resource. minLength: 1 pattern: team defaultValue: team requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/TeamCreateResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamCreateResourceV1.Relationships" description: Contains references to other related resources. required: - attributes - type writeOnly: true TeamCreateResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: The name of the team. maxLength: 200 minLength: 1 requiredMode: REQUIRED description: type: - string - "null" description: The description of the team. maxLength: 2000 requiredMode: NOT_REQUIRED isPublic: type: - boolean - "null" description: Indicates whether access to the team’s backlog is public (`true`) or private (`false`). requiredMode: NOT_REQUIRED backlogManagementByOwners: type: - boolean - "null" description: "Indicates whether backlog management is enabled for the team\ \ (`true`) or not (`false`). When enabled, the team's backlog managers\ \ are responsible for managing stories in the 'To do' and 'Won't do' categories\ \ of the workflow." requiredMode: NOT_REQUIRED timezone: type: - string - "null" description: "The IANA timezone identifier for the team (e.g., 'America/New_York',\ \ 'Europe/London'). This timezone is used for date calculations and display.\ \ If not specified, defaults to 'US/Pacific'." maxLength: 255 requiredMode: NOT_REQUIRED required: - name TeamCreateResourceV1.Relationships: description: Contains references to other related resources. properties: members: allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" description: "A relationship object linking to the users added to the team\ \ as members. Includes references to the users, along with related links\ \ and metadata. This does not include users with team roles such as team\ \ admins or backlog owners, unless they are also explicitly added as members\ \ of the team." required: - members TeamCreationResource: properties: type: type: string pattern: team attributes: $ref: "#/components/schemas/TeamCreationResource.TeamAttributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamCreationResource.TeamRelationships" required: - attributes - relationships - type TeamCreationResource.TeamAttributes: properties: name: type: string maxLength: 200 minLength: 1 description: type: - string - "null" maxLength: 2000 isPublic: type: - boolean - "null" backlogManagementByOwners: type: - boolean - "null" workflowType: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkflowType" timezone: type: - string - "null" maxLength: 255 required: - backlogManagementByOwners - description - isPublic - name - timezone - workflowType TeamCreationResource.TeamRelationships: properties: members: $ref: "#/components/schemas/MultipleRelationshipsUpdate" required: - members TeamDeletionRequest.BacklogItemOption: enum: - NO_ACTION - MOVE_TO_UNASSIGNED - SET_TO_WONTDO - NUKE_ALL TeamDeletionResource: properties: type: type: string pattern: team id: type: string format: uuid attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamDeletionResource.Attributes" required: - attributes - id - type TeamDeletionResource.Attributes: properties: backlogItemOption: $ref: "#/components/schemas/TeamDeletionRequest.BacklogItemOption" required: - backlogItemOption TeamFilter: properties: memberId: type: - string - "null" format: uuid memberOrAdminId: type: - string - "null" format: uuid teams: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamsType" TeamResource: properties: type: type: string pattern: team id: type: string format: uuid attributes: $ref: "#/components/schemas/TeamResource.TeamAttributes" relationships: $ref: "#/components/schemas/TeamResource.TeamRelationships" meta: $ref: "#/components/schemas/TeamResource.TeamMetadata" required: - attributes - id - meta - relationships - type TeamResource.TeamAttributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string maxLength: 200 minLength: 1 description: type: - string - "null" maxLength: 2000 status: $ref: "#/components/schemas/Team.Status" isPublic: type: boolean backlogManagementByOwners: type: boolean workflowType: $ref: "#/components/schemas/WorkflowType" cycleTimeConfig: $ref: "#/components/schemas/Team.CycleTimeConfig" timezone: type: string required: - backlogManagementByOwners - createdAt - cycleTimeConfig - description - isPublic - name - status - timezone - updatedAt - workflowType TeamResource.TeamMetadata: properties: state: $ref: "#/components/schemas/State" allowedActions: type: array items: type: string required: - allowedActions - state TeamResource.TeamRelationships: properties: members: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" admins: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" backlogOwners: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" channel: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" workflow: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" sprintCalendar: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" sprints: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - admins - backlogOwners - channel - members - sprintCalendar - sprints - workflow TeamResourceV1: description: "A team represents a group of people responsible for delivering\ \ and supporting work in Atono. Each team has its own backlog, workflow, and\ \ membership, and may be linked to a Slack channel for communication." properties: type: type: string default: team description: Identifies the type of resource. pattern: team defaultValue: team id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/TeamResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/TeamResourceV1.Relationships" description: Contains references to other related resources. readOnly: true TeamResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: The name of the team. description: type: string description: The description of the team. createdAt: type: string format: date-time description: The date and time the team was created. updatedAt: type: string format: date-time description: The date and time the team was last updated. isPublic: type: boolean description: Indicates whether access to the team’s backlog is public (`true`) or private (`false`). backlogManagementByOwners: type: boolean description: "Indicates whether backlog management is enabled for the team\ \ (`true`) or not (`false`). When enabled, the team's backlog managers\ \ are responsible for managing stories in the 'To do' and 'Won't do' categories\ \ of the workflow." timezone: type: string description: "The IANA timezone identifier for the team (e.g., 'America/New_York',\ \ 'Europe/London'). This timezone is used for date calculations and display.\ \ If not specified, defaults to 'US/Pacific'." TeamResourceV1.Relationships: description: Contains references to other related resources. properties: members: allOf: - $ref: "#/components/schemas/MultipleRelationships" description: "A relationship object linking to the users added to the team\ \ as members. Includes references to the users, along with related links\ \ and metadata. This does not include users with team roles such as team\ \ admins or backlog owners, unless they are also explicitly added as members\ \ of the team." channel: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" description: "A relationship object linking to the Slack channel associated\ \ with the team. Includes a reference to the channel, along with related\ \ links and metadata." TeamUpdateResource: properties: type: type: string pattern: team id: type: string format: uuid attributes: $ref: "#/components/schemas/TeamUpdateResource.TeamAttributes" required: - attributes - id - type TeamUpdateResource.TeamAttributes: properties: name: type: - string - "null" maxLength: 200 description: type: - string - "null" maxLength: 2000 isPublic: type: - boolean - "null" backlogManagementByOwners: type: - boolean - "null" cycleTimeConfig: type: - "null" - object allOf: - $ref: "#/components/schemas/Team.CycleTimeConfig" workflowType: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkflowType" timezone: type: - string - "null" maxLength: 255 required: - backlogManagementByOwners - cycleTimeConfig - description - isPublic - name - timezone - workflowType TeamUpdateResourceV1: description: "A team represents a group of people responsible for delivering\ \ and supporting work in Atono. Each team has its own backlog, workflow, and\ \ membership, and may be linked to a Slack channel for communication." properties: type: type: string default: team description: Identifies the type of resource. minLength: 1 pattern: team defaultValue: team requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." requiredMode: REQUIRED attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamUpdateResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TeamUpdateResourceV1.Relationships" description: Contains references to other related resources. required: - id - type writeOnly: true TeamUpdateResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: - string - "null" description: The name of the team. maxLength: 200 requiredMode: NOT_REQUIRED description: type: - string - "null" description: The description of the team. maxLength: 2000 requiredMode: NOT_REQUIRED isPublic: type: - boolean - "null" description: Indicates whether access to the team’s backlog is public (`true`) or private (`false`). requiredMode: NOT_REQUIRED backlogManagementByOwners: type: - boolean - "null" description: "Indicates whether backlog management is enabled for the team\ \ (`true`) or not (`false`). When enabled, the team's backlog managers\ \ are responsible for managing stories in the 'To do' and 'Won't do' categories\ \ of the workflow." requiredMode: NOT_REQUIRED timezone: type: - string - "null" description: "The IANA timezone identifier for the team (e.g., 'America/New_York',\ \ 'Europe/London'). This timezone is used for date calculations and display.\ \ If not specified, defaults to 'US/Pacific'." maxLength: 255 requiredMode: NOT_REQUIRED TeamUpdateResourceV1.Relationships: description: Contains references to other related resources. properties: members: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationshipsUpdate" description: "A relationship object linking to the users added to the team\ \ as members. Includes references to the users, along with related links\ \ and metadata. This does not include users with team roles such as team\ \ admins or backlog owners, unless they are also explicitly added as members\ \ of the team." TeamsType: enum: - ACTIVE - USER_RELATED - USER_RELATED_WITH_DELETED TextChange: properties: state: $ref: "#/components/schemas/TextChange.State" content: type: string required: - content - state TextChange.State: enum: - INITIAL - INSERT - DELETE - KEEP TextFieldChangeSet: properties: original: type: string modified: type: string changes: type: array items: $ref: "#/components/schemas/TextChange" required: - changes - modified - original TimeboxController.InclusionType: enum: - BACKLOG_ITEMS - BACKLOG_ITEMS_EXTENDED - CREATOR - TIMELINES - STORY_POINT_TOTALS - PROJECTED_COMPLETIONS TimeboxController.ListInclusionType: enum: - CREATOR - BACKLOG_ITEMS TimeboxController.RequestFilter: properties: autocomplete: type: - string - "null" timelineId: type: - string - "null" format: uuid excludeTimelineId: type: - string - "null" format: uuid TimeboxCreationResource: properties: type: type: string pattern: timebox attributes: $ref: "#/components/schemas/TimeboxCreationResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TimeboxCreationResource.Relationships" required: - attributes - relationships - type TimeboxCreationResource.Attributes: properties: name: type: string maxLength: 100 minLength: 1 description: type: string maxLength: 500 startDate: type: string format: date-time endDate: type: string format: date-time required: - description - endDate - name - startDate TimeboxCreationResource.Relationships: properties: backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems TimeboxResource: description: "The returned resource, based on the request." properties: type: type: string pattern: timebox id: type: string format: uuid attributes: $ref: "#/components/schemas/TimeboxResource.Attributes" relationships: $ref: "#/components/schemas/TimeboxResource.Relationships" meta: $ref: "#/components/schemas/TimeboxResource.Metadata" required: - attributes - id - meta - relationships - type TimeboxResource.Attributes: properties: name: type: string description: type: string deleted: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time startDate: type: string format: date-time endDate: type: string format: date-time required: - createdAt - deleted - description - endDate - name - startDate - updatedAt TimeboxResource.Metadata: properties: state: $ref: "#/components/schemas/State" storyCount: type: integer format: int32 bugCount: type: integer format: int32 unfilteredTeamCount: type: integer format: int64 allowedActions: type: array items: type: string required: - allowedActions - bugCount - state - storyCount - unfilteredTeamCount TimeboxResource.Relationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" backlogItems: $ref: "#/components/schemas/MultipleRelationships" timelines: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - creator - timelines TimeboxResourceV1: description: "A timebox (sprint, iteration, or release) that organizes backlog\ \ items within a specific timeframe." properties: type: type: string default: timebox description: Identifies the type of resource. pattern: timebox defaultValue: timebox id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/TimeboxResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/TimeboxResourceV1.Relationships" description: Contains references to other related resources. readOnly: true TimeboxResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: The name of the timebox description: type: string description: A description of the timebox createdAt: type: string format: date-time description: When the timebox was created updatedAt: type: string format: date-time description: When the timebox was last updated startDate: type: string format: date-time description: The start date of the timebox endDate: type: string format: date-time description: The end date of the timebox TimeboxResourceV1.Relationships: description: Contains references to other related resources. properties: creator: allOf: - $ref: "#/components/schemas/SingleRelationship" description: The user who created the timebox backlogItems: allOf: - $ref: "#/components/schemas/MultipleRelationships" description: The backlog items (stories and bugs) assigned to this timebox TimeboxUpdateResource: properties: type: type: string pattern: timebox id: type: string format: uuid attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TimeboxUpdateResource.Attributes" relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/TimeboxUpdateResource.Relationships" required: - attributes - id - relationships - type TimeboxUpdateResource.Attributes: properties: name: type: - string - "null" maxLength: 100 description: type: - string - "null" maxLength: 500 startDate: type: - string - "null" format: date-time endDate: type: - string - "null" format: date-time required: - description - endDate - name - startDate TimeboxUpdateResource.Relationships: properties: backlogItems: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems TimelineController.InclusionType: enum: - STORY_POINT_TOTALS - TIMEBOX_WARNINGS TimelineController.SingleTimelineFilter: properties: itemTeamIds: type: - string - "null" TimelineController.TimelineFilter: properties: creatorId: type: - string - "null" format: uuid TimelineCreationResource: properties: type: type: string pattern: timeline attributes: $ref: "#/components/schemas/TimelineCreationResource.Attributes" required: - attributes - type TimelineCreationResource.Attributes: properties: name: type: string maxLength: 100 minLength: 1 description: type: string maxLength: 500 required: - description - name TimelineEntryCreationResource: properties: type: type: string pattern: timeline_entry id: type: - string - "null" format: uuid attributes: $ref: "#/components/schemas/TimelineEntryCreationResource.Attributes" relationships: $ref: "#/components/schemas/TimelineEntryCreationResource.Relationships" required: - attributes - relationships - type TimelineEntryCreationResource.Attributes: properties: color: type: - string - "null" position: type: - integer - "null" format: int32 height: type: - integer - "null" format: int32 required: - color - height - position TimelineEntryCreationResource.Relationships: properties: timebox: $ref: "#/components/schemas/SingleRelationship" required: - timebox TimelineEntryResource: properties: type: type: string pattern: timeline_entry id: type: string format: uuid attributes: $ref: "#/components/schemas/TimelineEntryResource.Attributes" relationships: $ref: "#/components/schemas/TimelineEntryResource.Relationships" required: - attributes - id - relationships - type TimelineEntryResource.Attributes: properties: color: type: string position: type: integer format: int32 height: type: integer format: int32 required: - color - height - position TimelineEntryResource.Relationships: properties: timeline: $ref: "#/components/schemas/SingleRelationship" timebox: $ref: "#/components/schemas/SingleRelationship" required: - timebox - timeline TimelineEntryUpdateResource: properties: type: type: string pattern: timeline_entry id: type: - string - "null" format: uuid attributes: $ref: "#/components/schemas/TimelineEntryUpdateResource.Attributes" required: - attributes - type TimelineEntryUpdateResource.Attributes: properties: color: type: - string - "null" position: type: - integer - "null" format: int32 height: type: - integer - "null" format: int32 required: - color - height - position TimelineResource: properties: type: type: string pattern: timeline id: type: string format: uuid attributes: $ref: "#/components/schemas/TimelineResource.Attributes" relationships: $ref: "#/components/schemas/TimelineResource.Relationships" meta: $ref: "#/components/schemas/TimelineResource.Metadata" required: - attributes - id - meta - relationships - type TimelineResource.Attributes: properties: name: type: string description: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - description - name - updatedAt TimelineResource.Metadata: properties: state: $ref: "#/components/schemas/State" allowedActions: type: array items: type: string required: - allowedActions - state TimelineResource.Relationships: properties: creator: $ref: "#/components/schemas/SingleRelationship" timeboxes: $ref: "#/components/schemas/MultipleRelationships" timelineEntries: $ref: "#/components/schemas/MultipleRelationships" releaseMarkers: $ref: "#/components/schemas/MultipleRelationships" required: - creator - releaseMarkers - timeboxes - timelineEntries TimelineUpdateResource: properties: type: type: string pattern: timeline id: type: string format: uuid attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/TimelineUpdateResource.Attributes" required: - attributes - id - type TimelineUpdateResource.Attributes: properties: name: type: - string - "null" maxLength: 100 description: type: - string - "null" maxLength: 500 required: - description - name TsvImportFileError: properties: code: $ref: "#/components/schemas/TsvImportFileErrorCode" message: type: string required: - code - message TsvImportFileErrorCode: enum: - FILE_TOO_LARGE - MISSING_COLUMNS - NOT_TSV - UNEXPECTED_ERROR TsvImportRowStatus: properties: rowId: type: integer format: int64 importedTerm: type: string validationCodes: type: array items: $ref: "#/components/schemas/GlossaryEntryValidationCode" mismatchedRelatedTerms: type: array items: type: string errorId: type: string format: uuid required: - errorId - importedTerm - mismatchedRelatedTerms - rowId - validationCodes UsageConfigurationResource: properties: type: type: string description: Identifies the type of resource. id: type: string description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/UsageConfigurationResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/UsageConfigurationResource.Relationships" description: Contains references to other related resources. UsageConfigurationResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: eventSource: additionalProperties: type: string description: Event source identifier createdAt: type: string format: date-time description: The date and time this configuration was created updatedAt: type: string format: date-time description: The date and time this configuration was last updated UsageConfigurationResource.Relationships: description: Contains references to other related resources. properties: backlogItem: allOf: - $ref: "#/components/schemas/SingleRelationship" description: The backlog item that will record the usage events creator: allOf: - $ref: "#/components/schemas/SingleRelationship" description: The user that created this configuration UsageConfigurationResourceCreate: properties: type: type: string description: Identifies the type of resource. pattern: usage_configuration attributes: allOf: - $ref: "#/components/schemas/UsageConfigurationResourceCreate.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/UsageConfigurationResourceCreate.Relationships" description: Contains references to other related resources. required: - attributes - relationships - type UsageConfigurationResourceCreate.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: eventSource: additionalProperties: type: string maxLength: 128 allOf: - maxItems: 50 description: Event source identifier UsageConfigurationResourceCreate.Relationships: description: Contains references to other related resources. properties: backlogItem: allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" description: The backlog item that will record the usage events UsageConfigurationResourceUpdate: properties: type: type: string description: Identifies the type of resource. pattern: usage_configuration id: type: string description: "The unique identifier for the resource, typically a UUID." attributes: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageConfigurationResourceUpdate.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageConfigurationResourceUpdate.Relationships" description: Contains references to other related resources. required: - id - type UsageConfigurationResourceUpdate.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: eventSource: additionalProperties: type: string maxLength: 128 allOf: - type: - "null" - object description: Event source identifier UsageConfigurationResourceUpdate.Relationships: description: Contains references to other related resources. properties: backlogItem: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationshipUpdate" description: The backlog item that will record the usage events UsageReport: properties: bins: type: array items: $ref: "#/components/schemas/UsageReport.ReportRecordBin" knownEnvironmentNames: type: array items: type: string required: - bins - knownEnvironmentNames UsageReport.ByStoryRequest: properties: backlogItemIds: type: string customer: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.CustomerQuery" location: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.LocationQuery" environmentIds: type: - string - "null" interval: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Interval" resolution: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Resolution" required: - backlogItemIds UsageReport.CustomerQuery: properties: operator: type: string customers: type: array items: type: string required: - customers - operator UsageReport.CustomerReportRecordBin: properties: time: type: string format: date-time customers: type: array items: $ref: "#/components/schemas/UsageReport.CustomerUsage" required: - customers - time UsageReport.CustomerUsage: properties: customer: type: - string - "null" usageCount: type: - integer - "null" format: int32 UsageReport.CustomerUsageReport: properties: bins: type: array items: $ref: "#/components/schemas/UsageReport.CustomerReportRecordBin" knownCustomers: type: array items: type: string required: - bins - knownCustomers UsageReport.CustomersTotalsReport: properties: customers: type: array items: $ref: "#/components/schemas/UsageReport.CustomerUsage" required: - customers UsageReport.EnvironmentUsage: properties: environmentId: type: string format: uuid environmentName: type: string usageCount: type: - integer - "null" format: int32 required: - environmentId - environmentName UsageReport.Filter: properties: backlogItemId: type: string format: uuid customer: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.CustomerQuery" location: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.LocationQuery" required: - backlogItemId UsageReport.Interval: properties: fromDate: type: - string - "null" format: date-time toDate: type: - string - "null" format: date-time timezone: type: - string - "null" UsageReport.LocationQuery: properties: operator: type: string locations: type: array items: $ref: "#/components/schemas/UsageReport.LocationSpecifier" required: - locations - operator UsageReport.LocationSpecifier: properties: level: type: string location: type: array items: type: string required: - level - location UsageReport.ReportRecordBin: properties: time: type: string format: date-time environments: type: array items: $ref: "#/components/schemas/UsageReport.EnvironmentUsage" required: - environments - time UsageReport.Request: properties: filter: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Filter" interval: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Interval" resolution: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Resolution" UsageReport.Resolution: enum: - DAY - WEEK - MONTH UsageReport.StoriesRequestFilter: properties: interval: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Interval" productThemeIds: type: - string - "null" doneAt: type: - string - "null" teamIds: type: - string - "null" environmentIds: type: - string - "null" customer: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.CustomerQuery" location: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.LocationQuery" UsageReport.StoryUsageBin: properties: backlogItemId: type: string format: uuid time: type: string format: date-time usageCount: type: - integer - "null" format: int32 required: - backlogItemId - time UsageReport.TopCustomerRequest: properties: backlogItemId: type: string interval: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Interval" resolution: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.Resolution" environmentIds: type: - string - "null" location: type: - "null" - object allOf: - $ref: "#/components/schemas/UsageReport.LocationQuery" required: - backlogItemId User.Status: enum: - UNKNOWN - PENDING_VALIDATION - ABORTED_VALIDATION - EXPIRED_VALIDATION - ACTIVE - INACTIVE - DEACTIVATED - UNACTIVATED UserCreateResourceV1: description: "A user is an individual with access to Atono, defined by a unique\ \ email address and optional profile details." properties: type: type: string default: user description: Identifies the type of resource. pattern: user defaultValue: user requiredMode: REQUIRED attributes: allOf: - $ref: "#/components/schemas/UserCreateResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - type writeOnly: true UserCreateResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: email: type: string format: email description: The user’s email address. Must be unique across all users. minLength: 1 requiredMode: REQUIRED fullName: type: - string - "null" description: "The user’s full name, stored as a single field." requiredMode: NOT_REQUIRED required: - email UserCreationResource: properties: type: type: string pattern: user attributes: $ref: "#/components/schemas/UserCreationResource.UserAttributes" relationships: $ref: "#/components/schemas/UserCreationResource.UserRelationships" required: - attributes - relationships - type UserCreationResource.UserAttributes: properties: email: type: string format: email minLength: 1 fullName: type: - string - "null" required: - email - fullName UserCreationResource.UserRelationships: properties: inviterTeam: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - inviterTeam UserFilter: properties: autocomplete: type: - string - "null" userIds: type: - string - "null" UserResource: properties: type: type: string pattern: user id: type: string attributes: $ref: "#/components/schemas/UserResource.UserAttributes" relationships: $ref: "#/components/schemas/UserResource.UserRelationships" meta: $ref: "#/components/schemas/UserResource.UserMetadata" required: - attributes - id - meta - relationships - type UserResource.UserAttributes: properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time email: type: string format: email minLength: 1 fullName: type: - string - "null" status: type: - "null" - object allOf: - $ref: "#/components/schemas/User.Status" invitedAt: type: string format: date-time required: - createdAt - email - fullName - invitedAt - status - updatedAt UserResource.UserMetadata: properties: state: $ref: "#/components/schemas/State" allowedActions: type: array items: type: string required: - allowedActions - state UserResource.UserRelationships: properties: roles: $ref: "#/components/schemas/MultipleRelationships" invitedBy: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - invitedBy - roles UserResourceV1: description: "A user is an individual with access to Atono, defined by a unique\ \ email address and optional profile details." properties: type: type: string default: user description: Identifies the type of resource. pattern: user defaultValue: user id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/UserResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." readOnly: true UserResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: createdAt: type: string format: date-time description: The date and time the user account was created. updatedAt: type: string format: date-time description: "The date and time the user’s information (e.g., name, status,\ \ or roles) was last updated." invitedAt: type: string format: date-time description: The date and time the user was sent an invitation to join the workspace. email: type: string format: email description: The user’s email address. Must be unique across all users. fullName: type: - string - "null" description: "The user’s full name, stored as a single field." deleted: type: boolean description: Indicates whether the user has been deleted. UserSettingEntryCreationResource: properties: type: type: string pattern: user_setting_entry attributes: $ref: "#/components/schemas/UserSettingEntryResource.Attributes" required: - attributes - type UserSettingEntryResource: properties: type: type: string pattern: user_setting_entry id: type: string attributes: $ref: "#/components/schemas/UserSettingEntryResource.Attributes" relationships: $ref: "#/components/schemas/UserSettingEntryResource.Relationships" required: - attributes - id - relationships - type UserSettingEntryResource.Attributes: properties: key: type: string maxLength: 100 minLength: 1 value: type: string maxLength: 50000 required: - key - value UserSettingEntryResource.Relationships: properties: user: $ref: "#/components/schemas/SingleRelationship" required: - user UserSettingsResource: description: "The returned resource, based on the request." properties: type: type: string pattern: user_settings id: type: string attributes: $ref: "#/components/schemas/UserSettingsResource.UserSettingsAttributes" relationships: $ref: "#/components/schemas/UserSettingsResource.UserSettingsRelationships" meta: $ref: "#/components/schemas/UserSettingsResource.Metadata" required: - attributes - id - meta - relationships - type UserSettingsResource.Metadata: properties: sampleDataVersion: type: - string - "null" required: - sampleDataVersion UserSettingsResource.UserSettingsAttributes: properties: hasJoinedCommunitySlack: type: boolean assignmentNotificationsEnabled: type: - boolean - "null" hideSampleData: type: boolean permittedActions: type: array items: type: string required: - hasJoinedCommunitySlack - hideSampleData - permittedActions UserSettingsResource.UserSettingsRelationships: properties: user: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" inviterTeam: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - inviterTeam - user UserSettingsUpdateResource: properties: type: type: string pattern: user_settings attributes: $ref: "#/components/schemas/UserSettingsUpdateResource.UserSettingsAttributes" required: - attributes - type UserSettingsUpdateResource.UserSettingsAttributes: properties: hasJoinedCommunitySlack: type: - boolean - "null" assignmentNotificationsEnabled: type: - boolean - "null" hideSampleData: type: - boolean - "null" UserUpdateResource: properties: type: type: string pattern: user id: type: string attributes: $ref: "#/components/schemas/UserUpdateResource.UserAttributes" required: - attributes - id - type UserUpdateResource.UserAttributes: properties: fullName: type: - string - "null" minLength: 1 status: type: - "null" - object allOf: - $ref: "#/components/schemas/User.Status" required: - fullName - status UserUpdateResourceV1: description: "A user is an individual with access to Atono, defined by a unique\ \ email address and optional profile details." properties: type: type: string default: user description: Identifies the type of resource. pattern: user defaultValue: user requiredMode: REQUIRED id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/UserUpdateResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - id - type writeOnly: true UserUpdateResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: fullName: type: - string - "null" description: "The user’s full name, stored as a single field." minLength: 1 requiredMode: NOT_REQUIRED UsersCreationResource: properties: data: type: array items: $ref: "#/components/schemas/UserCreationResource" required: - data VcsPullRequest: properties: repository: type: string repositoryUrl: type: string title: type: string url: type: string externalId: type: string openerUser: type: string isAdd: type: boolean mention: $ref: "#/components/schemas/VcsPullRequest.Mention" mentions: type: array items: $ref: "#/components/schemas/VcsPullRequest.Mention" changeReason: $ref: "#/components/schemas/VcsPullRequest.ChangeReason" required: - changeReason - externalId - isAdd - mention - mentions - openerUser - repository - repositoryUrl - title - url VcsPullRequest.ChangeReason: enum: - OPENED - REOPENED - MERGED - CLOSED VcsPullRequest.Mention: enum: - TITLE - DESCRIPTION - COMMENT - BRANCH_NAME - COMMIT_MESSAGE VerificationRequest: properties: id: type: string minLength: 1 code: type: string minLength: 1 required: - code - id WorkflowController.StepRequestFilter: properties: teams: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkflowController.TeamsType" teamIds: type: - string - "null" workflowType: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkflowResource.WorkflowType" categories: type: - string - "null" itemType: type: - "null" - object allOf: - $ref: "#/components/schemas/BacklogItem.ItemType" autocomplete: type: - string - "null" WorkflowController.TeamsType: enum: - SPECIFIED - USER_RELATED_WITH_DELETED WorkflowController.WorkflowsFilter: properties: teamId: type: - string - "null" format: uuid type: type: - "null" - object allOf: - $ref: "#/components/schemas/WorkflowResource.WorkflowType" WorkflowResource: properties: type: type: string pattern: workflow id: type: string format: uuid attributes: $ref: "#/components/schemas/WorkflowResource.Attributes" relationships: $ref: "#/components/schemas/WorkflowResource.Relationships" meta: $ref: "#/components/schemas/WorkflowResource.Metadata" required: - attributes - id - meta - relationships - type WorkflowResource.Attributes: properties: isDefault: type: boolean type: $ref: "#/components/schemas/WorkflowResource.WorkflowType" required: - isDefault - type WorkflowResource.Metadata: properties: allowedActions: type: array items: type: string required: - allowedActions WorkflowResource.Relationships: properties: steps: type: - "null" - object allOf: - $ref: "#/components/schemas/MultipleRelationships" team: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - steps - team WorkflowResource.WorkflowType: enum: - TEMPLATE - STORY - BUG - TEAM WorkflowStepCreationResource: properties: type: type: string pattern: workflow_step attributes: $ref: "#/components/schemas/WorkflowStepCreationResource.WorkflowAttributes" relationships: $ref: "#/components/schemas/WorkflowStepCreationResource.Relationships" required: - attributes - relationships - type WorkflowStepCreationResource.Relationships: properties: workflow: $ref: "#/components/schemas/SingleRelationship" required: - workflow WorkflowStepCreationResource.WorkflowAttributes: properties: color: type: string maxLength: 100 minLength: 1 name: type: string maxLength: 40 minLength: 1 category: $ref: "#/components/schemas/StepCategory" position: type: - integer - "null" format: int32 minimum: 0 forStory: type: - boolean - "null" forBug: type: - boolean - "null" required: - category - color - forBug - forStory - name - position WorkflowStepItemTypeChangeResource: properties: type: type: string pattern: step_item_type_change attributes: $ref: "#/components/schemas/WorkflowStepItemTypeChangeResource.Attributes" relationships: $ref: "#/components/schemas/WorkflowStepItemTypeChangeResource.Relationships" required: - attributes - relationships - type WorkflowStepItemTypeChangeResource.Attributes: properties: forStory: type: - boolean - "null" forBug: type: - boolean - "null" required: - forBug - forStory WorkflowStepItemTypeChangeResource.Relationships: properties: changeStep: $ref: "#/components/schemas/SingleRelationship" stepForStory: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" stepForBug: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - changeStep - stepForBug - stepForStory WorkflowStepRemovalResource: properties: type: type: string pattern: step_removal relationships: $ref: "#/components/schemas/WorkflowStepRemovalResource.Relationships" required: - relationships - type WorkflowStepRemovalResource.Relationships: properties: changeStep: $ref: "#/components/schemas/SingleRelationship" stepForStory: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" stepForBug: type: - "null" - object allOf: - $ref: "#/components/schemas/SingleRelationship" required: - changeStep - stepForBug - stepForStory WorkflowStepResetResource: properties: type: type: string pattern: workflow_step_reset id: type: string format: uuid attributes: $ref: "#/components/schemas/WorkflowStepResetResource.Attributes" required: - attributes - id - type WorkflowStepResetResource.Attributes: properties: stepType: $ref: "#/components/schemas/StepType" required: - stepType WorkflowStepResource: properties: type: type: string pattern: workflow_step id: type: string format: uuid attributes: $ref: "#/components/schemas/WorkflowStepResource.WorkflowAttributes" relationships: $ref: "#/components/schemas/WorkflowStepResource.WorkflowRelationships" meta: $ref: "#/components/schemas/WorkflowStepResource.Metadata" required: - attributes - id - meta - relationships - type WorkflowStepResource.Metadata: properties: storyCount: type: integer format: int32 bugCount: type: integer format: int32 required: - bugCount - storyCount WorkflowStepResource.WorkflowAttributes: properties: position: type: integer format: int32 color: type: string name: type: string category: $ref: "#/components/schemas/StepCategory" stepType: $ref: "#/components/schemas/StepType" forStory: type: boolean forBug: type: boolean allowNewItems: type: boolean required: - allowNewItems - category - color - forBug - forStory - name - position - stepType WorkflowStepResource.WorkflowRelationships: properties: workflow: $ref: "#/components/schemas/SingleRelationship" backlogItems: $ref: "#/components/schemas/MultipleRelationships" required: - backlogItems - workflow WorkflowStepResourceV1: description: "A workflow step represents a stage in the team's workflow process.\ \ Stories and bugs move through these steps as they progress from creation\ \ to completion. Each step has a category (To do, In progress, Done, or Won't\ \ do) and can be configured to accept stories, bugs, or both." properties: type: type: string default: workflow_step description: Identifies the type of resource. pattern: workflow_step defaultValue: workflow_step id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/WorkflowStepResourceV1.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." readOnly: true WorkflowStepResourceV1.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: name: type: string description: The name of the workflow step. category: allOf: - $ref: "#/components/schemas/StepCategory" description: "The category of the workflow step. Valid values are `TODO`\ \ (To do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO` (Won't\ \ do). The category determines the general stage of work items in this\ \ step." position: type: integer format: int32 description: "The position of the workflow step within its category. Steps\ \ are ordered by category first, then by position within the category." color: type: string description: "The color associated with the workflow step, typically used\ \ for visual representation in the Atono application." stepType: allOf: - $ref: "#/components/schemas/StepType" description: "The high-level classification of the workflow step. Determines\ \ the default color shown in the Atono application if no custom color\ \ is set, and helps identify the most appropriate step to move items to\ \ when a step is deleted or the workflow is reset." forStory: type: boolean description: Indicates whether stories can be assigned to this workflow step (`true`) or not (`false`). forBug: type: boolean description: Indicates whether bugs can be assigned to this workflow step (`true`) or not (`false`). allowNewItems: type: boolean description: Indicates whether new backlog items can be created directly in this workflow step (`true`) or not (`false`). WorkflowStepSnapshot: description: A snapshot of the workflow step properties: id: type: string format: uuid name: type: string stepType: $ref: "#/components/schemas/StepType" category: $ref: "#/components/schemas/StepCategory" color: type: string required: - category - color - id - name - stepType WorkflowStepUpdateResource: properties: type: type: string pattern: workflow_step id: type: string format: uuid attributes: $ref: "#/components/schemas/WorkflowStepUpdateResource.WorkflowAttributes" required: - attributes - id - type WorkflowStepUpdateResource.WorkflowAttributes: properties: name: type: - string - "null" maxLength: 40 color: type: - string - "null" maxLength: 100 category: type: - "null" - object allOf: - $ref: "#/components/schemas/StepCategory" position: type: - integer - "null" format: int32 minimum: 0 forStory: type: - boolean - "null" forBug: type: - boolean - "null" required: - category - color - forBug - forStory - name - position WorkflowType: enum: - SCRUM - KANBAN WorkspaceIntegrationResource: description: An integration that was installed in the workspace. properties: type: type: string default: workspace_integration description: Identifies the type of resource. pattern: workspace_integration defaultValue: workspace_integration id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/WorkspaceIntegrationResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." relationships: allOf: - $ref: "#/components/schemas/WorkspaceIntegrationResource.Relationships" description: Contains references to other related resources. meta: allOf: - $ref: "#/components/schemas/WorkspaceIntegrationResource.Metadata" description: "Extra information about the resource, including calculated\ \ values or non-standard fields." readOnly: true WorkspaceIntegrationResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: externalName: type: string status: $ref: "#/components/schemas/IntegrationStatus" installedAt: type: - string - "null" format: date-time updatedAt: type: - string - "null" format: date-time config: $ref: "#/components/schemas/IntegrationConfig" required: - config - externalName - installedAt - status - updatedAt WorkspaceIntegrationResource.Metadata: description: "Extra information about the resource, including calculated values\ \ or non-standard fields." properties: lastUsedAt: type: - string - "null" format: date-time required: - lastUsedAt WorkspaceIntegrationResource.Relationships: description: Contains references to other related resources. properties: sharedIntegration: $ref: "#/components/schemas/SingleRelationship" setupUser: $ref: "#/components/schemas/SingleRelationship" required: - setupUser - sharedIntegration WorkspaceIntegrationTypeFilter: description: Filter for workspace integration types used in API queries. enum: - JIRA_SYNC - GITHUB_INTEGRATION WorkspaceIntegrationUpdateResource: description: An integration that was installed in the workspace. properties: type: type: string default: workspace_integration description: Identifies the type of resource. pattern: workspace_integration defaultValue: workspace_integration id: type: string format: uuid description: "The unique identifier for the resource, typically a UUID." attributes: allOf: - $ref: "#/components/schemas/WorkspaceIntegrationUpdateResource.Attributes" description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." required: - attributes - id - type writeOnly: true WorkspaceIntegrationUpdateResource.Attributes: description: "Contains the structured data fields that describe the resource,\ \ such as properties, settings, and timestamps." properties: externalName: type: - string - "null" required: - externalName WorkspaceResource: properties: type: type: string pattern: workspace id: type: string attributes: $ref: "#/components/schemas/WorkspaceResource.WorkspaceAttributes" meta: $ref: "#/components/schemas/WorkspaceResource.WorkspaceMeta" required: - attributes - id - meta - type WorkspaceResource.WorkspaceAttributes: properties: name: type: string minLength: 1 url: type: string minLength: 1 current: type: boolean maxUserCount: type: integer format: int32 workspaceStorage: type: integer format: int64 subscriptionTier: $ref: "#/components/schemas/Subscription.SubscriptionTier" subscriptionEndDate: type: string format: date-time trialExtended: type: boolean lastActive: type: string format: date-time staleReminderSent: type: boolean isSlicedByCustomer: type: boolean isAiActive: type: boolean aiTrialStartDate: type: string format: date-time aiTrialEndDate: type: - string - "null" format: date-time activeItemLimit: type: integer format: int32 required: - activeItemLimit - aiTrialStartDate - current - isAiActive - isSlicedByCustomer - lastActive - maxUserCount - name - staleReminderSent - subscriptionEndDate - subscriptionTier - trialExtended - url - workspaceStorage WorkspaceResource.WorkspaceMeta: properties: usedStorage: type: integer format: int64 accessibleStorage: type: integer format: int64 activeItemCount: type: integer format: int32 required: - accessibleStorage - activeItemCount - usedStorage WorkspaceUpdateResource: properties: type: type: string pattern: workspace id: type: string format: uuid attributes: $ref: "#/components/schemas/WorkspaceUpdateResource.WorkspaceAttributes" required: - attributes - id - type WorkspaceUpdateResource.WorkspaceAttributes: properties: isAiTrialActive: type: - boolean - "null" required: - isAiTrialActive securitySchemes: ApiKeyAuth: type: apiKey name: X-API-KEY in: header