{ "openapi": "3.0.3", "info": { "title": "Projects & Issues API", "version": "1.0.0", "description": "Agile projects, boards, issues, sprints, and JQL/VQL queries." }, "servers": [ { "url": "https://versus-demo.com" } ], "paths": { "/api/agile/automation-rules/": { "get": { "operationId": "agile_automation_rules_list", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAutomationRuleList" } } }, "description": "" } }, "summary": "List automation rules" }, "post": { "operationId": "agile_automation_rules_create", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRule" } } }, "description": "" } }, "summary": "Create automation rule" } }, "/api/agile/automation-rules/{id}/": { "get": { "operationId": "agile_automation_rules_retrieve", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this automation rule.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRule" } } }, "description": "" } }, "summary": "Retrieve automation rule" }, "put": { "operationId": "agile_automation_rules_update", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this automation rule.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRule" } } }, "description": "" } }, "summary": "Update automation rule" }, "patch": { "operationId": "agile_automation_rules_partial_update", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this automation rule.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAutomationRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAutomationRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAutomationRuleRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRule" } } }, "description": "" } }, "summary": "Update automation rule" }, "delete": { "operationId": "agile_automation_rules_destroy", "description": "VS-SPEC-AGILE-WORKFLOWS-001 \u00a77.3 \u2014 CRUD for event\u2192workflow automation rules.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this automation rule.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete automation rule" } }, "/api/agile/boards/": { "get": { "operationId": "agile_boards_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBoardList" } } }, "description": "" } }, "summary": "List boards" }, "post": { "operationId": "agile_boards_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BoardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Create board" } }, "/api/agile/boards/{id}/": { "get": { "operationId": "agile_boards_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Retrieve board" }, "put": { "operationId": "agile_boards_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BoardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Update board" }, "patch": { "operationId": "agile_boards_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedBoardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedBoardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedBoardRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Update board" }, "delete": { "operationId": "agile_boards_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete board" } }, "/api/agile/boards/{id}/issues/": { "get": { "operationId": "agile_boards_issues_retrieve", "description": "Return the board's issues grouped into swimlanes -> columns. A\ncolumn lists the workflow-status ids it represents so the UI can drag a\ncard to a column and POST a transition to that status. Accepts an extra\n?jql= (a quick-filter, AND-composed onto the board filter).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Issues: board" } }, "/api/agile/boards/{id}/sprints/": { "get": { "operationId": "agile_boards_sprints_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Sprints: board" }, "post": { "operationId": "agile_boards_sprints_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this board.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BoardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BoardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "description": "" } }, "summary": "Sprints: board" } }, "/api/agile/components/": { "get": { "operationId": "agile_components_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectComponentList" } } }, "description": "" } }, "summary": "List components" }, "post": { "operationId": "agile_components_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponent" } } }, "description": "" } }, "summary": "Create component" } }, "/api/agile/components/{id}/": { "get": { "operationId": "agile_components_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this project component.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponent" } } }, "description": "" } }, "summary": "Retrieve component" }, "put": { "operationId": "agile_components_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this project component.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectComponentRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponent" } } }, "description": "" } }, "summary": "Update component" }, "patch": { "operationId": "agile_components_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this project component.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProjectComponentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedProjectComponentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedProjectComponentRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectComponent" } } }, "description": "" } }, "summary": "Update component" }, "delete": { "operationId": "agile_components_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this project component.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete component" } }, "/api/agile/custom-fields/": { "get": { "operationId": "agile_custom_fields_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldDefList" } } }, "description": "" } }, "summary": "List custom fields" }, "post": { "operationId": "agile_custom_fields_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDef" } } }, "description": "" } }, "summary": "Create custom field" } }, "/api/agile/custom-fields/{id}/": { "get": { "operationId": "agile_custom_fields_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this custom field def.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDef" } } }, "description": "" } }, "summary": "Retrieve custom field" }, "put": { "operationId": "agile_custom_fields_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this custom field def.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldDefRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDef" } } }, "description": "" } }, "summary": "Update custom field" }, "patch": { "operationId": "agile_custom_fields_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this custom field def.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldDefRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldDefRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldDefRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDef" } } }, "description": "" } }, "summary": "Update custom field" }, "delete": { "operationId": "agile_custom_fields_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this custom field def.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete custom field" } }, "/api/agile/dashboards/": { "get": { "operationId": "agile_dashboards_list", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDashboardList" } } }, "description": "" } }, "summary": "List dashboards" }, "post": { "operationId": "agile_dashboards_create", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Create dashboard" } }, "/api/agile/dashboards/{id}/": { "get": { "operationId": "agile_dashboards_retrieve", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Retrieve dashboard" }, "put": { "operationId": "agile_dashboards_update", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Update dashboard" }, "patch": { "operationId": "agile_dashboards_partial_update", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDashboardRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Update dashboard" }, "delete": { "operationId": "agile_dashboards_destroy", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete dashboard" } }, "/api/agile/dashboards/{id}/delete-gadget/": { "post": { "operationId": "agile_dashboards_delete_gadget_create", "description": "VS-SPEC-DESK-AGILE-DASHBOARDS-001 \u2014 Jira-style dashboards whose gadgets are\nrendered SERVER-SIDE from live Versus data. Tenant scoping is via RLS (same as\nevery other agile viewset); on top of that, a user sees shared dashboards + their\nown. The `resolve` action renders every gadget to a paint-ready payload.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Delete gadget: dashboard" } }, "/api/agile/dashboards/{id}/gadgets/": { "post": { "operationId": "agile_dashboards_gadgets_create", "description": "Add a gadget. {kind, title?, config?, position?}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Gadgets: dashboard" } }, "/api/agile/dashboards/{id}/resolve/": { "get": { "operationId": "agile_dashboards_resolve_retrieve", "description": "Render every gadget on the dashboard from live data.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Resolve: dashboard" } }, "/api/agile/dashboards/{id}/update-gadget/": { "post": { "operationId": "agile_dashboards_update_gadget_create", "description": "Update a gadget. {gadget_id, title?, config?, position?, order?}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this dashboard.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "summary": "Update gadget: dashboard" } }, "/api/agile/filters/": { "get": { "operationId": "agile_filters_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSavedFilterList" } } }, "description": "" } }, "summary": "List filters" }, "post": { "operationId": "agile_filters_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } }, "description": "" } }, "summary": "Create filter" } }, "/api/agile/filters/{id}/": { "get": { "operationId": "agile_filters_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this saved filter.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } }, "description": "" } }, "summary": "Retrieve filter" }, "put": { "operationId": "agile_filters_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this saved filter.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SavedFilterRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } }, "description": "" } }, "summary": "Update filter" }, "patch": { "operationId": "agile_filters_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this saved filter.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSavedFilterRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSavedFilterRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSavedFilterRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } }, "description": "" } }, "summary": "Update filter" }, "delete": { "operationId": "agile_filters_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this saved filter.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete filter" } }, "/api/agile/import-jira/": { "post": { "operationId": "agile_import_jira_create", "description": "POST a Jira export JSON (REST search shape) to import projects + issues.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create import jira" } }, "/api/agile/issue-types/": { "get": { "operationId": "agile_issue_types_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedIssueTypeList" } } }, "description": "" } }, "summary": "List issue types" }, "post": { "operationId": "agile_issue_types_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } }, "description": "" } }, "summary": "Create issue type" } }, "/api/agile/issue-types/{id}/": { "get": { "operationId": "agile_issue_types_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this issue type.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } }, "description": "" } }, "summary": "Retrieve issue type" }, "put": { "operationId": "agile_issue_types_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this issue type.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueTypeRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } }, "description": "" } }, "summary": "Update issue type" }, "patch": { "operationId": "agile_issue_types_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this issue type.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedIssueTypeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedIssueTypeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedIssueTypeRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } }, "description": "" } }, "summary": "Update issue type" }, "delete": { "operationId": "agile_issue_types_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this issue type.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete issue type" } }, "/api/agile/issues/": { "get": { "operationId": "agile_issues_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedIssueListList" } } }, "description": "" } }, "summary": "List issues" }, "post": { "operationId": "agile_issues_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Create issue" } }, "/api/agile/issues/{key}/": { "get": { "operationId": "agile_issues_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Retrieve issue" }, "put": { "operationId": "agile_issues_update", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Update issue" }, "patch": { "operationId": "agile_issues_partial_update", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedIssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedIssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedIssueDetailRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Update issue" }, "delete": { "operationId": "agile_issues_destroy", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete issue" } }, "/api/agile/issues/{key}/comments/": { "post": { "operationId": "agile_issues_comments_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Comments: issue" } }, "/api/agile/issues/{key}/custom-field/": { "post": { "operationId": "agile_issues_custom_field_create", "description": "Set (or clear) a custom field value on the issue. {field_id, value}", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Custom field: issue" } }, "/api/agile/issues/{key}/estimate/": { "post": { "operationId": "agile_issues_estimate_create", "description": "Set original/remaining estimate (seconds).", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Estimate: issue" } }, "/api/agile/issues/{key}/rank/": { "post": { "operationId": "agile_issues_rank_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Rank: issue" } }, "/api/agile/issues/{key}/schedule/": { "post": { "operationId": "agile_issues_schedule_create", "description": "Set an issue's timeline dates (drag-reschedule on the roadmap).", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Schedule: issue" } }, "/api/agile/issues/{key}/set_sprint/": { "post": { "operationId": "agile_issues_set_sprint_create", "description": "Move an issue into a sprint (sprint_id) or back to the backlog (null).", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Set sprint: issue" } }, "/api/agile/issues/{key}/sync_run/": { "post": { "operationId": "agile_issues_sync_run_create", "description": "Run\u2192issue callback: read the bound WorkflowRun's status and, on a\nterminal state, auto-advance the issue (success) or comment (failure).\nIdempotent \u2014 safe to call repeatedly from the polling run chip.", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Sync run: issue" } }, "/api/agile/issues/{key}/transition/": { "post": { "operationId": "agile_issues_transition_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Transition: issue" } }, "/api/agile/issues/{key}/transitions/": { "get": { "operationId": "agile_issues_transitions_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Transitions: issue" } }, "/api/agile/issues/{key}/worklog/": { "get": { "operationId": "agile_issues_worklog_retrieve", "description": "GET worklogs; POST {seconds, comment} logs work and rolls up time_spent /\nremaining_estimate.", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Worklog: issue" }, "post": { "operationId": "agile_issues_worklog_create", "description": "GET worklogs; POST {seconds, comment} logs work and rolls up time_spent /\nremaining_estimate.", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IssueDetailRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueDetail" } } }, "description": "" } }, "summary": "Worklog: issue" } }, "/api/agile/notifications/": { "get": { "operationId": "agile_notifications_list", "description": "The current user's in-app agile notifications.", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } }, "summary": "List notifications" } }, "/api/agile/notifications/{id}/": { "get": { "operationId": "agile_notifications_retrieve", "description": "The current user's in-app agile notifications.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this notification.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "summary": "Retrieve notification" } }, "/api/agile/notifications/{id}/read/": { "post": { "operationId": "agile_notifications_read_create", "description": "The current user's in-app agile notifications.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this notification.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "summary": "Read: notification" } }, "/api/agile/notifications/count/": { "get": { "operationId": "agile_notifications_count_retrieve", "description": "The current user's in-app agile notifications.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "summary": "List counts" } }, "/api/agile/notifications/read-all/": { "post": { "operationId": "agile_notifications_read_all_create", "description": "The current user's in-app agile notifications.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "summary": "Create read all" } }, "/api/agile/plans/": { "get": { "operationId": "agile_plans_list", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPlanList" } } }, "description": "" } }, "summary": "List plans" }, "post": { "operationId": "agile_plans_create", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PlanRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Create plan" } }, "/api/agile/plans/{id}/": { "get": { "operationId": "agile_plans_retrieve", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Retrieve plan" }, "put": { "operationId": "agile_plans_update", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PlanRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Update plan" }, "patch": { "operationId": "agile_plans_partial_update", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPlanRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Update plan" }, "delete": { "operationId": "agile_plans_destroy", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete plan" } }, "/api/agile/plans/{id}/capacity/": { "get": { "operationId": "agile_plans_capacity_retrieve", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Capacity: plan" } }, "/api/agile/plans/{id}/timeline/": { "get": { "operationId": "agile_plans_timeline_retrieve", "description": "Cross-project portfolio plans (Advanced-Roadmaps-lite).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this plan.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } } }, "description": "" } }, "summary": "Timeline: plan" } }, "/api/agile/projects/": { "get": { "operationId": "agile_projects_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectList" } } }, "description": "" } }, "summary": "List projects" }, "post": { "operationId": "agile_projects_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Create project" } }, "/api/agile/projects/{key}/": { "get": { "operationId": "agile_projects_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Retrieve project" }, "put": { "operationId": "agile_projects_update", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Update project" }, "patch": { "operationId": "agile_projects_partial_update", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Update project" }, "delete": { "operationId": "agile_projects_destroy", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete project" } }, "/api/agile/projects/{key}/backlog/": { "get": { "operationId": "agile_projects_backlog_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Backlog: project" } }, "/api/agile/projects/{key}/components/": { "get": { "operationId": "agile_projects_components_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Components: project" }, "post": { "operationId": "agile_projects_components_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Components: project" } }, "/api/agile/projects/{key}/releases/": { "get": { "operationId": "agile_projects_releases_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Releases: project" }, "post": { "operationId": "agile_projects_releases_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Releases: project" } }, "/api/agile/projects/{key}/reports/{kind}/": { "get": { "operationId": "agile_projects_reports_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true }, { "in": "path", "name": "kind", "schema": { "type": "string" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Retrieve report" } }, "/api/agile/projects/{key}/settings/": { "get": { "operationId": "agile_projects_settings_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Settings: project" }, "patch": { "operationId": "agile_projects_settings_partial_update", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Settings: project" } }, "/api/agile/projects/{key}/shortcuts/": { "get": { "operationId": "agile_projects_shortcuts_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Shortcuts: project" }, "post": { "operationId": "agile_projects_shortcuts_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Shortcuts: project" } }, "/api/agile/projects/{key}/star/": { "post": { "operationId": "agile_projects_star_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Star: project" } }, "/api/agile/projects/{key}/summary/": { "get": { "operationId": "agile_projects_summary_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Summary: project" } }, "/api/agile/projects/{key}/timeline/": { "get": { "operationId": "agile_projects_timeline_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Timeline: project" } }, "/api/agile/projects/{key}/unstar/": { "post": { "operationId": "agile_projects_unstar_create", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Unstar: project" } }, "/api/agile/projects/{key}/workflow/": { "get": { "operationId": "agile_projects_workflow_retrieve", "parameters": [ { "in": "path", "name": "key", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } }, "summary": "Workflow: project" } }, "/api/agile/releases/": { "get": { "operationId": "agile_releases_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReleaseList" } } }, "description": "" } }, "summary": "List releases" }, "post": { "operationId": "agile_releases_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Release" } } }, "description": "" } }, "summary": "Create release" } }, "/api/agile/releases/{id}/": { "get": { "operationId": "agile_releases_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this release.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Release" } } }, "description": "" } }, "summary": "Retrieve release" }, "put": { "operationId": "agile_releases_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this release.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Release" } } }, "description": "" } }, "summary": "Update release" }, "patch": { "operationId": "agile_releases_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this release.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReleaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReleaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReleaseRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Release" } } }, "description": "" } }, "summary": "Update release" }, "delete": { "operationId": "agile_releases_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this release.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete release" } }, "/api/agile/releases/{id}/release/": { "post": { "operationId": "agile_releases_release_create", "description": "Mark a version released. Warns (does not block) on unresolved issues.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this release.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReleaseRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Release" } } }, "description": "" } }, "summary": "Release: release" } }, "/api/agile/search/": { "get": { "operationId": "agile_search_retrieve", "description": "POST /agile/search {jql, startAt, maxResults} and GET ?jql= \u2014 the\nsingle JQL-backed search that the navigator, boards, and filters use.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "List searchs" }, "post": { "operationId": "agile_search_create", "description": "POST /agile/search {jql, startAt, maxResults} and GET ?jql= \u2014 the\nsingle JQL-backed search that the navigator, boards, and filters use.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create search" } }, "/api/agile/search/validate/": { "post": { "operationId": "agile_search_validate_create", "description": "POST /agile/search {jql, startAt, maxResults} and GET ?jql= \u2014 the\nsingle JQL-backed search that the navigator, boards, and filters use.", "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create validate" } }, "/api/agile/sprints/": { "get": { "operationId": "agile_sprints_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSprintList" } } }, "description": "" } }, "summary": "List sprints" }, "post": { "operationId": "agile_sprints_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SprintRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Create sprint" } }, "/api/agile/sprints/{id}/": { "get": { "operationId": "agile_sprints_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Retrieve sprint" }, "put": { "operationId": "agile_sprints_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SprintRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Update sprint" }, "patch": { "operationId": "agile_sprints_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSprintRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Update sprint" }, "delete": { "operationId": "agile_sprints_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete sprint" } }, "/api/agile/sprints/{id}/complete/": { "post": { "operationId": "agile_sprints_complete_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SprintRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Complete: sprint" } }, "/api/agile/sprints/{id}/issues/": { "post": { "operationId": "agile_sprints_issues_create", "description": "Move issues into (or out of) this sprint. {issue_keys:[...]}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SprintRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Issues: sprint" } }, "/api/agile/sprints/{id}/start/": { "post": { "operationId": "agile_sprints_start_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this sprint.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SprintRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SprintRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } }, "description": "" } }, "summary": "Start: sprint" } }, "/api/agile/statuses/": { "get": { "operationId": "agile_statuses_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedStatusDefList" } } }, "description": "" } }, "summary": "List statuses" } }, "/api/agile/statuses/{id}/": { "get": { "operationId": "agile_statuses_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this status def.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDef" } } }, "description": "" } }, "summary": "Retrieve statuse" } }, "/api/agile/webhooks/": { "get": { "operationId": "agile_webhooks_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWebhookList" } } }, "description": "" } }, "summary": "List webhooks" }, "post": { "operationId": "agile_webhooks_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Create webhook" } }, "/api/agile/webhooks/{id}/": { "get": { "operationId": "agile_webhooks_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this webhook.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Retrieve webhook" }, "put": { "operationId": "agile_webhooks_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this webhook.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Update webhook" }, "patch": { "operationId": "agile_webhooks_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this webhook.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Update webhook" }, "delete": { "operationId": "agile_webhooks_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this webhook.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete webhook" } }, "/api/agile/webhooks/{id}/test/": { "post": { "operationId": "agile_webhooks_test_create", "description": "Send a ping payload to the webhook now.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this webhook.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Test: webhook" } }, "/api/agile/workflows/": { "get": { "operationId": "agile_workflows_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowList" } } }, "description": "" } }, "summary": "List workflows" }, "post": { "operationId": "agile_workflows_create", "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Create workflow" } }, "/api/agile/workflows/{id}/": { "get": { "operationId": "agile_workflows_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Retrieve workflow" }, "put": { "operationId": "agile_workflows_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Update workflow" }, "patch": { "operationId": "agile_workflows_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Update workflow" }, "delete": { "operationId": "agile_workflows_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete workflow" } }, "/api/agile/workflows/{id}/add_status/": { "post": { "operationId": "agile_workflows_add_status_create", "description": "Add a status node to the workflow. {name, category, color?}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Add status: workflow" } }, "/api/agile/workflows/{id}/add_transition/": { "post": { "operationId": "agile_workflows_add_transition_create", "description": "{name, from_status(id or null=any), to_status(id), versus_workflow_binding?}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Add transition: workflow" } }, "/api/agile/workflows/{id}/delete-status/": { "post": { "operationId": "agile_workflows_delete_status_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Delete status: workflow" } }, "/api/agile/workflows/{id}/delete-transition/": { "post": { "operationId": "agile_workflows_delete_transition_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Delete transition: workflow" } }, "/api/agile/workflows/{id}/update-transition/": { "post": { "operationId": "agile_workflows_update_transition_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "description": "A UUID string identifying this workflow.", "required": true } ], "tags": [ "agile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "description": "" } }, "summary": "Update transition: workflow" } } }, "components": { "schemas": { "PaginatedBoardList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Board" } } } }, "Workflow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 120 }, "description": { "type": "string" }, "system": { "type": "boolean" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowStatus" }, "readOnly": true }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTransition" }, "readOnly": true } }, "required": [ "id", "name", "statuses", "transitions" ] }, "ManagementStyleEnum": { "enum": [ "company_managed", "team_managed" ], "type": "string", "description": "* `company_managed` - Company-managed\n* `team_managed` - Team-managed" }, "SprintRequest": { "type": "object", "properties": { "board": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "goal": { "type": "string" }, "state": { "$ref": "#/components/schemas/SprintStateEnum" }, "start_at": { "type": "string", "format": "date-time", "nullable": true }, "end_at": { "type": "string", "format": "date-time", "nullable": true }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "board", "name" ] }, "AutomationRuleTriggerEnum": { "enum": [ "issue_created", "issue_transitioned", "field_changed", "commented", "scheduled" ], "type": "string", "description": "* `issue_created` - Issue created\n* `issue_transitioned` - Issue transitioned\n* `field_changed` - Field changed\n* `commented` - Commented\n* `scheduled` - Scheduled" }, "WorkflowTransition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 120 }, "from_status": { "type": "string", "format": "uuid", "nullable": true }, "to_status": { "type": "string", "format": "uuid" }, "to_status_name": { "type": "string", "readOnly": true }, "versus_workflow_binding": { "nullable": true }, "conditions": {}, "validators": {}, "post_functions": {} }, "required": [ "id", "name", "to_status", "to_status_name" ] }, "Dashboard": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "owner": { "type": "integer", "readOnly": true, "nullable": true }, "owner_username": { "type": "string", "readOnly": true, "default": "" }, "shared": { "type": "boolean" }, "layout": {}, "gadgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardGadget" }, "readOnly": true }, "gadget_count": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "gadget_count", "gadgets", "id", "name", "owner", "owner_username", "updated_at" ] }, "StatusDefCategoryEnum": { "enum": [ "todo", "in_progress", "done" ], "type": "string", "description": "* `todo` - To Do\n* `in_progress` - In Progress\n* `done` - Done" }, "PaginatedIssueListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/IssueList" } } } }, "AutomationRule": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "project": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "maxLength": 200 }, "enabled": { "type": "boolean" }, "trigger": { "$ref": "#/components/schemas/AutomationRuleTriggerEnum" }, "vql": { "type": "string", "maxLength": 1000 }, "binding": {}, "schedule": {}, "throttle_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "last_fired_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_fired_at", "name", "trigger" ] }, "PaginatedAutomationRuleList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRule" } } } }, "PaginatedProjectComponentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectComponent" } } } }, "PaginatedWorkflowList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } }, "Sprint": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "board": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 160 }, "goal": { "type": "string" }, "state": { "$ref": "#/components/schemas/SprintStateEnum" }, "start_at": { "type": "string", "format": "date-time", "nullable": true }, "end_at": { "type": "string", "format": "date-time", "nullable": true }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "board", "id", "name" ] }, "Release": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 500 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "release_date": { "type": "string", "format": "date", "nullable": true }, "released": { "type": "boolean" }, "archived": { "type": "boolean" }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "progress": { "type": "string", "readOnly": true } }, "required": [ "id", "name", "progress", "project" ] }, "PatchedPlanRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "type": "string", "maxLength": 500 }, "project_keys": {} } }, "PaginatedPlanList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } } }, "PaginatedSavedFilterList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SavedFilter" } } } }, "PaginatedProjectList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } } }, "CustomFieldDef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 120 }, "key": { "type": "string", "maxLength": 80, "pattern": "^[-a-zA-Z0-9_]+$" }, "field_type": { "$ref": "#/components/schemas/FieldTypeEnum" }, "options": {}, "is_global": { "type": "boolean" }, "context": {}, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "id", "key", "name" ] }, "PatchedSavedFilterRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "jql": { "type": "string", "minLength": 1 }, "shared": { "type": "boolean" } } }, "PaginatedReleaseList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Release" } } } }, "CustomFieldDefRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "key": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[-a-zA-Z0-9_]+$" }, "field_type": { "$ref": "#/components/schemas/FieldTypeEnum" }, "options": {}, "is_global": { "type": "boolean" }, "context": {}, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "key", "name" ] }, "SprintStateEnum": { "enum": [ "future", "active", "closed" ], "type": "string", "description": "* `future` - Future\n* `active` - Active\n* `closed` - Closed" }, "PatchedCustomFieldDefRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "key": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[-a-zA-Z0-9_]+$" }, "field_type": { "$ref": "#/components/schemas/FieldTypeEnum" }, "options": {}, "is_global": { "type": "boolean" }, "context": {}, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } } }, "SavedFilterRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "jql": { "type": "string", "minLength": 1 }, "shared": { "type": "boolean" } }, "required": [ "jql", "name" ] }, "DashboardGadget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "dashboard": { "type": "string", "format": "uuid" }, "kind": { "$ref": "#/components/schemas/DashboardGadgetKindEnum" }, "title": { "type": "string", "maxLength": 200 }, "config": {}, "position": {}, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "dashboard", "id", "kind" ] }, "IssueList": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "key": { "type": "string", "maxLength": 20 }, "seq": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "project": { "type": "string", "format": "uuid" }, "project_key": { "type": "string", "readOnly": true }, "issue_type": { "type": "string", "format": "uuid" }, "type_name": { "type": "string", "readOnly": true }, "type_icon": { "type": "string", "readOnly": true }, "type_color": { "type": "string", "readOnly": true }, "summary": { "type": "string", "maxLength": 500 }, "status": { "type": "string", "format": "uuid" }, "status_name": { "type": "string", "readOnly": true }, "status_category": { "type": "string", "readOnly": true }, "status_color": { "type": "string", "readOnly": true }, "resolution": { "type": "string", "maxLength": 40 }, "priority": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "assignee": { "type": "integer", "nullable": true }, "assignee_username": { "type": "string", "readOnly": true, "default": "" }, "story_points": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,4}(?:\\.\\d{0,2})?$", "nullable": true }, "labels": {}, "components": {}, "epic_link": { "type": "string", "format": "uuid", "nullable": true }, "epic_key": { "type": "string", "readOnly": true, "default": "" }, "sprint": { "type": "string", "format": "uuid", "nullable": true }, "rank": { "type": "string", "maxLength": 64 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "workflow_run_ref": { "type": "string", "maxLength": 100 }, "run_gated": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "assignee_username", "created_at", "epic_key", "id", "issue_type", "key", "project", "project_key", "seq", "status", "status_category", "status_color", "status_name", "summary", "type_color", "type_icon", "type_name", "updated_at" ] }, "Plan": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 160 }, "description": { "type": "string", "maxLength": 500 }, "project_keys": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name" ] }, "Project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "key": { "type": "string", "maxLength": 10 }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string" }, "project_type": { "$ref": "#/components/schemas/ProjectTypeEnum" }, "management_style": { "$ref": "#/components/schemas/ManagementStyleEnum" }, "category": { "type": "string", "maxLength": 80 }, "features": {}, "avatar_icon": { "type": "string", "maxLength": 50 }, "lead_user": { "type": "integer", "nullable": true }, "lead_username": { "type": "string", "readOnly": true, "default": "" }, "workflow": { "type": "string", "format": "uuid", "nullable": true }, "default_board_id": { "type": "string", "readOnly": true }, "default_board_type": { "type": "string", "readOnly": true, "default": "" }, "issue_count": { "type": "string", "readOnly": true }, "favorited": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "default_board_id", "default_board_type", "favorited", "id", "issue_count", "key", "lead_username", "name" ] }, "PaginatedDashboardList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" } } } }, "PatchedDashboardRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "shared": { "type": "boolean" }, "layout": {} } }, "PatchedIssueDetailRequest": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 20 }, "seq": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "project": { "type": "string", "format": "uuid" }, "issue_type": { "type": "string", "format": "uuid" }, "summary": { "type": "string", "minLength": 1, "maxLength": 500 }, "status": { "type": "string", "format": "uuid" }, "resolution": { "type": "string", "maxLength": 40 }, "priority": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "assignee": { "type": "integer", "nullable": true }, "story_points": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,4}(?:\\.\\d{0,2})?$", "nullable": true }, "labels": {}, "components": {}, "epic_link": { "type": "string", "format": "uuid", "nullable": true }, "sprint": { "type": "string", "format": "uuid", "nullable": true }, "rank": { "type": "string", "maxLength": 64 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "workflow_run_ref": { "type": "string", "maxLength": 100 }, "run_gated": { "type": "boolean" }, "description": { "type": "string" }, "reporter": { "type": "integer", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "environment_ref": { "type": "string", "maxLength": 200 }, "original_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "remaining_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "time_spent_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } } }, "IssueDetailRequest": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 20 }, "seq": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "project": { "type": "string", "format": "uuid" }, "issue_type": { "type": "string", "format": "uuid" }, "summary": { "type": "string", "minLength": 1, "maxLength": 500 }, "status": { "type": "string", "format": "uuid" }, "resolution": { "type": "string", "maxLength": 40 }, "priority": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "assignee": { "type": "integer", "nullable": true }, "story_points": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,4}(?:\\.\\d{0,2})?$", "nullable": true }, "labels": {}, "components": {}, "epic_link": { "type": "string", "format": "uuid", "nullable": true }, "sprint": { "type": "string", "format": "uuid", "nullable": true }, "rank": { "type": "string", "maxLength": 64 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "workflow_run_ref": { "type": "string", "maxLength": 100 }, "run_gated": { "type": "boolean" }, "description": { "type": "string" }, "reporter": { "type": "integer", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "environment_ref": { "type": "string", "maxLength": 200 }, "original_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "remaining_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "time_spent_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "issue_type", "key", "project", "seq", "status", "summary" ] }, "DashboardGadgetKindEnum": { "enum": [ "filter_count", "filter_list", "two_dimensional", "pie", "bar", "live_card" ], "type": "string", "description": "* `filter_count` - Filter count\n* `filter_list` - Filter list\n* `two_dimensional` - Two-dimensional\n* `pie` - Pie chart\n* `bar` - Bar chart\n* `live_card` - Live card" }, "ProjectRequest": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 10 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string" }, "project_type": { "$ref": "#/components/schemas/ProjectTypeEnum" }, "management_style": { "$ref": "#/components/schemas/ManagementStyleEnum" }, "category": { "type": "string", "maxLength": 80 }, "features": {}, "avatar_icon": { "type": "string", "minLength": 1, "maxLength": 50 }, "lead_user": { "type": "integer", "nullable": true }, "workflow": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "key", "name" ] }, "PatchedWebhookRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "project": { "type": "string", "format": "uuid", "nullable": true }, "url": { "type": "string", "minLength": 1, "maxLength": 600 }, "secret": { "type": "string", "maxLength": 200 }, "events": {}, "jql": { "type": "string" }, "enabled": { "type": "boolean" } } }, "PaginatedStatusDefList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDef" } } } }, "Notification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "issue_key": { "type": "string", "readOnly": true, "default": "" }, "event": { "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true }, "read": { "type": "boolean", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "event", "id", "issue_key", "read", "title" ] }, "ProjectComponent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "lead_user": { "type": "integer", "nullable": true }, "lead_username": { "type": "string", "readOnly": true, "default": "" }, "default_assignee": { "type": "integer", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "id", "lead_username", "name", "project" ] }, "PaginatedIssueTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/IssueType" } } } }, "PaginatedNotificationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } }, "PatchedIssueTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "icon": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "minLength": 1, "maxLength": 9 }, "hierarchy_level": { "type": "integer", "maximum": 32767, "minimum": -32768 } } }, "DashboardRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "shared": { "type": "boolean" }, "layout": {} }, "required": [ "name" ] }, "PatchedWorkflowRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string" }, "system": { "type": "boolean" } } }, "PatchedProjectComponentRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "lead_user": { "type": "integer", "nullable": true }, "default_assignee": { "type": "integer", "nullable": true }, "archived": { "type": "boolean" } } }, "PatchedReleaseRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 500 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "release_date": { "type": "string", "format": "date", "nullable": true }, "released": { "type": "boolean" }, "archived": { "type": "boolean" }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } } }, "IssueComment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "issue": { "type": "string", "format": "uuid" }, "author_username": { "type": "string", "readOnly": true, "default": "" }, "body": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "author_username", "body", "created_at", "id", "issue" ] }, "WebhookRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "project": { "type": "string", "format": "uuid", "nullable": true }, "url": { "type": "string", "minLength": 1, "maxLength": 600 }, "secret": { "type": "string", "maxLength": 200 }, "events": {}, "jql": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url" ] }, "Worklog": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "issue": { "type": "string", "format": "uuid" }, "author_username": { "type": "string", "readOnly": true, "default": "" }, "seconds": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "comment": { "type": "string", "maxLength": 500 }, "logged_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "author_username", "id", "issue", "logged_at" ] }, "ReleaseRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 500 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "release_date": { "type": "string", "format": "date", "nullable": true }, "released": { "type": "boolean" }, "archived": { "type": "boolean" }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "name", "project" ] }, "PatchedAutomationRuleRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "enabled": { "type": "boolean" }, "trigger": { "$ref": "#/components/schemas/AutomationRuleTriggerEnum" }, "vql": { "type": "string", "maxLength": 1000 }, "binding": {}, "schedule": {}, "throttle_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } } }, "PatchedSprintRequest": { "type": "object", "properties": { "board": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "goal": { "type": "string" }, "state": { "$ref": "#/components/schemas/SprintStateEnum" }, "start_at": { "type": "string", "format": "date-time", "nullable": true }, "end_at": { "type": "string", "format": "date-time", "nullable": true }, "sequence": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } } }, "PatchedProjectRequest": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 10 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string" }, "project_type": { "$ref": "#/components/schemas/ProjectTypeEnum" }, "management_style": { "$ref": "#/components/schemas/ManagementStyleEnum" }, "category": { "type": "string", "maxLength": 80 }, "features": {}, "avatar_icon": { "type": "string", "minLength": 1, "maxLength": 50 }, "lead_user": { "type": "integer", "nullable": true }, "workflow": { "type": "string", "format": "uuid", "nullable": true } } }, "PaginatedSprintList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Sprint" } } } }, "PatchedBoardRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "board_type": { "$ref": "#/components/schemas/BoardTypeEnum" }, "filter_jql": { "type": "string" }, "column_config": {}, "estimation": { "type": "string", "minLength": 1, "maxLength": 16 } } }, "IssueType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 60 }, "icon": { "type": "string", "maxLength": 50 }, "color": { "type": "string", "maxLength": 9 }, "hierarchy_level": { "type": "integer", "maximum": 32767, "minimum": -32768 } }, "required": [ "id", "name" ] }, "BoardTypeEnum": { "enum": [ "scrum", "kanban" ], "type": "string", "description": "* `scrum` - Scrum\n* `kanban` - Kanban" }, "PlanRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "type": "string", "maxLength": 500 }, "project_keys": {} }, "required": [ "name" ] }, "FieldTypeEnum": { "enum": [ "text", "textarea", "number", "date", "select", "multiselect", "checkbox", "user", "url" ], "type": "string", "description": "* `text` - Text\n* `textarea` - Paragraph\n* `number` - Number\n* `date` - Date\n* `select` - Select\n* `multiselect` - Multi-select\n* `checkbox` - Checkbox\n* `user` - User\n* `url` - URL" }, "IssueDetail": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "key": { "type": "string", "maxLength": 20 }, "seq": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "project": { "type": "string", "format": "uuid" }, "project_key": { "type": "string", "readOnly": true }, "issue_type": { "type": "string", "format": "uuid" }, "type_name": { "type": "string", "readOnly": true }, "type_icon": { "type": "string", "readOnly": true }, "type_color": { "type": "string", "readOnly": true }, "summary": { "type": "string", "maxLength": 500 }, "status": { "type": "string", "format": "uuid" }, "status_name": { "type": "string", "readOnly": true }, "status_category": { "type": "string", "readOnly": true }, "status_color": { "type": "string", "readOnly": true }, "resolution": { "type": "string", "maxLength": 40 }, "priority": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "assignee": { "type": "integer", "nullable": true }, "assignee_username": { "type": "string", "readOnly": true, "default": "" }, "story_points": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,4}(?:\\.\\d{0,2})?$", "nullable": true }, "labels": {}, "components": {}, "epic_link": { "type": "string", "format": "uuid", "nullable": true }, "epic_key": { "type": "string", "readOnly": true, "default": "" }, "sprint": { "type": "string", "format": "uuid", "nullable": true }, "rank": { "type": "string", "maxLength": 64 }, "start_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "workflow_run_ref": { "type": "string", "maxLength": 100 }, "run_gated": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "description": { "type": "string" }, "reporter": { "type": "integer", "nullable": true }, "reporter_username": { "type": "string", "readOnly": true, "default": "" }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/IssueComment" }, "readOnly": true }, "subtasks": { "type": "array", "items": { "$ref": "#/components/schemas/IssueList" }, "readOnly": true }, "epic_children": { "type": "array", "items": { "$ref": "#/components/schemas/IssueList" }, "readOnly": true }, "environment_ref": { "type": "string", "maxLength": 200 }, "original_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "remaining_estimate_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "time_spent_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "worklogs": { "type": "array", "items": { "$ref": "#/components/schemas/Worklog" }, "readOnly": true }, "custom_fields": { "type": "string", "readOnly": true }, "available_transitions": { "type": "string", "readOnly": true } }, "required": [ "assignee_username", "available_transitions", "comments", "created_at", "custom_fields", "epic_children", "epic_key", "id", "issue_type", "key", "project", "project_key", "reporter_username", "seq", "status", "status_category", "status_color", "status_name", "subtasks", "summary", "type_color", "type_icon", "type_name", "updated_at", "worklogs" ] }, "AutomationRuleRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "enabled": { "type": "boolean" }, "trigger": { "$ref": "#/components/schemas/AutomationRuleTriggerEnum" }, "vql": { "type": "string", "maxLength": 1000 }, "binding": {}, "schedule": {}, "throttle_s": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "name", "trigger" ] }, "WorkflowRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string" }, "system": { "type": "boolean" } }, "required": [ "name" ] }, "IssueTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "icon": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "minLength": 1, "maxLength": 9 }, "hierarchy_level": { "type": "integer", "maximum": 32767, "minimum": -32768 } }, "required": [ "name" ] }, "ProjectComponentRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "lead_user": { "type": "integer", "nullable": true }, "default_assignee": { "type": "integer", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "name", "project" ] }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 160 }, "project": { "type": "string", "format": "uuid", "nullable": true }, "project_key": { "type": "string", "readOnly": true, "default": "" }, "url": { "type": "string", "maxLength": 600 }, "secret": { "type": "string", "maxLength": 200 }, "events": {}, "jql": { "type": "string" }, "enabled": { "type": "boolean" }, "last_status": { "type": "string", "readOnly": true }, "last_fired_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_fired_at", "last_status", "name", "project_key", "url" ] }, "PaginatedCustomFieldDefList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDef" } } } }, "SavedFilter": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 160 }, "jql": { "type": "string" }, "shared": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "jql", "name" ] }, "ProjectTypeEnum": { "enum": [ "software", "service", "business" ], "type": "string", "description": "* `software` - Software\n* `service` - Service\n* `business` - Business" }, "WorkflowStatus": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "category": { "type": "string", "readOnly": true }, "color": { "type": "string", "readOnly": true }, "is_initial": { "type": "boolean" }, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "x": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "y": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "category", "color", "id", "name" ] }, "Board": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "project": { "type": "string", "format": "uuid", "nullable": true }, "project_key": { "type": "string", "readOnly": true, "default": "" }, "name": { "type": "string", "maxLength": 160 }, "board_type": { "$ref": "#/components/schemas/BoardTypeEnum" }, "filter_jql": { "type": "string" }, "column_config": {}, "estimation": { "type": "string", "maxLength": 16 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "project_key" ] }, "StatusDef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 60 }, "category": { "$ref": "#/components/schemas/StatusDefCategoryEnum" }, "color": { "type": "string", "maxLength": 9 } }, "required": [ "id", "name" ] }, "PaginatedWebhookList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } }, "BoardRequest": { "type": "object", "properties": { "project": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "board_type": { "$ref": "#/components/schemas/BoardTypeEnum" }, "filter_jql": { "type": "string" }, "column_config": {}, "estimation": { "type": "string", "minLength": 1, "maxLength": 16 } }, "required": [ "name" ] } } } }