From 00203636e4a8895e2b27eeba9d21d6350bc6dd79 Mon Sep 17 00:00:00 2001
From: Reingold Shekhtel <13565058+raikbitters@users.noreply.github.com>
Date: Mon, 4 Nov 2024 17:02:03 +0100
Subject: [PATCH] Add 5.12 OpenAPI Specifications (#814)
* Add 5.12 OpenAPI Specifications
* Switch to type module export
---
apis/{ => 5.11}/service-api.yaml | 0
apis/{ => 5.11}/service-uat.yaml | 0
apis/service-api.json | 16156 ++++++++++++++++++
apis/service-uat.json | 609 +
docs/api/versioned_sidebars/api-sidebars.ts | 27 +-
docs/api/versioned_sidebars/uat-sidebars.ts | 27 +-
docusaurus.config.js | 52 +-
src/config/openapi.config.js | 66 +
8 files changed, 16885 insertions(+), 52 deletions(-)
rename apis/{ => 5.11}/service-api.yaml (100%)
rename apis/{ => 5.11}/service-uat.yaml (100%)
create mode 100644 apis/service-api.json
create mode 100644 apis/service-uat.json
create mode 100644 src/config/openapi.config.js
diff --git a/apis/service-api.yaml b/apis/5.11/service-api.yaml
similarity index 100%
rename from apis/service-api.yaml
rename to apis/5.11/service-api.yaml
diff --git a/apis/service-uat.yaml b/apis/5.11/service-uat.yaml
similarity index 100%
rename from apis/service-uat.yaml
rename to apis/5.11/service-uat.yaml
diff --git a/apis/service-api.json b/apis/service-api.json
new file mode 100644
index 000000000..af6666868
--- /dev/null
+++ b/apis/service-api.json
@@ -0,0 +1,16156 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "ReportPortal",
+ "description": "ReportPortal API documentation",
+ "contact": {
+ "name": "Support",
+ "email": "support@reportportal.io"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ },
+ "version": "5.12.0"
+ },
+ "servers": [
+ {
+ "url": "{scheme}://{host}/api",
+ "description": "ReportPortal API server",
+ "variables": {
+ "scheme": {
+ "enum": [
+ "http",
+ "https"
+ ],
+ "default": "http"
+ },
+ "host": {
+ "description": "Host name and port (if needed) of Report Portal server",
+ "default": "demo.reportportal.io"
+ }
+ }
+ }
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "tags": [
+ {
+ "name": "activity-controller",
+ "description": "Activity Controller"
+ },
+ {
+ "name": "activity-event-controller",
+ "description": "Activity Event Controller"
+ },
+ {
+ "name": "bug-tracking-system-controller",
+ "description": "Bug Tracking System Controller"
+ },
+ {
+ "name": "dashboard-controller",
+ "description": "Dashboard Controller"
+ },
+ {
+ "name": "demo-data-controller",
+ "description": "Demo Data Controller"
+ },
+ {
+ "name": "file-storage-controller",
+ "description": "File Storage Controller"
+ },
+ {
+ "name": "integration-controller",
+ "description": "Integration Controller"
+ },
+ {
+ "name": "launch-async-controller",
+ "description": "Launch Async Controller. Puts events to the queues"
+ },
+ {
+ "name": "launch-controller",
+ "description": "Launch Controller"
+ },
+ {
+ "name": "log-async-controller",
+ "description": "Log Async Controller"
+ },
+ {
+ "name": "log-controller",
+ "description": "Log Controller"
+ },
+ {
+ "name": "onboarding-controller",
+ "description": "Onboarding Controller"
+ },
+ {
+ "name": "plugin-controller",
+ "description": "Plugin Controller"
+ },
+ {
+ "name": "plugin-public-controller",
+ "description": "Plugin Public Controller"
+ },
+ {
+ "name": "project-controller",
+ "description": "Project Controller"
+ },
+ {
+ "name": "project-settings-controller",
+ "description": "Project Settings Controller"
+ },
+ {
+ "name": "settings-controller",
+ "description": "Settings Controller"
+ },
+ {
+ "name": "test-item-async-controller",
+ "description": "Test Item Async Controller"
+ },
+ {
+ "name": "test-item-controller",
+ "description": "Test Item Controller"
+ },
+ {
+ "name": "user-controller",
+ "description": "User Controller"
+ },
+ {
+ "name": "user-filter-controller",
+ "description": "User Filter Controller"
+ },
+ {
+ "name": "widget-controller",
+ "description": "Widget Controller"
+ }
+ ],
+ "paths": {
+ "/v1/settings/analytics": {
+ "put": {
+ "tags": [
+ "settings-controller"
+ ],
+ "summary": "Update analytics settings",
+ "operationId": "saveAnalyticsSettings_1",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnalyticsResource"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "settings-controller"
+ ],
+ "summary": "Update analytics settings",
+ "operationId": "saveAnalyticsSettings",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnalyticsResource"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/launch/{launchId}/finish": {
+ "put": {
+ "tags": [
+ "launch-async-controller"
+ ],
+ "summary": "Finish Launch",
+ "description": "Finish launch for specified project",
+ "operationId": "finishLaunch",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishExecutionRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishLaunchRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/item/{testItemId}": {
+ "put": {
+ "tags": [
+ "test-item-async-controller"
+ ],
+ "summary": "Finish Test Item",
+ "description": "Finish test item",
+ "operationId": "finishTestItem",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "testItemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/widget/{widgetId}": {
+ "get": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Get widget by ID",
+ "operationId": "getWidget",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "widgetId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WidgetResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Update specified widget",
+ "operationId": "updateWidget",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "widgetId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WidgetRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/sub-type": {
+ "put": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Update of custom project specific issue sub-type",
+ "operationId": "updateProjectIssueSubType",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateIssueSubTypeRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Creation of custom project specific issue sub-type",
+ "operationId": "createProjectIssueSubType",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateIssueSubTypeRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IssueSubTypeCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/pattern/{id}": {
+ "put": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Update pattern template for items' log messages pattern analysis",
+ "operationId": "updatePatternTemplate",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdatePatternTemplateRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Delete pattern template for items' log messages pattern analysis",
+ "operationId": "deletePatternTemplate",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/notification": {
+ "get": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Returns notifications config of specified project",
+ "description": "Only for users assigned to specified project",
+ "operationId": "getNotifications",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SenderCaseDTO"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Updates notification for specified project",
+ "description": "Only for users with PROJECT_MANAGER or ADMIN roles",
+ "operationId": "updateNotification",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SenderCaseDTO"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Creates notification for specified project",
+ "description": "Only for users with PROJECT_MANAGER or ADMIN roles",
+ "operationId": "createNotification",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SenderCaseDTO"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/{launchId}/update": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Updates launch for specified project",
+ "operationId": "updateLaunch",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateLaunchRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/{launchId}/stop": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Force finish launch for specified project",
+ "operationId": "forceFinishLaunch",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishExecutionRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/{launchId}/finish": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Finish launch for specified project",
+ "operationId": "finishLaunch_1",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishExecutionRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishLaunchRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/update": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Updates launches for specified project",
+ "operationId": "updateLaunches",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BulkRQLongUpdateLaunchRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/stop": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Force finish launch",
+ "operationId": "bulkForceFinish",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BulkRQLongFinishExecutionRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/info": {
+ "put": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Bulk update attributes and description",
+ "operationId": "bulkUpdate",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BulkInfoUpdateRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Find test items by specified filter",
+ "operationId": "getTestItems",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.clusterId",
+ "in": "query",
+ "description": "Filters by 'clusterId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.duration",
+ "in": "query",
+ "description": "Filters by 'duration'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasChildren",
+ "in": "query",
+ "description": "Filters by 'hasChildren'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasStats",
+ "in": "query",
+ "description": "Filters by 'hasStats'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.ignoreAnalyzer",
+ "in": "query",
+ "description": "Filters by 'ignoreAnalyzer'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.issueComment",
+ "in": "query",
+ "description": "Filters by 'issueComment'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueGroupId",
+ "in": "query",
+ "description": "Filters by 'issueGroupId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueId",
+ "in": "query",
+ "description": "Filters by 'issueId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.issueType",
+ "in": "query",
+ "description": "Filters by 'issueType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueTypeId",
+ "in": "query",
+ "description": "Filters by 'issueTypeId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.key",
+ "in": "query",
+ "description": "Filters by 'key'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.levelAttribute",
+ "in": "query",
+ "description": "Filters by 'levelAttribute'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.locator",
+ "in": "query",
+ "description": "Filters by 'locator'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.parentId",
+ "in": "query",
+ "description": "Filters by 'parentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.patternName",
+ "in": "query",
+ "description": "Filters by 'patternName'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseHash",
+ "in": "query",
+ "description": "Filters by 'testCaseHash'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseId",
+ "in": "query",
+ "description": "Filters by 'testCaseId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.ticketId",
+ "in": "query",
+ "description": "Filters by 'ticketId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uniqueId",
+ "in": "query",
+ "description": "Filters by 'uniqueId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.value",
+ "in": "query",
+ "description": "Filters by 'value'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeSystemAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeSystemAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filterId",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "isLatest",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "launchesLimit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Update issues of specified test items",
+ "operationId": "defineTestItemIssueType",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DefineIssueRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Issue"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Start a root test item",
+ "operationId": "startRootItem_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Delete test items by specified ids",
+ "operationId": "deleteTestItems",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/{testItemId}": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Finish test item",
+ "operationId": "finishTestItem_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "testItemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FinishTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/{itemId}/update": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Update test item",
+ "operationId": "updateTestItem",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/suggest/choice": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Handle user choice from suggested items",
+ "operationId": "handleSuggestChoose",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SuggestInfo"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/issue/unlink": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Unlink external issue for specified test items",
+ "operationId": "unlinkExternalIssues",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnlinkExternalIssueRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/issue/link": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Attach external issue for specified test items",
+ "operationId": "linkExternalIssues",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LinkExternalIssueRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/info": {
+ "put": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Bulk update attributes and description",
+ "operationId": "bulkUpdate_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BulkInfoUpdateRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/filter": {
+ "get": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Get filters",
+ "operationId": "getAllFilters",
+ "parameters": [
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.owner",
+ "in": "query",
+ "description": "Filters by 'owner'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Update list of user filters",
+ "operationId": "updateUserFilters",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CollectionsRQBulkUpdateFilterRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Create user filter",
+ "operationId": "createFilter",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateUserFilterRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/filter/{filterId}": {
+ "get": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Get specified user filter by id",
+ "operationId": "getFilter",
+ "parameters": [
+ {
+ "name": "filterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserFilterResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Update specified user filter",
+ "operationId": "updateUserFilter",
+ "parameters": [
+ {
+ "name": "filterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateUserFilterRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Delete specified user filter by id",
+ "operationId": "deleteFilter",
+ "parameters": [
+ {
+ "name": "filterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/dashboard/{dashboardId}": {
+ "get": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Get specified dashboard by ID for specified project",
+ "operationId": "getDashboard",
+ "parameters": [
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DashboardResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Update specified dashboard for specified project",
+ "operationId": "updateDashboard",
+ "parameters": [
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateDashboardRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Delete specified dashboard by ID for specified project",
+ "operationId": "deleteDashboard",
+ "parameters": [
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/dashboard/{dashboardId}/add": {
+ "put": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Add widget to specified dashboard",
+ "operationId": "addWidget",
+ "parameters": [
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddWidgetRq"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get information about project",
+ "description": "Only for users that are assigned to the project",
+ "operationId": "getProject",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Update project",
+ "operationId": "updateProject",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateProjectRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/unassign": {
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Unassign users",
+ "operationId": "unassignProjectUsers",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UnassignUsersRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/preference/{filterId}": {
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Edit logged-in user preferences",
+ "description": "Only for logged-in user",
+ "operationId": "addUserPreference",
+ "parameters": [
+ {
+ "name": "filterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Delete logged-in user preferences",
+ "description": "Only for logged-in user",
+ "operationId": "removeUserPreference",
+ "parameters": [
+ {
+ "name": "filterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/notification": {
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Update project notifications configuration",
+ "operationId": "updateProjectNotificationConfig",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectNotificationConfigDTO"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/index": {
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Starts reindex all project data in ML",
+ "operationId": "indexProjectData",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Delete project index from ML",
+ "operationId": "deleteProjectIndex",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/assign": {
+ "put": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Assign users",
+ "operationId": "assignProjectUsers",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AssignUsersRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/{projectName}/{pluginName}/common/{command}": {
+ "put": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Execute command to the plugin instance",
+ "operationId": "executePluginCommand",
+ "parameters": [
+ {
+ "name": "command",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/{pluginId}": {
+ "put": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Update ReportPortal plugin state",
+ "operationId": "updatePluginState",
+ "parameters": [
+ {
+ "name": "pluginId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdatePluginStateRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Delete plugin by id",
+ "operationId": "deletePlugin",
+ "parameters": [
+ {
+ "name": "pluginId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/public/{pluginName}/{command}": {
+ "put": {
+ "tags": [
+ "plugin-public-controller"
+ ],
+ "summary": "Execute public command without authentication",
+ "operationId": "executePublicPluginCommand",
+ "parameters": [
+ {
+ "name": "command",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{projectName}/{integrationId}": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get integration instance",
+ "operationId": "getProjectIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Update project integration instance",
+ "operationId": "updateProjectIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Delete project integration instance",
+ "operationId": "deleteProjectIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{projectName}/{integrationId}/{command}": {
+ "put": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Execute command to the integration instance",
+ "operationId": "executeIntegrationCommand",
+ "parameters": [
+ {
+ "name": "command",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{integrationId}": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get global ReportPortal integration instance",
+ "operationId": "getGlobalIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Update global ReportPortal integration instance",
+ "operationId": "updateGlobalIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Delete global integration instance",
+ "operationId": "deleteGlobalIntegration",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/{login}": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Return information about specified user",
+ "description": "Only for administrators and profile's owner",
+ "operationId": "getUser",
+ "parameters": [
+ {
+ "name": "login",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Edit specified user",
+ "description": "Only for administrators and profile's owner",
+ "operationId": "editUser",
+ "parameters": [
+ {
+ "name": "login",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EditUserRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/log": {
+ "post": {
+ "tags": [
+ "log-async-controller"
+ ],
+ "summary": "Create Log",
+ "description": "Create log (batching operation)",
+ "operationId": "createLog",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "json_request_part"
+ ],
+ "type": "object",
+ "properties": {
+ "json_request_part": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SaveLogRQ"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BatchSaveOperatingRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/log/entry": {
+ "post": {
+ "tags": [
+ "log-async-controller"
+ ],
+ "summary": "Create Log Entry",
+ "description": "Create log",
+ "operationId": "createLogEntry",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SaveLogRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/launch": {
+ "post": {
+ "tags": [
+ "launch-async-controller"
+ ],
+ "summary": "Starts launch for specified project",
+ "operationId": "startLaunch",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartLaunchRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartLaunchRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/launch/merge": {
+ "post": {
+ "tags": [
+ "launch-async-controller"
+ ],
+ "summary": "Merge set of specified launches in common one",
+ "description": "This operation merges a set of launches into a common one. The IDs of the launches to be merged should be provided in the 'launches' field of the request body.",
+ "operationId": "mergeLaunches",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MergeLaunchesRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/item": {
+ "post": {
+ "tags": [
+ "test-item-async-controller"
+ ],
+ "summary": "Start Root Item",
+ "description": "Start a root test item",
+ "operationId": "startRootItem",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v2/{projectName}/item/{parentItem}": {
+ "post": {
+ "tags": [
+ "test-item-async-controller"
+ ],
+ "summary": "Start Child Item",
+ "description": "Start a child test item",
+ "operationId": "startChildItem",
+ "parameters": [
+ {
+ "name": "parentItem",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/widget": {
+ "post": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Create a new widget",
+ "operationId": "createWidget",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WidgetRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/widget/preview": {
+ "post": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Get widget preview",
+ "operationId": "getWidgetPreview",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WidgetPreviewRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/pattern": {
+ "post": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Create pattern template for items' log messages pattern analysis",
+ "operationId": "createPatternTemplate",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreatePatternTemplateRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get logs by filter",
+ "operationId": "getLogs",
+ "parameters": [
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.binaryContent",
+ "in": "query",
+ "description": "Filters by 'binaryContent'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.item",
+ "in": "query",
+ "description": "Filters by 'item'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launch",
+ "in": "query",
+ "description": "Filters by 'launch'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.level",
+ "in": "query",
+ "description": "Filters by 'level'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.logId",
+ "in": "query",
+ "description": "Filters by 'logId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.logTime",
+ "in": "query",
+ "description": "Filters by 'logTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.message",
+ "in": "query",
+ "description": "Filters by 'message'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentLaunchId",
+ "in": "query",
+ "description": "Filters by 'retryParentLaunchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.under.path",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LogResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Create log (batching operation)",
+ "operationId": "createLog_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "json_request_part"
+ ],
+ "type": "object",
+ "properties": {
+ "json_request_part": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SaveLogRQ"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BatchSaveOperatingRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/under": {
+ "post": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get logs under items",
+ "operationId": "getLogsUnder",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetLogsUnderRq"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LogResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/search/{itemId}": {
+ "post": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Search test items with similar error logs",
+ "operationId": "searchLogs",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchLogRq"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SearchLogRs"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/entry": {
+ "post": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Create log",
+ "operationId": "createLogEntry_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SaveLogRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get list of project launches by filter",
+ "operationId": "getProjectLaunches",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.number",
+ "in": "query",
+ "description": "Filters by 'number'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.userId",
+ "in": "query",
+ "description": "Filters by 'userId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Starts launch for specified project",
+ "operationId": "startLaunch_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartLaunchRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartLaunchRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Delete specified launches by ids",
+ "operationId": "deleteLaunches",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteBulkRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/merge": {
+ "post": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Merge set of specified launches in common one",
+ "description": "This operation merges a set of launches into a common one. The IDs of the launches to be merged should be provided in the 'launches' field of the request body.",
+ "operationId": "mergeLaunches_1",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MergeLaunchesRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/cluster": {
+ "post": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Create launch clusters",
+ "operationId": "createClusters",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateClustersRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/analyze": {
+ "post": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Start launch auto-analyzer on demand",
+ "operationId": "startLaunchAnalyzer",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnalyzeLaunchRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/{parentItem}": {
+ "post": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Start a child test item",
+ "operationId": "startChildItem_1",
+ "parameters": [
+ {
+ "name": "parentItem",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StartTestItemRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedAsyncRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/dashboard": {
+ "get": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Get all permitted dashboard resources for specified project",
+ "operationId": "getAllDashboards",
+ "parameters": [
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.owner",
+ "in": "query",
+ "description": "Filters by 'owner'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DashboardResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Create dashboard for specified project",
+ "operationId": "createDashboard",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateDashboardRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project": {
+ "post": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Create new project",
+ "operationId": "createProject",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateProjectRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Delete multiple projects",
+ "description": "Could be deleted only by users with administrator role",
+ "operationId": "deleteProject",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteBulkRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin": {
+ "get": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Get all available plugins",
+ "operationId": "getPlugins",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationTypeResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Upload new ReportPortal plugin",
+ "operationId": "uploadPlugin",
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "file"
+ ],
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/{projectName}/{pluginName}/import": {
+ "post": {
+ "tags": [
+ "plugin-controller"
+ ],
+ "summary": "Send report to the specified plugin for importing",
+ "operationId": "executeImportPluginCommand",
+ "parameters": [
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "file"
+ ],
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary"
+ },
+ "launchImportRq": {
+ "$ref": "#/components/schemas/LaunchImportRQ"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{projectName}/{pluginName}": {
+ "post": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Create project ReportPortal integration instance",
+ "operationId": "createProjectIntegration",
+ "parameters": [
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{pluginName}": {
+ "post": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Create global ReportPortal integration instance",
+ "operationId": "createGlobalIntegration",
+ "parameters": [
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IntegrationRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EntryCreatedRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/demo/{projectName}/generate": {
+ "post": {
+ "tags": [
+ "demo-data-controller"
+ ],
+ "summary": "generate",
+ "operationId": "generate",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DemoDataRq"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DemoDataRs"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/data/photo": {
+ "get": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Get photo of current user",
+ "operationId": "getMyPhoto",
+ "parameters": [
+ {
+ "name": "loadThumbnail",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Upload user's photo",
+ "operationId": "uploadPhoto",
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "file"
+ ],
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Delete user's photo",
+ "operationId": "deletePhoto",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/data/clean": {
+ "post": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Remove attachments from file storage according to uploaded csv file",
+ "operationId": "removeAttachmentsByCsv",
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "file"
+ ],
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/bts/{projectName}/{integrationId}/ticket": {
+ "post": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Post ticket to the bts integration",
+ "operationId": "createIssue",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PostTicketRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Ticket"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/activities/searches": {
+ "post": {
+ "tags": [
+ "activity-event-controller"
+ ],
+ "summary": "Get activities by search criteria",
+ "operationId": "getActivities",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "maximum": 300,
+ "minimum": 0,
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "minimum": 0,
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "order",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "ASC",
+ "DESC"
+ ]
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SearchCriteriaRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PagedResponseActivityEventResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Return information about current logged-in user",
+ "operationId": "getMyself",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Create specified user",
+ "description": "Allowable only for users with administrator role",
+ "operationId": "createUserByAdmin",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRQFull"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Delete specified users by ids",
+ "operationId": "deleteUsers",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteBulkRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/{userId}/api-keys": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Get List of users Api Keys",
+ "operationId": "getUsersApiKeys",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiKeysRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Create new Api Key for current user",
+ "operationId": "createApiKey",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiKeyRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiKeyRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/registration": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Get User Bid Info",
+ "operationId": "getUserBidInfo",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserBidRS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Activate invitation and create user in system",
+ "operationId": "createUser",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRQConfirm"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/password/restore": {
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Create a restore password request",
+ "operationId": "restorePassword",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RestorePasswordRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/password/reset": {
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Reset password",
+ "operationId": "resetPassword",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResetPasswordRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/password/change": {
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Change own password",
+ "operationId": "changePassword",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ChangePasswordRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/bid": {
+ "post": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Register invitation for user who will be created",
+ "operationId": "createUserBid",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateUserBidRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/widget/names/all": {
+ "get": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Load all widget names which belong to a user",
+ "operationId": "getWidgetNames",
+ "parameters": [
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.owner",
+ "in": "query",
+ "description": "Filters by 'owner'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/widget/multilevel/{widgetId}": {
+ "get": {
+ "tags": [
+ "widget-controller"
+ ],
+ "summary": "Get multilevel widget by ID",
+ "operationId": "getWidget_1",
+ "parameters": [
+ {
+ "name": "attributes",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "params",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "$ref": "#/components/schemas/MultiValueMapStringString"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "widgetId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WidgetResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings": {
+ "get": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Get project specific issue sub-types",
+ "description": "Only for users that are assigned to the project",
+ "operationId": "getProjectSettings",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectSettingsResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/{logId}": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get log by ID",
+ "operationId": "getLog",
+ "parameters": [
+ {
+ "name": "logId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LogResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Delete log",
+ "operationId": "deleteLog",
+ "parameters": [
+ {
+ "name": "logId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/{logId}/page": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get logs by filter",
+ "operationId": "getPageNumber",
+ "parameters": [
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.binaryContent",
+ "in": "query",
+ "description": "Filters by 'binaryContent'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.item",
+ "in": "query",
+ "description": "Filters by 'item'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launch",
+ "in": "query",
+ "description": "Filters by 'launch'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.level",
+ "in": "query",
+ "description": "Filters by 'level'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.logId",
+ "in": "query",
+ "description": "Filters by 'logId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.logTime",
+ "in": "query",
+ "description": "Filters by 'logTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.message",
+ "in": "query",
+ "description": "Filters by 'message'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentLaunchId",
+ "in": "query",
+ "description": "Filters by 'retryParentLaunchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "logId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/uuid/{logId}": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get log by UUID (Will be removed in version 6.0)",
+ "operationId": "getLogByUuid",
+ "parameters": [
+ {
+ "name": "logId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LogResource"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true
+ }
+ },
+ "/v1/{projectName}/log/nested/{parentId}": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get nested steps with logs for the parent Test Item",
+ "operationId": "getNestedItems",
+ "parameters": [
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.binaryContent",
+ "in": "query",
+ "description": "Filters by 'binaryContent'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.item",
+ "in": "query",
+ "description": "Filters by 'item'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launch",
+ "in": "query",
+ "description": "Filters by 'launch'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.level",
+ "in": "query",
+ "description": "Filters by 'level'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.logId",
+ "in": "query",
+ "description": "Filters by 'logId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.logTime",
+ "in": "query",
+ "description": "Filters by 'logTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.message",
+ "in": "query",
+ "description": "Filters by 'message'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentLaunchId",
+ "in": "query",
+ "description": "Filters by 'retryParentLaunchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "params",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "parentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/log/locations/{parentId}": {
+ "get": {
+ "tags": [
+ "log-controller"
+ ],
+ "summary": "Get next or previous log in test item",
+ "operationId": "getErrorPage",
+ "parameters": [
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.binaryContent",
+ "in": "query",
+ "description": "Filters by 'binaryContent'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.item",
+ "in": "query",
+ "description": "Filters by 'item'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launch",
+ "in": "query",
+ "description": "Filters by 'launch'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.level",
+ "in": "query",
+ "description": "Filters by 'level'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.logId",
+ "in": "query",
+ "description": "Filters by 'logId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.logTime",
+ "in": "query",
+ "description": "Filters by 'logTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.message",
+ "in": "query",
+ "description": "Filters by 'message'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentLaunchId",
+ "in": "query",
+ "description": "Filters by 'retryParentLaunchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "params",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "parentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PagedLogResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/{launchId}": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get specified launch by ID",
+ "operationId": "getLaunch",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Delete specified launch by ID",
+ "operationId": "deleteLaunch",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/{launchId}/report": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Export specified launch",
+ "description": "Only following formats are supported: pdf (by default), xls, html.",
+ "operationId": "getLaunchReport",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "view",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "pdf",
+ "xls",
+ "html"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/uuid/{launchId}": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get specified launch by UUID",
+ "operationId": "getLaunchByUuid",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/status": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get Statuses",
+ "operationId": "getStatuses",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/owners": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get all unique owners of project launches",
+ "operationId": "getAllOwners",
+ "parameters": [
+ {
+ "name": "filter.cnt.user",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "DEFAULT"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/names": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get launch names of project",
+ "operationId": "getAllLaunchNames",
+ "parameters": [
+ {
+ "name": "filter.cnt.name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/mode": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get launches of specified project from DEBUG mode",
+ "operationId": "getDebugLaunches",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.number",
+ "in": "query",
+ "description": "Filters by 'number'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.userId",
+ "in": "query",
+ "description": "Filters by 'userId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/latest": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get list of latest project launches by filter",
+ "operationId": "getLatestLaunches",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.number",
+ "in": "query",
+ "description": "Filters by 'number'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.userId",
+ "in": "query",
+ "description": "Filters by 'userId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LaunchResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/compare": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Compare launches",
+ "operationId": "compareLaunches",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ChartStatisticsContent"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/cluster/{launchId}": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get all index clusters of the launch",
+ "operationId": "getClusters",
+ "parameters": [
+ {
+ "name": "launchId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ClusterInfoResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/attribute/values": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get all unique attribute values of project launches",
+ "operationId": "getAttributeValues",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeValue",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/launch/attribute/keys": {
+ "get": {
+ "tags": [
+ "launch-controller"
+ ],
+ "summary": "Get all unique attribute keys of project launches",
+ "operationId": "getAttributeKeys",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeKey",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/{itemId}": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Find test item by ID",
+ "operationId": "getTestItem",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Delete test item",
+ "operationId": "deleteTestItem",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/v2": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Find test items by specified filter",
+ "operationId": "getTestItemsV2",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.clusterId",
+ "in": "query",
+ "description": "Filters by 'clusterId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.duration",
+ "in": "query",
+ "description": "Filters by 'duration'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasChildren",
+ "in": "query",
+ "description": "Filters by 'hasChildren'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasStats",
+ "in": "query",
+ "description": "Filters by 'hasStats'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.ignoreAnalyzer",
+ "in": "query",
+ "description": "Filters by 'ignoreAnalyzer'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.issueComment",
+ "in": "query",
+ "description": "Filters by 'issueComment'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueGroupId",
+ "in": "query",
+ "description": "Filters by 'issueGroupId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueId",
+ "in": "query",
+ "description": "Filters by 'issueId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.issueType",
+ "in": "query",
+ "description": "Filters by 'issueType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueTypeId",
+ "in": "query",
+ "description": "Filters by 'issueTypeId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.key",
+ "in": "query",
+ "description": "Filters by 'key'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.levelAttribute",
+ "in": "query",
+ "description": "Filters by 'levelAttribute'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.locator",
+ "in": "query",
+ "description": "Filters by 'locator'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.parentId",
+ "in": "query",
+ "description": "Filters by 'parentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.patternName",
+ "in": "query",
+ "description": "Filters by 'patternName'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseHash",
+ "in": "query",
+ "description": "Filters by 'testCaseHash'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseId",
+ "in": "query",
+ "description": "Filters by 'testCaseId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.ticketId",
+ "in": "query",
+ "description": "Filters by 'ticketId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uniqueId",
+ "in": "query",
+ "description": "Filters by 'uniqueId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.value",
+ "in": "query",
+ "description": "Filters by 'value'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeSystemAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeSystemAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "params",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/uuid/{itemId}": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Find test item by UUID",
+ "operationId": "getTestItemByUuid",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/ticket/ids": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get tickets that contains a term as a part inside for specified launch",
+ "operationId": "getTicketIds",
+ "parameters": [
+ {
+ "name": "launch",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "term",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/ticket/ids/all": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get tickets that contains a term as a part inside for specified launch",
+ "operationId": "getTicketIdsForProject",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "term",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/suggest/{itemId}": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Search suggested items in analyzer for provided one",
+ "operationId": "getSuggestedItems",
+ "parameters": [
+ {
+ "name": "itemId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SuggestedItem"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/suggest/cluster/{clusterId}": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Search suggested items in analyzer for provided one",
+ "operationId": "getSuggestedClusterItems",
+ "parameters": [
+ {
+ "name": "clusterId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SuggestedItem"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/step/attribute/values": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get all unique attribute values of step items under specified project",
+ "operationId": "getAttributeValues_1",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeValue",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/step/attribute/keys": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get all unique attribute keys of step items under specified project",
+ "operationId": "getAttributeKeys_1",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeKey",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/statistics": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Find accumulated statistics of items by specified filter",
+ "operationId": "getTestItems_1",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.clusterId",
+ "in": "query",
+ "description": "Filters by 'clusterId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.duration",
+ "in": "query",
+ "description": "Filters by 'duration'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasChildren",
+ "in": "query",
+ "description": "Filters by 'hasChildren'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasStats",
+ "in": "query",
+ "description": "Filters by 'hasStats'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.ignoreAnalyzer",
+ "in": "query",
+ "description": "Filters by 'ignoreAnalyzer'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.issueComment",
+ "in": "query",
+ "description": "Filters by 'issueComment'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueGroupId",
+ "in": "query",
+ "description": "Filters by 'issueGroupId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueId",
+ "in": "query",
+ "description": "Filters by 'issueId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.issueType",
+ "in": "query",
+ "description": "Filters by 'issueType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueTypeId",
+ "in": "query",
+ "description": "Filters by 'issueTypeId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.key",
+ "in": "query",
+ "description": "Filters by 'key'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.levelAttribute",
+ "in": "query",
+ "description": "Filters by 'levelAttribute'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.locator",
+ "in": "query",
+ "description": "Filters by 'locator'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.parentId",
+ "in": "query",
+ "description": "Filters by 'parentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.patternName",
+ "in": "query",
+ "description": "Filters by 'patternName'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseHash",
+ "in": "query",
+ "description": "Filters by 'testCaseHash'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseId",
+ "in": "query",
+ "description": "Filters by 'testCaseId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.ticketId",
+ "in": "query",
+ "description": "Filters by 'ticketId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uniqueId",
+ "in": "query",
+ "description": "Filters by 'uniqueId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.value",
+ "in": "query",
+ "description": "Filters by 'value'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeSystemAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeSystemAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "params",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/StatisticsResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/items": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get test items by specified ids",
+ "operationId": "getTestItems_2",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/history": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Load history of test items",
+ "operationId": "getItemsHistory",
+ "parameters": [
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "description": "Filters by 'attributeKey'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.attributeValue",
+ "in": "query",
+ "description": "Filters by 'attributeValue'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.autoAnalyzed",
+ "in": "query",
+ "description": "Filters by 'autoAnalyzed'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.clusterId",
+ "in": "query",
+ "description": "Filters by 'clusterId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.description",
+ "in": "query",
+ "description": "Filters by 'description'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.duration",
+ "in": "query",
+ "description": "Filters by 'duration'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.endTime",
+ "in": "query",
+ "description": "Filters by 'endTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.hasChildren",
+ "in": "query",
+ "description": "Filters by 'hasChildren'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasRetries",
+ "in": "query",
+ "description": "Filters by 'hasRetries'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.hasStats",
+ "in": "query",
+ "description": "Filters by 'hasStats'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.ignoreAnalyzer",
+ "in": "query",
+ "description": "Filters by 'ignoreAnalyzer'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.issueComment",
+ "in": "query",
+ "description": "Filters by 'issueComment'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueGroupId",
+ "in": "query",
+ "description": "Filters by 'issueGroupId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueId",
+ "in": "query",
+ "description": "Filters by 'issueId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.issueType",
+ "in": "query",
+ "description": "Filters by 'issueType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.issueTypeId",
+ "in": "query",
+ "description": "Filters by 'issueTypeId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.key",
+ "in": "query",
+ "description": "Filters by 'key'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.lastModified",
+ "in": "query",
+ "description": "Filters by 'lastModified'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.launchId",
+ "in": "query",
+ "description": "Filters by 'launchId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.levelAttribute",
+ "in": "query",
+ "description": "Filters by 'levelAttribute'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.locator",
+ "in": "query",
+ "description": "Filters by 'locator'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.mode",
+ "in": "query",
+ "description": "Filters by 'mode'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.parentId",
+ "in": "query",
+ "description": "Filters by 'parentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.path",
+ "in": "query",
+ "description": "Filters by 'path'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.patternName",
+ "in": "query",
+ "description": "Filters by 'patternName'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.retryParentId",
+ "in": "query",
+ "description": "Filters by 'retryParentId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.startTime",
+ "in": "query",
+ "description": "Filters by 'startTime'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$automation_bug$ab001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$automation_bug$ab001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$no_defect$nd001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$no_defect$nd001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$product_bug$pb001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$product_bug$pb001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$system_issue$si001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$system_issue$si001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$defects$to_investigate$ti001",
+ "in": "query",
+ "description": "Filters by 'statistics$defects$to_investigate$ti001'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$failed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$failed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$passed",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$passed'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$skipped",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$skipped'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.statistics$executions$total",
+ "in": "query",
+ "description": "Filters by 'statistics$executions$total'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.status",
+ "in": "query",
+ "description": "Filters by 'status'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseHash",
+ "in": "query",
+ "description": "Filters by 'testCaseHash'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.testCaseId",
+ "in": "query",
+ "description": "Filters by 'testCaseId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.ticketId",
+ "in": "query",
+ "description": "Filters by 'ticketId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uniqueId",
+ "in": "query",
+ "description": "Filters by 'uniqueId'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.uuid",
+ "in": "query",
+ "description": "Filters by 'uuid'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.value",
+ "in": "query",
+ "description": "Filters by 'value'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.has.compositeSystemAttribute",
+ "in": "query",
+ "description": "Filters by 'compositeSystemAttribute'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filterId",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "historyDepth",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 5
+ }
+ },
+ {
+ "name": "isLatest",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "launchesLimit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "type",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemHistoryElement"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/attribute/values": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get all unique attribute values of specified launch",
+ "operationId": "getAttributeValues_2",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeValue",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.attributeKey",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "launch",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/attribute/keys": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get all unique attribute keys of specified launch",
+ "operationId": "getAttributeKeys_2",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeKey",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "launch",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/item/attribute/keys/all": {
+ "get": {
+ "tags": [
+ "test-item-controller"
+ ],
+ "summary": "Get all unique attribute keys of specified launch",
+ "operationId": "getAttributeKeysForProject",
+ "parameters": [
+ {
+ "name": "filter.cnt.attributeKey",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filterId",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "isLatest",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "launchesLimit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/filter/names": {
+ "get": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Get available filter names",
+ "operationId": "getAllFiltersNames",
+ "parameters": [
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.owner",
+ "in": "query",
+ "description": "Filters by 'owner'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OwnedEntityResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/filter/filters": {
+ "get": {
+ "tags": [
+ "user-filter-controller"
+ ],
+ "summary": "Get list of specified user filters",
+ "operationId": "getUserFilters",
+ "parameters": [
+ {
+ "name": "ids",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/activity/{activityId}": {
+ "get": {
+ "tags": [
+ "activity-controller"
+ ],
+ "summary": "Get an activity by its ID in a specific project",
+ "description": "Fetches the activity details by its ID for a specific project.",
+ "operationId": "getActivity",
+ "parameters": [
+ {
+ "name": "activityId",
+ "in": "path",
+ "description": "The ID of the activity to be searched",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "description": "The name of the project for which the activity should be searched",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful operation. Returns the Activity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActivityResource"
+ },
+ "examples": {
+ "Successful operation": {
+ "description": "Successful operation",
+ "value": {
+ "id": 1,
+ "user": "superadmin",
+ "loggedObjectId": 22,
+ "lastModified": "2024-03-29T15:03:54.156904Z",
+ "actionType": "finishLaunch",
+ "objectType": "LAUNCH",
+ "projectId": 1,
+ "details": {
+ "history": []
+ },
+ "objectName": "1 step (failed) - filled description"
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Bad request": {
+ "description": "Bad request",
+ "value": {
+ "timestamp": "2024-05-20T07:12:15.698+00:00",
+ "status": 400,
+ "error": "Bad Request",
+ "path": "/v1/superadmin_personal/activity/1test"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Unauthorized": {
+ "description": "Unauthorized",
+ "value": {
+ "error": "unauthorized",
+ "error_description": "Full authentication is required to access this resource."
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Access Denied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Access Denied": {
+ "description": "Access Denied",
+ "value": {
+ "error": "access_denied",
+ "error_description": "You do not have enough permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Activity not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Activity not found": {
+ "description": "Activity not found",
+ "value": {
+ "errorCode": 40411,
+ "message": "Activity '1' not found. Did you use correct Activity ID?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Unclassified error": {
+ "description": "Unclassified error",
+ "value": {
+ "errorCode": 5000,
+ "message": "Unclassified error"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/activity/item/{itemId}": {
+ "get": {
+ "tags": [
+ "activity-controller"
+ ],
+ "summary": "Get a list of item activities for a specific project",
+ "description": "Fetches a list of item activities for a specific project.\nAction field can have these values:
\n\n- 'create'
\n- 'update'
\n- 'delete'
\n- 'bulkCreate'
\n- 'bulkUpdate'
\n- 'bulkDelete'
\n- 'analyze'
\n- 'start'
\n- 'finish'
\n- 'post'
\n- 'link'
\n- 'unlink'
\n- 'assign'
\n- 'unassign'
\n- 'generate'
\n- 'match'
\n- 'changeRole'
\n- 'updateUserRole'
\n
\nPriority field can have these values:
\n\n- 'critical'
\n- 'high'
\n- 'medium'
\n- 'low'
\n- 'info'
\n
\nObject type field can have these values:
\n\n- 'launch'
\n- 'dashboard'
\n- 'defectType'
\n- 'emailConfig'
\n- 'filter'
\n- 'import'
\n- 'integration'
\n- 'itemIssue'
\n- 'project'
\n- 'sharing'
\n- 'user'
\n- 'widget'
\n- 'pattern'
\n- 'index'
\n- 'plugin'
\n- 'invitationLink'
\n
\nSubject type field can have these values:
\n\n- 'user'
\n- 'application'
\n- 'rule'
\n- 'custom'
\n
\n You can filter by different operators:
\n\n- eq (Equals condition)
\n- ne (Not equals condition)
\n- cnt (Contains condition)
\n- under
\n- level (Number of labels in path)
\n- ex (Exists condition)
\n- in (Accepts filter value as comma-separated list)
\n- ea (Equals any. Accepts filter value as comma-separated list)
\n- has (Accepts filter value as comma-separated list. Returns 'TRUE' of all\nprovided values exist in collection)
\n- any (Overlap condition between two arrays)
\n- gt (Greater than condition)
\n- gte (Greater than or Equals condition)
\n- lt (Lower than condition)
\n- lte (Lower than or Equals condition)
\n- btw (Between condition. Include boundaries. 'Between' condition applicable only for\npositive Numbers, Dates or specific TimeStamp values)
\n
\n",
+ "operationId": "getTestItemActivities",
+ "parameters": [
+ {
+ "name": "filter.eq.action",
+ "in": "query",
+ "description": "Filters by 'action'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.createdAt",
+ "in": "query",
+ "description": "Filters by 'createdAt'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.eventName",
+ "in": "query",
+ "description": "Filters by 'eventName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.objectId",
+ "in": "query",
+ "description": "Filters by 'objectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.objectName",
+ "in": "query",
+ "description": "Filters by 'objectName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.objectType",
+ "in": "query",
+ "description": "Filters by 'objectType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.priority",
+ "in": "query",
+ "description": "Filters by 'priority'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.projectName",
+ "in": "query",
+ "description": "Filters by 'projectName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.subjectId",
+ "in": "query",
+ "description": "Filters by 'subjectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.subjectName",
+ "in": "query",
+ "description": "Filters by 'subjectName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.subjectType",
+ "in": "query",
+ "description": "Filters by 'subjectType'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "itemId",
+ "in": "path",
+ "description": "The ID of the test item for which all its activities should be searched",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "description": "The name of the project for which the activities should be searched",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful operation. Returns a list of activities.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Page"
+ },
+ "examples": {
+ "Successful operation": {
+ "description": "Successful operation",
+ "value": {
+ "content": [
+ {
+ "id": 1,
+ "created_at": "2024-03-29T12:29:54.772Z",
+ "event_name": "updateItem",
+ "object_id": 1153,
+ "object_name": "Step-1(A)",
+ "object_type": "itemIssue",
+ "project_id": 1,
+ "project_name": "superadmin_personal",
+ "subject_name": "superadmin",
+ "subject_type": "user",
+ "subject_id": "1",
+ "details": {
+ "history": [
+ {
+ "field": "status",
+ "oldValue": "SKIPPED",
+ "newValue": "FAILED"
+ }
+ ]
+ }
+ }
+ ],
+ "page": {
+ "number": 1,
+ "size": 20,
+ "totalElements": 1,
+ "totalPages": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Bad request": {
+ "description": "Bad request",
+ "value": {
+ "timestamp": "2024-05-20T07:03:53.007+00:00",
+ "status": 400,
+ "error": "Bad Request",
+ "path": "/v1/superadmin_personal/activity/item/1test"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Unauthorized": {
+ "description": "Unauthorized",
+ "value": {
+ "error": "unauthorized",
+ "error_description": "Full authentication is required to access this resource."
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Access Denied",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Access Denied": {
+ "description": "Access Denied",
+ "value": {
+ "error": "access_denied",
+ "error_description": "You do not have enough permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Test item not found or Launch not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorRS"
+ },
+ "examples": {
+ "Test item not found": {
+ "description": "Test item not found",
+ "value": {
+ "errorCode": 4043,
+ "message": "Test Item '1' not found. Did you use correct Test Item ID?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string",
+ "enum": [
+ "INCORRECT_REQUEST",
+ "BINARY_DATA_CANNOT_BE_SAVED",
+ "ACCESS_DENIED",
+ "ADDRESS_LOCKED",
+ "PROJECT_NOT_FOUND",
+ "LAUNCH_NOT_FOUND",
+ "TEST_SUITE_NOT_FOUND",
+ "TEST_ITEM_NOT_FOUND",
+ "LOG_NOT_FOUND",
+ "ROLE_NOT_FOUND",
+ "USER_NOT_FOUND",
+ "WIDGET_NOT_FOUND",
+ "WIDGET_NOT_FOUND_IN_DASHBOARD",
+ "DASHBOARD_NOT_FOUND",
+ "USER_FILTER_NOT_FOUND",
+ "ACTIVITY_NOT_FOUND",
+ "UNABLE_TO_CREATE_WIDGET",
+ "INTEGRATION_NOT_FOUND",
+ "PROJECT_NOT_CONFIGURED",
+ "SERVER_SETTINGS_NOT_FOUND",
+ "ISSUE_TYPE_NOT_FOUND",
+ "PROJECT_SETTINGS_NOT_FOUND",
+ "TICKET_NOT_FOUND",
+ "AUTH_INTEGRATION_NOT_FOUND",
+ "WIDGET_NOT_FOUND_IN_PROJECT",
+ "USER_FILTER_NOT_FOUND_IN_PROJECT",
+ "DASHBOARD_NOT_FOUND_IN_PROJECT",
+ "PATTERN_TEMPLATE_NOT_FOUND_IN_PROJECT",
+ "TEST_ITEM_OR_LAUNCH_NOT_FOUND",
+ "ANALYZER_NOT_FOUND",
+ "ATTACHMENT_NOT_FOUND",
+ "UNABLE_TO_LOAD_BINARY_DATA",
+ "CLUSTER_NOT_FOUND",
+ "ORGANIZATION_NOT_FOUND",
+ "NOT_FOUND",
+ "INCORRECT_FILTER_PARAMETERS",
+ "INCORRECT_SORTING_PARAMETERS",
+ "INCORRECT_INTEGRATION_NAME",
+ "UNABLE_MODIFY_SHARABLE_RESOURCE",
+ "INCORRECT_AUTHENTICATION_TYPE",
+ "UNABLE_POST_TICKET",
+ "UNABLE_INTERACT_WITH_INTEGRATION",
+ "UNABLE_ASSIGN_UNASSIGN_USER_TO_PROJECT",
+ "EMAIL_CONFIGURATION_IS_INCORRECT",
+ "PROJECT_UPDATE_NOT_ALLOWED",
+ "UNABLE_TO_UPDATE_YOURSELF_ROLE",
+ "FORBIDDEN_OPERATION",
+ "RESOURCE_ALREADY_EXISTS",
+ "ROLE_ALREADY_EXISTS_ERROR",
+ "USER_ALREADY_EXISTS",
+ "USER_FILTER_ALREADY_EXISTS",
+ "PROJECT_ALREADY_EXISTS",
+ "DASHBOARD_UPDATE_ERROR",
+ "UNABLE_LOAD_WIDGET_CONTENT",
+ "UNABLE_ADD_TO_FAVORITE",
+ "INTEGRATION_ALREADY_EXISTS",
+ "SERVER_SETTINGS_ALREADY_EXISTS",
+ "UNABLE_REMOVE_FROM_FAVORITE",
+ "LAUNCH_IS_NOT_FINISHED",
+ "TEST_ITEM_IS_NOT_FINISHED",
+ "INCORRECT_FINISH_STATUS",
+ "BAD_REQUEST_ERROR",
+ "BAD_SAVE_LOG_REQUEST",
+ "REPORTING_ITEM_ALREADY_FINISHED",
+ "AMBIGUOUS_TEST_ITEM_STATUS",
+ "FAILED_TEST_ITEM_ISSUE_TYPE_DEFINITION",
+ "FINISH_TIME_EARLIER_THAN_START_TIME",
+ "FINISH_ITEM_NOT_ALLOWED",
+ "FINISH_LAUNCH_NOT_ALLOWED",
+ "START_ITEM_NOT_ALLOWED",
+ "CHILD_START_TIME_EARLIER_THAN_PARENT",
+ "UNSUPPORTED_TEST_ITEM_TYPE",
+ "LOGGING_IS_NOT_ALLOWED",
+ "BAD_SAVE_WIDGET_REQUEST",
+ "BAD_UPDATE_WIDGET_REQUEST",
+ "UNABLE_LOAD_TEST_ITEM_HISTORY",
+ "BAD_SAVE_USER_FILTER_REQUEST",
+ "RETRIES_HANDLER_ERROR",
+ "IMPORT_FILE_ERROR",
+ "PARSING_XML_ERROR",
+ "OBJECT_RETRIEVAL_ERROR",
+ "PLUGIN_UPLOAD_ERROR",
+ "PLUGIN_REMOVE_ERROR",
+ "UNABLE_TO_SAVE_CHILD_ITEM_FOR_THE_RETRY",
+ "PATTERN_ANALYSIS_ERROR",
+ "PROJECT_DOESNT_CONTAIN_USER",
+ "UNCLASSIFIED_REPORT_PORTAL_ERROR",
+ "BAD_UPDATE_PREFERENCE_REQUEST",
+ "UNSUPPORTED_MERGE_STRATEGY_TYPE",
+ "DEMO_DATA_GENERATION_ERROR",
+ "UNCLASSIFIED_ERROR"
+ ]
+ },
+ "examples": {
+ "Unclassified error": {
+ "description": "Unclassified error",
+ "value": {
+ "errorCode": 5000,
+ "message": "Unclassified error"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/settings": {
+ "get": {
+ "tags": [
+ "settings-controller"
+ ],
+ "summary": "Get server settings",
+ "operationId": "getServerSettings",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/widget/{widgetCode}": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get Project Widget",
+ "operationId": "getProjectWidget",
+ "parameters": [
+ {
+ "name": "interval",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "3M"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "widgetCode",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/users": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get users assigned on current project",
+ "operationId": "getProjectUsers",
+ "parameters": [
+ {
+ "name": "filter.eq.email",
+ "in": "query",
+ "description": "Filters by 'email'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.expired",
+ "in": "query",
+ "description": "Filters by 'expired'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.fullName",
+ "in": "query",
+ "description": "Filters by 'fullName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastLogin",
+ "in": "query",
+ "description": "Filters by 'lastLogin'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.project",
+ "in": "query",
+ "description": "Filters by 'project'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.role",
+ "in": "query",
+ "description": "Filters by 'role'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.synchronizationDate",
+ "in": "query",
+ "description": "Filters by 'synchronizationDate'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/usernames": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Load project users by filter",
+ "description": "Only for users that are members of the project",
+ "operationId": "getProjectUsers_1",
+ "parameters": [
+ {
+ "name": "filter.cnt.users",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/usernames/search": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Search For User",
+ "operationId": "searchForUser",
+ "parameters": [
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "term",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SearchUserResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/preference": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Load logged-in user preferences",
+ "description": "Only for logged-in user",
+ "operationId": "getUserPreference",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PreferenceResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectName}/assignable": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Load users which can be assigned to specified project",
+ "description": "Only for users with project manager permissions",
+ "operationId": "getUsersForAssign",
+ "parameters": [
+ {
+ "name": "filter.eq.email",
+ "in": "query",
+ "description": "Filters by 'email'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.expired",
+ "in": "query",
+ "description": "Filters by 'expired'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.fullName",
+ "in": "query",
+ "description": "Filters by 'fullName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastLogin",
+ "in": "query",
+ "description": "Filters by 'lastLogin'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.project",
+ "in": "query",
+ "description": "Filters by 'project'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.role",
+ "in": "query",
+ "description": "Filters by 'role'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.synchronizationDate",
+ "in": "query",
+ "description": "Filters by 'synchronizationDate'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/names": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get All Project Names",
+ "operationId": "getAllProjectNames",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/names/search": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Search Project Names",
+ "operationId": "searchProjectNames",
+ "parameters": [
+ {
+ "name": "term",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/list": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get All Projects Info",
+ "operationId": "getAllProjectsInfo",
+ "parameters": [
+ {
+ "name": "filter.eq.creationDate",
+ "in": "query",
+ "description": "Filters by 'creationDate'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastRun",
+ "in": "query",
+ "description": "Filters by 'lastRun'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launchesQuantity",
+ "in": "query",
+ "description": "Filters by 'launchesQuantity'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.organization",
+ "in": "query",
+ "description": "Filters by 'organization'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.usersQuantity",
+ "in": "query",
+ "description": "Filters by 'usersQuantity'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ProjectInfoResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/list/{projectName}": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get Project Info",
+ "operationId": "getProjectInfo",
+ "parameters": [
+ {
+ "name": "interval",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "3M"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectInfoResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/export": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Exports information about all projects",
+ "description": "Allowable only for users with administrator role",
+ "operationId": "exportProjects",
+ "parameters": [
+ {
+ "name": "filter.eq.creationDate",
+ "in": "query",
+ "description": "Filters by 'creationDate'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastRun",
+ "in": "query",
+ "description": "Filters by 'lastRun'",
+ "schema": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ {
+ "name": "filter.eq.launchesQuantity",
+ "in": "query",
+ "description": "Filters by 'launchesQuantity'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.name",
+ "in": "query",
+ "description": "Filters by 'name'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.organization",
+ "in": "query",
+ "description": "Filters by 'organization'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.usersQuantity",
+ "in": "query",
+ "description": "Filters by 'usersQuantity'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "view",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "csv"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/v1/project/analyzer/status": {
+ "get": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Get Analyzer Indexing Status",
+ "operationId": "getAnalyzerIndexingStatus",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/public": {
+ "get": {
+ "tags": [
+ "plugin-public-controller"
+ ],
+ "summary": "Get all available public plugins",
+ "operationId": "getPlugins_1",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationTypeResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/plugin/public/{pluginName}/file/{name}": {
+ "get": {
+ "tags": [
+ "plugin-public-controller"
+ ],
+ "summary": "Get public plugin file without authentication",
+ "operationId": "getPublicFile",
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/v1/onboarding": {
+ "get": {
+ "tags": [
+ "onboarding-controller"
+ ],
+ "summary": "Return onboarding information for page if available, -1 otherwise",
+ "operationId": "onBoarding",
+ "parameters": [
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "GENERAL"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{projectName}/{integrationId}/connection/test": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Test connection to the integration through the project config",
+ "operationId": "testIntegrationConnection",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{integrationId}/connection/test": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Test connection to the global integration",
+ "operationId": "testIntegrationConnection_1",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/project/{projectName}/all": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get available project integrations",
+ "operationId": "getProjectIntegrations",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/project/{projectName}/all/{pluginName}": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get available project integrations for plugin",
+ "operationId": "getProjectIntegrations_1",
+ "parameters": [
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/global/all": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get available global integrations",
+ "operationId": "getGlobalIntegrations",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/global/all/{pluginName}": {
+ "get": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Get available global integrations for plugin",
+ "operationId": "getGlobalIntegrations_1",
+ "parameters": [
+ {
+ "name": "pluginName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/data/{projectName}/{dataId}": {
+ "get": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Get file",
+ "operationId": "getFile",
+ "parameters": [
+ {
+ "name": "dataId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/v1/data/{projectName}/userphoto": {
+ "get": {
+ "tags": [
+ "file-storage-controller"
+ ],
+ "summary": "Get user's photo",
+ "operationId": "getUserPhoto",
+ "parameters": [
+ {
+ "name": "loadThumbnail",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "login",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/v1/bts/{projectName}/{integrationId}/issue_types": {
+ "get": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Get list of allowable issue types for bug tracking system",
+ "operationId": "getAllowableIssueTypes",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/bts/{projectName}/{integrationId}/fields-set": {
+ "get": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Get list of fields required for posting ticket in concrete integration",
+ "operationId": "getSetOfIntegrationSystemFields",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "issueType",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PostFormField"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/bts/{projectName}/ticket/{ticketId}": {
+ "get": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Get ticket from the bts integration",
+ "operationId": "getTicket",
+ "parameters": [
+ {
+ "name": "btsProject",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "btsUrl",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ticketId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Ticket"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/bts/{integrationId}/issue_types": {
+ "get": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Get list of existed issue types in bts",
+ "operationId": "getAllowableIssueTypes_1",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/bts/{integrationId}/fields-set": {
+ "get": {
+ "tags": [
+ "bug-tracking-system-controller"
+ ],
+ "summary": "Get list of fields required for posting ticket",
+ "operationId": "getSetOfIntegrationSystemFields_1",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "issueType",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PostFormField"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/activities/{projectName}/subjectName": {
+ "get": {
+ "tags": [
+ "activity-event-controller"
+ ],
+ "summary": "Load project activities subjectNames by filter",
+ "description": "Only for current project",
+ "operationId": "getProjectSubjectName",
+ "parameters": [
+ {
+ "name": "filter.cnt.subjectName",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/{userName}/projects": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Get User Projects",
+ "operationId": "getUserProjects",
+ "parameters": [
+ {
+ "name": "userName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/AssignedProject"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/search": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Find Users",
+ "operationId": "findUsers",
+ "parameters": [
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "term",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/registration/info": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Validate Info",
+ "operationId": "validateInfo",
+ "parameters": [
+ {
+ "name": "email",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/YesNoRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/password/reset/{uuid}": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Check if a restore password bid exists",
+ "operationId": "isRestorePasswordBidExist",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/YesNoRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/export": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Exports information about all users",
+ "description": "Allowable only for users with administrator role",
+ "operationId": "export",
+ "parameters": [
+ {
+ "name": "filter.eq.email",
+ "in": "query",
+ "description": "Filters by 'email'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.expired",
+ "in": "query",
+ "description": "Filters by 'expired'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.fullName",
+ "in": "query",
+ "description": "Filters by 'fullName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastLogin",
+ "in": "query",
+ "description": "Filters by 'lastLogin'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.project",
+ "in": "query",
+ "description": "Filters by 'project'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.role",
+ "in": "query",
+ "description": "Filters by 'role'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.synchronizationDate",
+ "in": "query",
+ "description": "Filters by 'synchronizationDate'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "view",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "csv"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/users/all": {
+ "get": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Return information about all users",
+ "description": "Allowable only for users with administrator role",
+ "operationId": "getUsers",
+ "parameters": [
+ {
+ "name": "filter.eq.email",
+ "in": "query",
+ "description": "Filters by 'email'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.expired",
+ "in": "query",
+ "description": "Filters by 'expired'",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "filter.eq.fullName",
+ "in": "query",
+ "description": "Filters by 'fullName'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.id",
+ "in": "query",
+ "description": "Filters by 'id'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.lastLogin",
+ "in": "query",
+ "description": "Filters by 'lastLogin'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.project",
+ "in": "query",
+ "description": "Filters by 'project'",
+ "schema": {
+ "type": "array"
+ }
+ },
+ {
+ "name": "filter.eq.projectId",
+ "in": "query",
+ "description": "Filters by 'projectId'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.role",
+ "in": "query",
+ "description": "Filters by 'role'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.synchronizationDate",
+ "in": "query",
+ "description": "Filters by 'synchronizationDate'",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "filter.eq.type",
+ "in": "query",
+ "description": "Filters by 'type'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "filter.eq.user",
+ "in": "query",
+ "description": "Filters by 'user'",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page.page",
+ "in": "query",
+ "description": "Results page you want to retrieve (0..N)",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.size",
+ "in": "query",
+ "description": "Number of records per page",
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page.sort",
+ "in": "query",
+ "description": "Sorting criteria in the format: property, (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/sub-type/{id}": {
+ "delete": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Delete custom project specific issue sub-type",
+ "operationId": "deleteProjectIssueSubType",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/settings/notification/{notificationId}": {
+ "delete": {
+ "tags": [
+ "project-settings-controller"
+ ],
+ "summary": "Deletes notification for specified project",
+ "description": "Only for users with PROJECT_MANAGER or ADMIN roles",
+ "operationId": "deleteNotification",
+ "parameters": [
+ {
+ "name": "notificationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/{projectName}/dashboard/{dashboardId}/{widgetId}": {
+ "delete": {
+ "tags": [
+ "dashboard-controller"
+ ],
+ "summary": "Remove widget from specified dashboard",
+ "operationId": "removeWidget",
+ "parameters": [
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "widgetId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/project/{projectId}": {
+ "delete": {
+ "tags": [
+ "project-controller"
+ ],
+ "summary": "Delete project",
+ "description": "Could be deleted only by users with administrator role",
+ "operationId": "deleteProject_1",
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/{projectName}/all/{type}": {
+ "delete": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Delete all integrations assigned to specified project",
+ "operationId": "deleteAllProjectIntegrations",
+ "parameters": [
+ {
+ "name": "projectName",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/v1/integration/all/{type}": {
+ "delete": {
+ "tags": [
+ "integration-controller"
+ ],
+ "summary": "Delete all global integrations by type",
+ "operationId": "deleteAllIntegrations",
+ "parameters": [
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/{userId}/api-keys/{keyId}": {
+ "delete": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Delete specified Api Key",
+ "operationId": "deleteApiKey",
+ "parameters": [
+ {
+ "name": "keyId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "userId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/users/{id}": {
+ "delete": {
+ "tags": [
+ "user-controller"
+ ],
+ "summary": "Delete specified user",
+ "operationId": "deleteUser",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AnalyticsResource": {
+ "required": [
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "OperationCompletionRS": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "FinishExecutionRQ": {
+ "required": [
+ "endTime"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributesRQ"
+ }
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN"
+ ]
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "ItemAttributesRQ": {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "maxLength": 2147483647,
+ "minLength": 1,
+ "type": "string"
+ },
+ "system": {
+ "type": "boolean",
+ "example": false
+ }
+ }
+ },
+ "FinishLaunchRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "link": {
+ "type": "string"
+ }
+ }
+ },
+ "ExternalSystemIssue": {
+ "required": [
+ "btsProject",
+ "btsUrl",
+ "ticketId",
+ "url"
+ ],
+ "type": "object",
+ "properties": {
+ "ticketId": {
+ "type": "string"
+ },
+ "submitDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "btsUrl": {
+ "type": "string"
+ },
+ "btsProject": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "pluginName": {
+ "type": "string"
+ }
+ }
+ },
+ "FinishTestItemRQ": {
+ "required": [
+ "endTime",
+ "launchUuid"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributesRQ"
+ }
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "PASSED, FAILED, STOPPED, SKIPPED, INTERRUPTED, CANCELLED, INFO, WARN"
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/Issue"
+ },
+ "retry": {
+ "type": "boolean"
+ },
+ "launchUuid": {
+ "type": "string"
+ },
+ "testCaseId": {
+ "type": "string"
+ },
+ "retryOf": {
+ "type": "string"
+ }
+ }
+ },
+ "Issue": {
+ "required": [
+ "issueType"
+ ],
+ "type": "object",
+ "properties": {
+ "issueType": {
+ "type": "string"
+ },
+ "comment": {
+ "maxLength": 65536,
+ "minLength": 0,
+ "type": "string"
+ },
+ "autoAnalyzed": {
+ "type": "boolean"
+ },
+ "ignoreAnalyzer": {
+ "type": "boolean"
+ },
+ "externalSystemIssues": {
+ "maxItems": 300,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExternalSystemIssue"
+ }
+ }
+ }
+ },
+ "ContentParameters": {
+ "required": [
+ "contentFields",
+ "itemsCount"
+ ],
+ "type": "object",
+ "properties": {
+ "contentFields": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "itemsCount": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "widgetOptions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "WidgetRQ": {
+ "required": [
+ "name",
+ "widgetType"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 0,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "widgetType": {
+ "type": "string",
+ "enum": [
+ "oldLineChart, investigatedTrend, launchStatistics, statisticTrend, casesTrend, notPassed, overallStatistics, uniqueBugTable, bugTrend, activityStream, launchesComparisonChart, launchesDurationChart, launchesTable, topTestCases, flakyTestCases, passingRateSummary, passingRatePerLaunch, productStatus, mostTimeConsuming, cumulative, topPatternTemplates, componentHealthCheck, componentHealthCheckTable"
+ ]
+ },
+ "contentParameters": {
+ "$ref": "#/components/schemas/ContentParameters"
+ },
+ "filterIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "UpdateIssueSubTypeRQ": {
+ "required": [
+ "ids"
+ ],
+ "type": "object",
+ "properties": {
+ "ids": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UpdateOneIssueSubTypeRQ"
+ }
+ }
+ }
+ },
+ "UpdateOneIssueSubTypeRQ": {
+ "required": [
+ "color",
+ "locator",
+ "longName",
+ "shortName",
+ "typeRef"
+ ],
+ "type": "object",
+ "properties": {
+ "locator": {
+ "type": "string"
+ },
+ "typeRef": {
+ "type": "string"
+ },
+ "longName": {
+ "maxLength": 55,
+ "minLength": 3,
+ "type": "string"
+ },
+ "shortName": {
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": "string"
+ },
+ "color": {
+ "maxLength": 55,
+ "minLength": 3,
+ "pattern": "#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
+ "type": "string",
+ "example": "string"
+ }
+ }
+ },
+ "UpdatePatternTemplateRQ": {
+ "required": [
+ "enabled",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "maxLength": 55,
+ "minLength": 1,
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "ItemAttributeResource": {
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "maxLength": 2147483647,
+ "minLength": 1,
+ "type": "string"
+ }
+ }
+ },
+ "SenderCaseDTO": {
+ "required": [
+ "attributesOperator",
+ "ruleName",
+ "sendCase"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "ruleName": {
+ "type": "string"
+ },
+ "recipients": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sendCase": {
+ "type": "string",
+ "enum": [
+ "always",
+ "failed",
+ "toInvestigate",
+ "more10",
+ "more20",
+ "more50"
+ ]
+ },
+ "launchNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "attributes": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string"
+ },
+ "ruleDetails": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "attributesOperator": {
+ "type": "string",
+ "enum": [
+ "AND, OR"
+ ]
+ }
+ }
+ },
+ "UpdateLaunchRQ": {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "DEFAULT, DEBUG"
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ }
+ }
+ },
+ "BulkRQLongUpdateLaunchRQ": {
+ "required": [
+ "entities"
+ ],
+ "type": "object",
+ "properties": {
+ "entities": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/UpdateLaunchRQ"
+ }
+ }
+ }
+ },
+ "BulkRQLongFinishExecutionRQ": {
+ "required": [
+ "entities"
+ ],
+ "type": "object",
+ "properties": {
+ "entities": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/FinishExecutionRQ"
+ }
+ }
+ }
+ },
+ "BulkInfoUpdateRQ": {
+ "required": [
+ "ids"
+ ],
+ "type": "object",
+ "properties": {
+ "ids": {
+ "maxItems": 2147483647,
+ "minItems": 1,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "description": {
+ "$ref": "#/components/schemas/Description"
+ },
+ "attributes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UpdateItemAttributeRQ"
+ }
+ }
+ }
+ },
+ "Description": {
+ "type": "object",
+ "properties": {
+ "comment": {
+ "type": "string"
+ },
+ "action": {
+ "type": "string",
+ "enum": [
+ "DELETE",
+ "UPDATE",
+ "CREATE"
+ ]
+ }
+ }
+ },
+ "UpdateItemAttributeRQ": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ },
+ "to": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ },
+ "action": {
+ "type": "string",
+ "enum": [
+ "DELETE",
+ "UPDATE",
+ "CREATE"
+ ]
+ }
+ }
+ },
+ "DefineIssueRQ": {
+ "required": [
+ "issues"
+ ],
+ "type": "object",
+ "properties": {
+ "issues": {
+ "maxItems": 300,
+ "minItems": 0,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IssueDefinition"
+ }
+ }
+ }
+ },
+ "IssueDefinition": {
+ "required": [
+ "issue",
+ "testItemId"
+ ],
+ "type": "object",
+ "properties": {
+ "testItemId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/Issue"
+ }
+ }
+ },
+ "UpdateTestItemRQ": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "SuggestInfo": {
+ "type": "object",
+ "properties": {
+ "project": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "testItem": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "testItemLogId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchName": {
+ "type": "string"
+ },
+ "launchNumber": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "issueType": {
+ "type": "string"
+ },
+ "relevantItem": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "relevantLogId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "isMergedLog": {
+ "type": "boolean"
+ },
+ "matchScore": {
+ "type": "number",
+ "format": "float"
+ },
+ "resultPosition": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "esScore": {
+ "type": "number",
+ "format": "float"
+ },
+ "esPosition": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "modelFeatureNames": {
+ "type": "string"
+ },
+ "modelFeatureValues": {
+ "type": "string"
+ },
+ "modelInfo": {
+ "type": "string"
+ },
+ "usedLogLines": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "minShouldMatch": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "processedTime": {
+ "type": "number",
+ "format": "float"
+ },
+ "userChoice": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "methodName": {
+ "type": "string"
+ },
+ "clusterId": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "UnlinkExternalIssueRQ": {
+ "required": [
+ "testItemIds",
+ "ticketIds"
+ ],
+ "type": "object",
+ "properties": {
+ "testItemIds": {
+ "maxItems": 300,
+ "minItems": 0,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "ticketIds": {
+ "maxItems": 300,
+ "minItems": 0,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "LinkExternalIssueRQ": {
+ "required": [
+ "issues",
+ "testItemIds"
+ ],
+ "type": "object",
+ "properties": {
+ "testItemIds": {
+ "maxItems": 300,
+ "minItems": 0,
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "issues": {
+ "$ref": "#/components/schemas/ExternalSystemIssue"
+ }
+ }
+ },
+ "BulkUpdateFilterRQ": {
+ "required": [
+ "conditions",
+ "id",
+ "name",
+ "orders",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 0,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "launch, testitem, log"
+ ]
+ },
+ "conditions": {
+ "maxItems": 20,
+ "minItems": 1,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterCondition"
+ }
+ },
+ "orders": {
+ "maxItems": 2147483647,
+ "minItems": 1,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Order"
+ }
+ },
+ "id": {
+ "type": "string"
+ }
+ }
+ },
+ "CollectionsRQBulkUpdateFilterRQ": {
+ "required": [
+ "elements"
+ ],
+ "type": "object",
+ "properties": {
+ "elements": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BulkUpdateFilterRQ"
+ }
+ }
+ }
+ },
+ "Order": {
+ "required": [
+ "isAsc",
+ "sortingColumn"
+ ],
+ "type": "object",
+ "properties": {
+ "sortingColumn": {
+ "type": "string"
+ },
+ "isAsc": {
+ "type": "boolean"
+ }
+ }
+ },
+ "UserFilterCondition": {
+ "required": [
+ "condition",
+ "filteringField",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "filteringField": {
+ "type": "string"
+ },
+ "condition": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "UpdateUserFilterRQ": {
+ "required": [
+ "conditions",
+ "name",
+ "orders",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 0,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "launch, testitem, log"
+ ]
+ },
+ "conditions": {
+ "maxItems": 20,
+ "minItems": 1,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterCondition"
+ }
+ },
+ "orders": {
+ "maxItems": 2147483647,
+ "minItems": 1,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Order"
+ }
+ }
+ }
+ },
+ "Position": {
+ "type": "object",
+ "properties": {
+ "positionX": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "positionY": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "Size": {
+ "type": "object",
+ "properties": {
+ "width": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "height": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "UpdateDashboardRQ": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 0,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "updateWidgets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WidgetObjectModel"
+ }
+ }
+ }
+ },
+ "WidgetObjectModel": {
+ "required": [
+ "widgetId"
+ ],
+ "type": "object",
+ "properties": {
+ "widgetName": {
+ "type": "string"
+ },
+ "widgetId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "widgetType": {
+ "type": "string"
+ },
+ "widgetSize": {
+ "$ref": "#/components/schemas/Size"
+ },
+ "widgetPosition": {
+ "$ref": "#/components/schemas/Position"
+ },
+ "widgetOptions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "AddWidgetRq": {
+ "required": [
+ "addWidget"
+ ],
+ "type": "object",
+ "properties": {
+ "addWidget": {
+ "$ref": "#/components/schemas/WidgetObjectModel"
+ }
+ }
+ },
+ "ProjectConfigurationUpdate": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "UpdateProjectRQ": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "configuration": {
+ "$ref": "#/components/schemas/ProjectConfigurationUpdate"
+ }
+ }
+ },
+ "UnassignUsersRQ": {
+ "required": [
+ "userNames"
+ ],
+ "type": "object",
+ "properties": {
+ "userNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ProjectNotificationConfigDTO": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "cases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SenderCaseDTO"
+ }
+ }
+ }
+ },
+ "AssignUsersRQ": {
+ "required": [
+ "userNames"
+ ],
+ "type": "object",
+ "properties": {
+ "userNames": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "UpdatePluginStateRQ": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "IntegrationRQ": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "integrationParameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "EditUserRQ": {
+ "required": [
+ "fullName"
+ ],
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string"
+ },
+ "fullName": {
+ "maxLength": 256,
+ "minLength": 3,
+ "pattern": "(\\s*[\\pL0-9-_\\.]+\\s*)+",
+ "type": "string",
+ "example": "string"
+ }
+ }
+ },
+ "File": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "SaveLogRQ": {
+ "required": [
+ "launchUuid",
+ "time"
+ ],
+ "type": "object",
+ "properties": {
+ "itemUuid": {
+ "type": "string",
+ "description": "UUID of test item owned this log"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "launchUuid": {
+ "type": "string"
+ },
+ "time": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "message": {
+ "type": "string"
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "error, warn, info, debug, trace, fatal, unknown"
+ ]
+ },
+ "file": {
+ "$ref": "#/components/schemas/File"
+ }
+ }
+ },
+ "BatchElementCreatedRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "stackTrace": {
+ "type": "string"
+ }
+ }
+ },
+ "BatchSaveOperatingRS": {
+ "type": "object",
+ "properties": {
+ "responses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/BatchElementCreatedRS"
+ }
+ }
+ }
+ },
+ "EntryCreatedAsyncRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ }
+ },
+ "StartLaunchRQ": {
+ "required": [
+ "name",
+ "startTime",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributesRQ"
+ }
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "DEBUG"
+ ]
+ },
+ "rerun": {
+ "type": "boolean"
+ },
+ "rerunOf": {
+ "type": "string",
+ "description": "UUID of desired launch to rerun"
+ }
+ },
+ "description": "Start launch request body"
+ },
+ "StartLaunchRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "MergeLaunchesRQ": {
+ "required": [
+ "extendSuitesDescription",
+ "launches",
+ "mergeType",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "DEBUG"
+ ]
+ },
+ "launches": {
+ "uniqueItems": true,
+ "type": "array",
+ "description": "A set of IDs of the launches to be merged.",
+ "items": {
+ "type": "integer",
+ "description": "A set of IDs of the launches to be merged.",
+ "format": "int64"
+ }
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "mergeType": {
+ "type": "string",
+ "enum": [
+ "BASIC, DEEP"
+ ]
+ },
+ "extendSuitesDescription": {
+ "type": "boolean"
+ }
+ },
+ "description": "Merge launches request body"
+ },
+ "LaunchResource": {
+ "required": [
+ "id",
+ "name",
+ "number",
+ "startTime",
+ "status",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "owner": {
+ "type": "string"
+ },
+ "description": {
+ "maxLength": 2048,
+ "minLength": 0,
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "name": {
+ "maxLength": 256,
+ "minLength": 3,
+ "type": "string"
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastModified": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string"
+ },
+ "statistics": {
+ "$ref": "#/components/schemas/StatisticsResource"
+ },
+ "attributes": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "DEBUG"
+ ]
+ },
+ "analysing": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "approximateDuration": {
+ "type": "number",
+ "format": "double"
+ },
+ "hasRetries": {
+ "type": "boolean"
+ },
+ "rerun": {
+ "type": "boolean"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "retentionPolicy": {
+ "type": "string",
+ "enum": [
+ "IMPORTANT",
+ "REGULAR"
+ ]
+ }
+ }
+ },
+ "StatisticsResource": {
+ "type": "object",
+ "properties": {
+ "executions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "defects": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ }
+ },
+ "ParameterResource": {
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "StartTestItemRQ": {
+ "required": [
+ "launchUuid",
+ "name",
+ "startTime",
+ "type",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "launchUuid": {
+ "type": "string",
+ "description": "UUID of parent launch"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributesRQ"
+ }
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "codeRef": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParameterResource"
+ }
+ },
+ "uniqueId": {
+ "maxLength": 1024,
+ "minLength": 0,
+ "type": "string"
+ },
+ "testCaseId": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "SUITE, STORY, TEST, SCENARIO, STEP, BEFORE_CLASS, BEFORE_GROUPS,BEFORE_METHOD, BEFORE_SUITE, BEFORE_TEST, AFTER_CLASS, AFTER_GROUPS, AFTER_METHOD, AFTER_SUITE, AFTER_TEST"
+ ]
+ },
+ "retry": {
+ "type": "boolean"
+ },
+ "hasStats": {
+ "type": "boolean"
+ },
+ "retryOf": {
+ "type": "string"
+ }
+ }
+ },
+ "EntryCreatedRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "WidgetPreviewRQ": {
+ "required": [
+ "widgetType"
+ ],
+ "type": "object",
+ "properties": {
+ "widgetType": {
+ "type": "string",
+ "enum": [
+ "oldLineChart, investigatedTrend, launchStatistics, statisticTrend, casesTrend, notPassed, overallStatistics, uniqueBugTable, bugTrend, activityStream, launchesComparisonChart, launchesDurationChart, launchesTable, topTestCases, flakyTestCases, passingRateSummary, passingRatePerLaunch, productStatus, mostTimeConsuming, cumulative"
+ ]
+ },
+ "contentParameters": {
+ "$ref": "#/components/schemas/ContentParameters"
+ },
+ "filterIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "CreateIssueSubTypeRQ": {
+ "required": [
+ "color",
+ "longName",
+ "shortName",
+ "typeRef"
+ ],
+ "type": "object",
+ "properties": {
+ "typeRef": {
+ "type": "string"
+ },
+ "longName": {
+ "maxLength": 55,
+ "minLength": 3,
+ "type": "string"
+ },
+ "shortName": {
+ "maxLength": 4,
+ "minLength": 1,
+ "type": "string",
+ "example": "string"
+ },
+ "color": {
+ "pattern": "#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
+ "type": "string",
+ "example": "string"
+ }
+ }
+ },
+ "IssueSubTypeCreatedRS": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "locator": {
+ "type": "string"
+ }
+ }
+ },
+ "CreatePatternTemplateRQ": {
+ "required": [
+ "enabled",
+ "name",
+ "type",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "maxLength": 55,
+ "minLength": 1,
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "GetLogsUnderRq": {
+ "required": [
+ "itemIds",
+ "logLevel"
+ ],
+ "type": "object",
+ "properties": {
+ "itemIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "logLevel": {
+ "type": "string",
+ "enum": [
+ "error, warn, info, debug, trace, fatal, unknown"
+ ]
+ }
+ }
+ },
+ "BinaryContent": {
+ "required": [
+ "contentType",
+ "id",
+ "thumbnailId"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "thumbnailId": {
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string"
+ }
+ }
+ },
+ "LogResource": {
+ "required": [
+ "id",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "time": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "message": {
+ "type": "string"
+ },
+ "binaryContent": {
+ "$ref": "#/components/schemas/BinaryContent"
+ },
+ "thumbnail": {
+ "type": "string"
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "error, warn, info, debug, trace, fatal, unknown"
+ ]
+ },
+ "itemId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "SearchLogRq": {
+ "required": [
+ "searchMode"
+ ],
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "searchMode": {
+ "type": "string",
+ "enum": [
+ "currentLaunch, launchName, filter"
+ ]
+ }
+ }
+ },
+ "ItemPathName": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "LaunchPathName": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "LogEntry": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "level": {
+ "type": "string"
+ }
+ }
+ },
+ "PathNameResource": {
+ "type": "object",
+ "properties": {
+ "launchPathName": {
+ "$ref": "#/components/schemas/LaunchPathName"
+ },
+ "itemPaths": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemPathName"
+ }
+ }
+ }
+ },
+ "SearchLogRs": {
+ "type": "object",
+ "properties": {
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "itemId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "itemName": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "pathNames": {
+ "$ref": "#/components/schemas/PathNameResource"
+ },
+ "duration": {
+ "type": "number",
+ "format": "double"
+ },
+ "status": {
+ "type": "string"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/Issue"
+ },
+ "patternTemplates": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LogEntry"
+ }
+ }
+ }
+ },
+ "CreateClustersRQ": {
+ "required": [
+ "launchId"
+ ],
+ "type": "object",
+ "properties": {
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "removeNumbers": {
+ "type": "boolean"
+ }
+ }
+ },
+ "AnalyzeLaunchRQ": {
+ "required": [
+ "analyzeItemsMode",
+ "analyzerMode",
+ "analyzerTypeName",
+ "launchId"
+ ],
+ "type": "object",
+ "properties": {
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "analyzerMode": {
+ "type": "string",
+ "enum": [
+ "ALL, LAUNCH_NAME, CURRENT_LAUNCH, PREVIOUS_LAUNCH, CURRENT_AND_THE_SAME_NAME"
+ ]
+ },
+ "analyzerTypeName": {
+ "type": "string",
+ "enum": [
+ "autoAnalyzer, patternAnalyzer"
+ ]
+ },
+ "analyzeItemsMode": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "TO_INVESTIGATE, AUTO_ANALYZED, MANUALLY_ANALYZED"
+ ]
+ }
+ }
+ }
+ },
+ "CreateDashboardRQ": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 0,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "CreateProjectRQ": {
+ "required": [
+ "entryType",
+ "projectName"
+ ],
+ "type": "object",
+ "properties": {
+ "projectName": {
+ "maxLength": 256,
+ "minLength": 3,
+ "pattern": "[a-zA-Z0-9-_]+",
+ "type": "string",
+ "example": "string"
+ },
+ "entryType": {
+ "type": "string",
+ "enum": [
+ "INTERNAL"
+ ]
+ }
+ }
+ },
+ "LaunchImportRQ": {
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "maxLength": 256,
+ "minLength": 1,
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "attributes": {
+ "maxItems": 256,
+ "minItems": 0,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributesRQ"
+ }
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "DEFAULT",
+ "DEBUG"
+ ]
+ }
+ }
+ },
+ "DemoDataRq": {
+ "type": "object",
+ "properties": {
+ "createDashboard": {
+ "type": "boolean"
+ }
+ }
+ },
+ "DemoDataRs": {
+ "type": "object",
+ "properties": {
+ "dashboardId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchIds": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "AllowedValue": {
+ "type": "object",
+ "properties": {
+ "valueId": {
+ "type": "string"
+ },
+ "valueName": {
+ "type": "string"
+ }
+ }
+ },
+ "NamedValue": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "PostFormField": {
+ "required": [
+ "id",
+ "required"
+ ],
+ "type": "object",
+ "properties": {
+ "fieldName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "fieldType": {
+ "type": "string"
+ },
+ "required": {
+ "type": "boolean"
+ },
+ "value": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "namedValue": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NamedValue"
+ }
+ },
+ "commandName": {
+ "type": "string"
+ },
+ "definedValues": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AllowedValue"
+ }
+ }
+ }
+ },
+ "PostTicketRQ": {
+ "required": [
+ "backLinks",
+ "fields",
+ "item"
+ ],
+ "type": "object",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "domain": {
+ "type": "string"
+ },
+ "token": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PostFormField"
+ }
+ },
+ "includeLogs": {
+ "type": "boolean"
+ },
+ "includeData": {
+ "type": "boolean"
+ },
+ "includeComments": {
+ "type": "boolean"
+ },
+ "logQuantity": {
+ "maximum": 50,
+ "minimum": 0,
+ "type": "integer",
+ "format": "int32"
+ },
+ "item": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "backLinks": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Ticket": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "pluginName": {
+ "type": "string"
+ }
+ }
+ },
+ "SearchCriteria": {
+ "required": [
+ "filter_key",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "filter_key": {
+ "type": "string"
+ },
+ "operation": {
+ "type": "string",
+ "enum": [
+ "EQ, NE, CNT, NON_CNT, BTW, IN"
+ ]
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "SearchCriteriaRQ": {
+ "required": [
+ "search_criterias"
+ ],
+ "type": "object",
+ "properties": {
+ "search_criterias": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SearchCriteria"
+ }
+ }
+ }
+ },
+ "ActivityEventResource": {
+ "required": [
+ "created_at",
+ "event_name",
+ "id",
+ "object_id",
+ "object_name",
+ "object_type",
+ "project_id",
+ "project_name",
+ "subject_id",
+ "subject_name",
+ "subject_type"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The unique ID of the activity",
+ "format": "int64",
+ "example": 1
+ },
+ "created_at": {
+ "type": "string",
+ "description": "The time the activity was created",
+ "format": "date-time",
+ "example": "2021-07-01T12:00:00Z"
+ },
+ "event_name": {
+ "type": "string",
+ "description": "The name of the event",
+ "example": "updateItem"
+ },
+ "object_id": {
+ "type": "integer",
+ "description": "The ID of the object on which activity was performed",
+ "format": "int64",
+ "example": 1
+ },
+ "object_name": {
+ "type": "string",
+ "description": "The name of the object on which activity was performed",
+ "example": "Test item name"
+ },
+ "object_type": {
+ "type": "string",
+ "description": "The type of the object on which activity was performed",
+ "example": "itemIssue"
+ },
+ "project_id": {
+ "type": "integer",
+ "description": "The ID of the project",
+ "format": "int64",
+ "example": 1
+ },
+ "project_name": {
+ "type": "string",
+ "description": "The name of the project",
+ "example": "Project name"
+ },
+ "subject_name": {
+ "type": "string",
+ "description": "The name of the subject who performed the activity",
+ "example": "Username"
+ },
+ "subject_type": {
+ "type": "string",
+ "description": "The type of the subject who performed the activity",
+ "example": "user"
+ },
+ "subject_id": {
+ "type": "string",
+ "description": "The ID of the subject who performed the activity",
+ "example": "1"
+ },
+ "details": {
+ "type": "object",
+ "description": "The details of the activity, for example history of value",
+ "example": {
+ "history": [
+ {
+ "field": "status",
+ "newValue": "FAILED",
+ "oldValue": "PASSED"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "PagedResponseActivityEventResource": {
+ "required": [
+ "items",
+ "limit",
+ "offset",
+ "order",
+ "sort",
+ "total_count"
+ ],
+ "type": "object",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "total_count": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "sort": {
+ "type": "string"
+ },
+ "order": {
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ActivityEventResource"
+ }
+ }
+ }
+ },
+ "CreateUserRQFull": {
+ "required": [
+ "accountRole",
+ "defaultProject",
+ "email",
+ "fullName",
+ "login",
+ "password",
+ "projectRole"
+ ],
+ "type": "object",
+ "properties": {
+ "login": {
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "[a-zA-Z0-9-_.]+",
+ "type": "string",
+ "example": "string"
+ },
+ "password": {
+ "maxLength": 256,
+ "minLength": 4,
+ "type": "string"
+ },
+ "fullName": {
+ "maxLength": 256,
+ "minLength": 3,
+ "pattern": "[\\pL0-9-_ \\.]+",
+ "type": "string",
+ "example": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "accountRole": {
+ "type": "string",
+ "enum": [
+ "USER, ADMINISTRATOR"
+ ]
+ },
+ "projectRole": {
+ "type": "string",
+ "enum": [
+ "CUSTOMER, MEMBER, PROJECT_MANAGER"
+ ]
+ },
+ "defaultProject": {
+ "type": "string"
+ }
+ }
+ },
+ "CreateUserRS": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string"
+ }
+ }
+ },
+ "ApiKeyRQ": {
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "ApiKeyRS": {
+ "required": [
+ "created_at",
+ "id",
+ "name",
+ "user_id"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ },
+ "user_id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "last_used_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "api_key": {
+ "type": "string"
+ }
+ }
+ },
+ "CreateUserRQConfirm": {
+ "required": [
+ "email",
+ "fullName",
+ "login",
+ "password"
+ ],
+ "type": "object",
+ "properties": {
+ "login": {
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "[a-zA-Z0-9-_.]+",
+ "type": "string",
+ "example": "string"
+ },
+ "password": {
+ "maxLength": 256,
+ "minLength": 4,
+ "type": "string"
+ },
+ "fullName": {
+ "maxLength": 256,
+ "minLength": 3,
+ "pattern": "[\\pL0-9-_ \\.]+",
+ "type": "string",
+ "example": "string"
+ },
+ "email": {
+ "type": "string"
+ }
+ }
+ },
+ "RestorePasswordRQ": {
+ "required": [
+ "email"
+ ],
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ }
+ }
+ },
+ "ResetPasswordRQ": {
+ "required": [
+ "password",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "password": {
+ "maxLength": 256,
+ "minLength": 4,
+ "type": "string"
+ },
+ "uuid": {
+ "type": "string"
+ }
+ }
+ },
+ "ChangePasswordRQ": {
+ "required": [
+ "newPassword",
+ "oldPassword"
+ ],
+ "type": "object",
+ "properties": {
+ "newPassword": {
+ "maxLength": 256,
+ "minLength": 4,
+ "type": "string"
+ },
+ "oldPassword": {
+ "maxLength": 256,
+ "minLength": 4,
+ "type": "string"
+ }
+ }
+ },
+ "CreateUserRQ": {
+ "required": [
+ "defaultProject",
+ "email",
+ "role"
+ ],
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string"
+ },
+ "defaultProject": {
+ "type": "string"
+ }
+ }
+ },
+ "CreateUserBidRS": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "bid": {
+ "type": "string"
+ },
+ "backLink": {
+ "type": "string"
+ }
+ }
+ },
+ "UserFilterResource": {
+ "required": [
+ "conditions",
+ "id",
+ "name",
+ "orders",
+ "owner",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 1,
+ "type": "string"
+ },
+ "owner": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "maxLength": 128,
+ "minLength": 3,
+ "type": "string"
+ },
+ "conditions": {
+ "maxItems": 2147483647,
+ "minItems": 1,
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterCondition"
+ }
+ },
+ "orders": {
+ "maxItems": 2147483647,
+ "minItems": 1,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Order"
+ }
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "WidgetResource": {
+ "required": [
+ "contentParameters",
+ "id",
+ "name",
+ "widgetType"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 1,
+ "type": "string"
+ },
+ "owner": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "maxLength": 128,
+ "minLength": 3,
+ "type": "string"
+ },
+ "widgetType": {
+ "type": "string",
+ "enum": [
+ "oldLineChart, investigatedTrend, launchStatistics, statisticTrend, casesTrend, notPassed, overallStatistics, uniqueBugTable, bugTrend, activityStream, launchesComparisonChart, launchesDurationChart, launchesTable, topTestCases, flakyTestCases, passingRateSummary, passingRatePerLaunch, productStatus, mostTimeConsuming, cumulative"
+ ]
+ },
+ "contentParameters": {
+ "$ref": "#/components/schemas/ContentParameters"
+ },
+ "appliedFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterResource"
+ }
+ },
+ "content": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "MultiValueMapStringString": {
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "writeOnly": true
+ },
+ "empty": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "IssueSubTypeResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "locator": {
+ "type": "string"
+ },
+ "typeRef": {
+ "type": "string"
+ },
+ "longName": {
+ "type": "string"
+ },
+ "shortName": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ }
+ }
+ },
+ "ProjectSettingsResource": {
+ "required": [
+ "project",
+ "subTypes"
+ ],
+ "type": "object",
+ "properties": {
+ "project": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "subTypes": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IssueSubTypeResource"
+ }
+ }
+ }
+ }
+ },
+ "PagedLogResource": {
+ "required": [
+ "id",
+ "uuid"
+ ],
+ "type": "object",
+ "properties": {
+ "pagesLocation": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "key": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "time": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "message": {
+ "type": "string"
+ },
+ "binaryContent": {
+ "$ref": "#/components/schemas/BinaryContent"
+ },
+ "thumbnail": {
+ "type": "string"
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "error, warn, info, debug, trace, fatal, unknown"
+ ]
+ },
+ "itemId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "ChartStatisticsContent": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "number": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "values": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ClusterInfoResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "index": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "message": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "matchedTests": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "TestItemResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "codeRef": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParameterResource"
+ }
+ },
+ "attributes": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ItemAttributeResource"
+ }
+ },
+ "type": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string"
+ },
+ "statistics": {
+ "$ref": "#/components/schemas/StatisticsResource"
+ },
+ "parent": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "pathNames": {
+ "$ref": "#/components/schemas/PathNameResource"
+ },
+ "launchStatus": {
+ "type": "string"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/Issue"
+ },
+ "hasChildren": {
+ "type": "boolean"
+ },
+ "hasStats": {
+ "type": "boolean"
+ },
+ "launchId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "uniqueId": {
+ "type": "string"
+ },
+ "testCaseId": {
+ "type": "string"
+ },
+ "testCaseHash": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "patternTemplates": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "retries": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ },
+ "path": {
+ "type": "string"
+ }
+ }
+ },
+ "SuggestedItem": {
+ "type": "object",
+ "properties": {
+ "testItemResource": {
+ "$ref": "#/components/schemas/TestItemResource"
+ },
+ "logs": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LogResource"
+ }
+ },
+ "suggestRs": {
+ "$ref": "#/components/schemas/SuggestInfo"
+ }
+ }
+ },
+ "TestItemHistoryElement": {
+ "type": "object",
+ "properties": {
+ "groupingField": {
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TestItemResource"
+ }
+ }
+ }
+ },
+ "OwnedEntityResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "DashboardResource": {
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "maxLength": 1500,
+ "minLength": 1,
+ "type": "string"
+ },
+ "owner": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "maxLength": 128,
+ "minLength": 3,
+ "type": "string"
+ },
+ "widgets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WidgetObjectModel"
+ }
+ }
+ }
+ },
+ "ActivityResource": {
+ "required": [
+ "actionType",
+ "id",
+ "lastModified",
+ "loggedObjectId",
+ "objectType",
+ "projectId",
+ "user"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The unique ID of the activity",
+ "format": "int64",
+ "example": 1
+ },
+ "user": {
+ "type": "string",
+ "description": "The user who performed the activity",
+ "example": "user"
+ },
+ "loggedObjectId": {
+ "type": "integer",
+ "description": "The ID of the object on which activity was performed",
+ "format": "int64",
+ "example": 1
+ },
+ "lastModified": {
+ "type": "string",
+ "description": "The time the activity was last modified",
+ "format": "date-time",
+ "example": "2021-07-01T12:00:00Z"
+ },
+ "actionType": {
+ "type": "string",
+ "description": "The type of action performed",
+ "example": "startLaunch"
+ },
+ "objectType": {
+ "type": "string",
+ "description": "The type of object on which the activity was performed",
+ "example": "LAUNCH"
+ },
+ "projectId": {
+ "type": "integer",
+ "description": "The ID of the project in which the activity was performed",
+ "format": "int64",
+ "example": 1
+ },
+ "projectName": {
+ "type": "string",
+ "description": "The name of the project in which the activity was performed",
+ "example": "project"
+ },
+ "details": {
+ "type": "object",
+ "description": "The details of the activity, for example history of value",
+ "example": {
+ "history": [
+ {
+ "field": "status",
+ "newValue": "FAILED",
+ "oldValue": "PASSED"
+ }
+ ]
+ }
+ },
+ "objectName": {
+ "type": "string",
+ "description": "The name of the object on which the activity was performed",
+ "example": "Launch name"
+ }
+ }
+ },
+ "ErrorRS": {
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "type": "string",
+ "enum": [
+ "INCORRECT_REQUEST",
+ "BINARY_DATA_CANNOT_BE_SAVED",
+ "ACCESS_DENIED",
+ "ADDRESS_LOCKED",
+ "PROJECT_NOT_FOUND",
+ "LAUNCH_NOT_FOUND",
+ "TEST_SUITE_NOT_FOUND",
+ "TEST_ITEM_NOT_FOUND",
+ "LOG_NOT_FOUND",
+ "ROLE_NOT_FOUND",
+ "USER_NOT_FOUND",
+ "WIDGET_NOT_FOUND",
+ "WIDGET_NOT_FOUND_IN_DASHBOARD",
+ "DASHBOARD_NOT_FOUND",
+ "USER_FILTER_NOT_FOUND",
+ "ACTIVITY_NOT_FOUND",
+ "UNABLE_TO_CREATE_WIDGET",
+ "INTEGRATION_NOT_FOUND",
+ "PROJECT_NOT_CONFIGURED",
+ "SERVER_SETTINGS_NOT_FOUND",
+ "ISSUE_TYPE_NOT_FOUND",
+ "PROJECT_SETTINGS_NOT_FOUND",
+ "TICKET_NOT_FOUND",
+ "AUTH_INTEGRATION_NOT_FOUND",
+ "WIDGET_NOT_FOUND_IN_PROJECT",
+ "USER_FILTER_NOT_FOUND_IN_PROJECT",
+ "DASHBOARD_NOT_FOUND_IN_PROJECT",
+ "PATTERN_TEMPLATE_NOT_FOUND_IN_PROJECT",
+ "TEST_ITEM_OR_LAUNCH_NOT_FOUND",
+ "ANALYZER_NOT_FOUND",
+ "ATTACHMENT_NOT_FOUND",
+ "UNABLE_TO_LOAD_BINARY_DATA",
+ "CLUSTER_NOT_FOUND",
+ "ORGANIZATION_NOT_FOUND",
+ "NOT_FOUND",
+ "INCORRECT_FILTER_PARAMETERS",
+ "INCORRECT_SORTING_PARAMETERS",
+ "INCORRECT_INTEGRATION_NAME",
+ "UNABLE_MODIFY_SHARABLE_RESOURCE",
+ "INCORRECT_AUTHENTICATION_TYPE",
+ "UNABLE_POST_TICKET",
+ "UNABLE_INTERACT_WITH_INTEGRATION",
+ "UNABLE_ASSIGN_UNASSIGN_USER_TO_PROJECT",
+ "EMAIL_CONFIGURATION_IS_INCORRECT",
+ "PROJECT_UPDATE_NOT_ALLOWED",
+ "UNABLE_TO_UPDATE_YOURSELF_ROLE",
+ "FORBIDDEN_OPERATION",
+ "RESOURCE_ALREADY_EXISTS",
+ "ROLE_ALREADY_EXISTS_ERROR",
+ "USER_ALREADY_EXISTS",
+ "USER_FILTER_ALREADY_EXISTS",
+ "PROJECT_ALREADY_EXISTS",
+ "DASHBOARD_UPDATE_ERROR",
+ "UNABLE_LOAD_WIDGET_CONTENT",
+ "UNABLE_ADD_TO_FAVORITE",
+ "INTEGRATION_ALREADY_EXISTS",
+ "SERVER_SETTINGS_ALREADY_EXISTS",
+ "UNABLE_REMOVE_FROM_FAVORITE",
+ "LAUNCH_IS_NOT_FINISHED",
+ "TEST_ITEM_IS_NOT_FINISHED",
+ "INCORRECT_FINISH_STATUS",
+ "BAD_REQUEST_ERROR",
+ "BAD_SAVE_LOG_REQUEST",
+ "REPORTING_ITEM_ALREADY_FINISHED",
+ "AMBIGUOUS_TEST_ITEM_STATUS",
+ "FAILED_TEST_ITEM_ISSUE_TYPE_DEFINITION",
+ "FINISH_TIME_EARLIER_THAN_START_TIME",
+ "FINISH_ITEM_NOT_ALLOWED",
+ "FINISH_LAUNCH_NOT_ALLOWED",
+ "START_ITEM_NOT_ALLOWED",
+ "CHILD_START_TIME_EARLIER_THAN_PARENT",
+ "UNSUPPORTED_TEST_ITEM_TYPE",
+ "LOGGING_IS_NOT_ALLOWED",
+ "BAD_SAVE_WIDGET_REQUEST",
+ "BAD_UPDATE_WIDGET_REQUEST",
+ "UNABLE_LOAD_TEST_ITEM_HISTORY",
+ "BAD_SAVE_USER_FILTER_REQUEST",
+ "RETRIES_HANDLER_ERROR",
+ "IMPORT_FILE_ERROR",
+ "PARSING_XML_ERROR",
+ "OBJECT_RETRIEVAL_ERROR",
+ "PLUGIN_UPLOAD_ERROR",
+ "PLUGIN_REMOVE_ERROR",
+ "UNABLE_TO_SAVE_CHILD_ITEM_FOR_THE_RETRY",
+ "PATTERN_ANALYSIS_ERROR",
+ "PROJECT_DOESNT_CONTAIN_USER",
+ "UNCLASSIFIED_REPORT_PORTAL_ERROR",
+ "BAD_UPDATE_PREFERENCE_REQUEST",
+ "UNSUPPORTED_MERGE_STRATEGY_TYPE",
+ "DEMO_DATA_GENERATION_ERROR",
+ "UNCLASSIFIED_ERROR"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "stackTrace": {
+ "type": "string"
+ }
+ }
+ },
+ "Page": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "page": {
+ "$ref": "#/components/schemas/PageMetadata"
+ }
+ }
+ },
+ "PageMetadata": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "size": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "totalElements": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "totalPages": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ },
+ "IntegrationResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "projectId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ },
+ "integrationType": {
+ "$ref": "#/components/schemas/IntegrationTypeResource"
+ },
+ "integrationParameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "creator": {
+ "type": "string"
+ },
+ "creationDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "IntegrationTypeResource": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "authFlow": {
+ "type": "string",
+ "enum": [
+ "OAUTH",
+ "BASIC",
+ "TOKEN",
+ "FORM",
+ "LDAP"
+ ]
+ },
+ "creationDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "groupType": {
+ "type": "string"
+ },
+ "details": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "PatternTemplateResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "ProjectConfiguration": {
+ "required": [
+ "attributes"
+ ],
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "subTypes": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IssueSubTypeResource"
+ }
+ }
+ },
+ "notificationsConfiguration": {
+ "$ref": "#/components/schemas/ProjectNotificationConfigDTO"
+ },
+ "patterns": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PatternTemplateResource"
+ }
+ }
+ }
+ },
+ "ProjectResource": {
+ "required": [
+ "configuration",
+ "creationDate",
+ "entryType",
+ "projectId",
+ "projectName"
+ ],
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "projectName": {
+ "type": "string"
+ },
+ "entryType": {
+ "type": "string"
+ },
+ "configuration": {
+ "$ref": "#/components/schemas/ProjectConfiguration"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ProjectUser"
+ }
+ },
+ "integrations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IntegrationResource"
+ }
+ },
+ "organization": {
+ "type": "string"
+ },
+ "allocatedStorage": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "creationDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "ProjectUser": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "projectRole": {
+ "type": "string"
+ }
+ }
+ },
+ "AssignedProject": {
+ "type": "object",
+ "properties": {
+ "projectRole": {
+ "type": "string"
+ },
+ "entryType": {
+ "type": "string"
+ }
+ }
+ },
+ "UserResource": {
+ "required": [
+ "email",
+ "id",
+ "userId"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "photoId": {
+ "type": "string"
+ },
+ "fullName": {
+ "type": "string"
+ },
+ "accountType": {
+ "type": "string"
+ },
+ "userRole": {
+ "type": "string"
+ },
+ "photoLoaded": {
+ "type": "boolean"
+ },
+ "metadata": {
+ "type": "object"
+ },
+ "assignedProjects": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/AssignedProject"
+ }
+ }
+ }
+ },
+ "SearchUserResource": {
+ "required": [
+ "email",
+ "id",
+ "login"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "fullName": {
+ "type": "string"
+ }
+ }
+ },
+ "PreferenceResource": {
+ "required": [
+ "projectId"
+ ],
+ "type": "object",
+ "properties": {
+ "userId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "projectId": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "filters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserFilterResource"
+ }
+ }
+ }
+ },
+ "LaunchesPerUser": {
+ "type": "object",
+ "properties": {
+ "fullName": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "ProjectInfoResource": {
+ "required": [
+ "creationDate",
+ "id",
+ "lastRun",
+ "launchesQuantity",
+ "projectName",
+ "usersQuantity"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "projectName": {
+ "type": "string"
+ },
+ "usersQuantity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "launchesQuantity": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "launchesPerUser": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LaunchesPerUser"
+ }
+ },
+ "uniqueTickets": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "launchesPerWeek": {
+ "type": "string"
+ },
+ "lastRun": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creationDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "entryType": {
+ "type": "string"
+ },
+ "organization": {
+ "type": "string"
+ }
+ }
+ },
+ "ApiKeysRS": {
+ "required": [
+ "items"
+ ],
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiKeyRS"
+ }
+ }
+ }
+ },
+ "UserBidRS": {
+ "type": "object",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string"
+ }
+ }
+ },
+ "YesNoRS": {
+ "type": "object",
+ "properties": {
+ "is": {
+ "type": "boolean"
+ }
+ }
+ },
+ "DeleteBulkRS": {
+ "type": "object",
+ "properties": {
+ "successfullyDeleted": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "notFound": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ErrorRS"
+ }
+ }
+ }
+ }
+ },
+ "securitySchemes": {
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/apis/service-uat.json b/apis/service-uat.json
new file mode 100644
index 000000000..d342f487c
--- /dev/null
+++ b/apis/service-uat.json
@@ -0,0 +1,609 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "ReportPortal",
+ "description": "ReportPortal UAT documentation",
+ "contact": {
+ "name": "Support",
+ "email": "support@reportportal.io"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ },
+ "version": "5.12.0"
+ },
+ "servers": [
+ {
+ "url": "{scheme}://{host}/uat",
+ "description": "ReportPortal authtorization server",
+ "variables": {
+ "scheme": {
+ "enum": [
+ "http",
+ "https"
+ ],
+ "default": "http"
+ },
+ "host": {
+ "description": "Host name and port (if needed) of Report Portal server",
+ "default": "demo.reportportal.io"
+ }
+ }
+ }
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "tags": [
+ {
+ "name": "auth-configuration-endpoint",
+ "description": "Auth Configuration Endpoint"
+ },
+ {
+ "name": "github-endpoint",
+ "description": "Github Endpoint"
+ },
+ {
+ "name": "o-auth-configuration-endpoint",
+ "description": "O Auth Configuration Endpoint"
+ },
+ {
+ "name": "sso-endpoint",
+ "description": "Sso Endpoint"
+ }
+ ],
+ "paths": {
+ "/settings/oauth/{authId}": {
+ "get": {
+ "tags": [
+ "o-auth-configuration-endpoint"
+ ],
+ "summary": "Returns OAuth Server Settings",
+ "operationId": "getOAuthSettings_1",
+ "parameters": [
+ {
+ "name": "authId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "o-auth-configuration-endpoint"
+ ],
+ "summary": "Creates/Updates OAuth Integration Settings",
+ "operationId": "updateOAuthSettings_1",
+ "parameters": [
+ {
+ "name": "authId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "o-auth-configuration-endpoint"
+ ],
+ "summary": "Creates/Updates OAuth Integration Settings",
+ "operationId": "updateOAuthSettings",
+ "parameters": [
+ {
+ "name": "authId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "o-auth-configuration-endpoint"
+ ],
+ "summary": "Deletes OAuth Integration Settings",
+ "operationId": "deleteOAuthSetting",
+ "parameters": [
+ {
+ "name": "authId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/sso/me": {
+ "get": {
+ "tags": [
+ "sso-endpoint"
+ ],
+ "summary": "Get user details",
+ "operationId": "user",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "sso-endpoint"
+ ],
+ "summary": "Get user details",
+ "operationId": "user_1",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/sso/user": {
+ "get": {
+ "tags": [
+ "sso-endpoint"
+ ],
+ "summary": "Get user details",
+ "operationId": "user_2",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "sso-endpoint"
+ ],
+ "summary": "Get user details",
+ "operationId": "user_3",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/settings/auth/{authType}/{integrationId}": {
+ "put": {
+ "tags": [
+ "auth-configuration-endpoint"
+ ],
+ "summary": "Update auth integration",
+ "operationId": "updateAuthIntegration",
+ "parameters": [
+ {
+ "name": "authType",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "ad",
+ "ldap",
+ "saml"
+ ]
+ }
+ },
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateAuthRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AbstractAuthResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/sso/me/github/synchronize": {
+ "post": {
+ "tags": [
+ "github-endpoint"
+ ],
+ "summary": "Synchronizes logged-in GitHub user",
+ "operationId": "synchronize",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/settings/auth/{authType}": {
+ "get": {
+ "tags": [
+ "auth-configuration-endpoint"
+ ],
+ "summary": "Retrieves auth settings",
+ "operationId": "getSettings",
+ "parameters": [
+ {
+ "name": "authType",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "ad",
+ "ldap",
+ "saml"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AbstractAuthResource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "auth-configuration-endpoint"
+ ],
+ "summary": "Create new auth integration",
+ "operationId": "createAuthIntegration",
+ "parameters": [
+ {
+ "name": "authType",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "ad",
+ "ldap",
+ "saml"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateAuthRQ"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AbstractAuthResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/settings/oauth": {
+ "get": {
+ "tags": [
+ "o-auth-configuration-endpoint"
+ ],
+ "summary": "Returns OAuth Server Settings",
+ "operationId": "getOAuthSettings",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/OAuthRegistrationResource"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/settings/auth/{integrationId}": {
+ "delete": {
+ "tags": [
+ "auth-configuration-endpoint"
+ ],
+ "summary": "Retrieves auth settings",
+ "operationId": "deleteSettings",
+ "parameters": [
+ {
+ "name": "integrationId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OperationCompletionRS"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AbstractAuthResource": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "OAuthRegistrationResource": {
+ "required": [
+ "clientId",
+ "clientSecret"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecret": {
+ "type": "string"
+ },
+ "clientAuthMethod": {
+ "type": "string"
+ },
+ "authGrantType": {
+ "type": "string"
+ },
+ "redirectUrlTemplate": {
+ "type": "string"
+ },
+ "authorizationUri": {
+ "pattern": "^(http://|https://)?(www\\.)?([a-zA-Z0-9-]+)(\\.[a-zA-Z0-9-]+)*(:[0-9]+)?(/[a-z_-]+)*$",
+ "type": "string",
+ "example": "string"
+ },
+ "tokenUri": {
+ "pattern": "^(http://|https://)?(www\\.)?([a-zA-Z0-9-]+)(\\.[a-zA-Z0-9-]+)*(:[0-9]+)?(/[a-z_-]+)*$",
+ "type": "string",
+ "example": "string"
+ },
+ "userInfoEndpointUri": {
+ "type": "string"
+ },
+ "userInfoEndpointNameAttribute": {
+ "type": "string"
+ },
+ "jwkSetUri": {
+ "type": "string"
+ },
+ "clientName": {
+ "type": "string"
+ },
+ "scopes": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "restrictions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "OperationCompletionRS": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "UpdateAuthRQ": {
+ "required": [
+ "enabled",
+ "integrationParameters"
+ ],
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "integrationParameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "securitySchemes": {
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/docs/api/versioned_sidebars/api-sidebars.ts b/docs/api/versioned_sidebars/api-sidebars.ts
index 5cbd09c97..c05a2639d 100644
--- a/docs/api/versioned_sidebars/api-sidebars.ts
+++ b/docs/api/versioned_sidebars/api-sidebars.ts
@@ -14,7 +14,7 @@ const apiSidebars: SidebarsConfig = {
{
type: 'html',
defaultStyle: false,
- value: versionCrumb(`v5.11`),
+ value: versionCrumb(`v5.12`),
className: 'version-crumb',
},
{
@@ -30,6 +30,31 @@ const apiSidebars: SidebarsConfig = {
},
],
// This is the sidebar for versioned Service API
+ 'service-api-5.11': [
+ {
+ type: 'html',
+ defaultStyle: false,
+ value: versionSelector(serviceApiVersions),
+ className: 'version-button',
+ },
+ {
+ type: 'html',
+ defaultStyle: false,
+ value: versionCrumb(`v5.11`),
+ className: 'version-crumb',
+ },
+ {
+ type: 'category',
+ label: 'Service API',
+ link: {
+ type: 'generated-index',
+ title: 'Service API',
+ description: 'This is a generated index of the ReportPortal Service API.',
+ slug: '/category/api/service-api-5.11'
+ },
+ items: require('../service-api/versions/5.11/sidebar.ts')
+ }
+ ],
'service-api-5.10': [
{
type: 'html',
diff --git a/docs/api/versioned_sidebars/uat-sidebars.ts b/docs/api/versioned_sidebars/uat-sidebars.ts
index ce94eb5a7..ce2ded31f 100644
--- a/docs/api/versioned_sidebars/uat-sidebars.ts
+++ b/docs/api/versioned_sidebars/uat-sidebars.ts
@@ -14,7 +14,7 @@ const uatSidebars: SidebarsConfig = {
{
type: 'html',
defaultStyle: false,
- value: versionCrumb(`v5.11`),
+ value: versionCrumb(`v5.12`),
className: 'version-crumb',
},
{
@@ -30,6 +30,31 @@ const uatSidebars: SidebarsConfig = {
},
],
// This is the sidebar for versioned Service UAT
+ 'service-uat-5.11': [
+ {
+ type: 'html',
+ defaultStyle: false,
+ value: versionSelector(serviceUatVersions),
+ className: 'version-button',
+ },
+ {
+ type: 'html',
+ defaultStyle: false,
+ value: versionCrumb(`v5.11`),
+ className: 'version-crumb',
+ },
+ {
+ type: 'category',
+ label: 'Service Authorization',
+ link: {
+ type: 'generated-index',
+ title: 'Service Authorization',
+ description: 'This is a generated index of the ReportPortal Authtorization API.',
+ slug: '/category/api/service-uat-5.11'
+ },
+ items: require('../service-uat/versions/5.11/sidebar.ts')
+ }
+ ],
'service-uat-5.10': [
{
type: 'html',
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 783f51eaf..f1875deff 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -2,6 +2,7 @@
// Note: type annotations allow type checking and IDEs autocompletion
import { themes } from 'prism-react-renderer';
+import openapiConfig from './src/config/openapi.config';
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;
@@ -232,56 +233,7 @@ const config = {
{
id: 'openapi',
docsPluginId: 'classic', // e.g. "classic" or the plugin-content-docs id
- config: {
- designApi: {
- specPath:
- 'https://raw.githubusercontent.com/reportportal/reportportal-common-api/main/api/openapi/reportportal.yaml',
- outputDir: 'docs/api/api-design',
- sidebarOptions: {
- groupPathsBy: 'tag',
- categoryLinkSource: 'tag',
- },
- },
- serviceApi: {
- // "serviceApi" is considered the that you will reference in the CLI
- specPath: 'apis/service-api.yaml', // path or URL to the OpenAPI spec
- outputDir: 'docs/api/service-api', // output directory for generated *.mdx and sidebar.js files
- sidebarOptions: {
- groupPathsBy: 'tag', // generate a sidebar.js slice that groups operations by tag
- categoryLinkSource: 'tag',
- },
- version: '5.11',
- label: 'v5.11',
- baseUrl: `${baseUrl}category/api/service-api`, // base URL for the API docs,
- versions: {
- '5.10': {
- specPath: 'apis/5.10/service-api.yaml',
- outputDir: 'docs/api/service-api/versions/5.10',
- label: 'v5.10',
- baseUrl: `${baseUrl}category/api/service-api-5.10`,
- },
- },
- },
- serviceUat: {
- specPath: 'apis/service-uat.yaml',
- outputDir: 'docs/api/service-uat',
- sidebarOptions: {
- groupPathsBy: 'tag',
- categoryLinkSource: 'tag',
- },
- version: '5.11',
- label: 'v5.11',
- baseUrl: `${baseUrl}category/api/service-uat`,
- versions: {
- '5.10': {
- specPath: 'apis/5.10/service-uat.yaml',
- outputDir: 'docs/api/service-uat/versions/5.10',
- label: 'v5.10',
- baseUrl: `${baseUrl}category/api/service-uat-5.10`,
- },
- },
- },
- },
+ ...openapiConfig(baseUrl),
},
],
[
diff --git a/src/config/openapi.config.js b/src/config/openapi.config.js
new file mode 100644
index 000000000..49eb078a2
--- /dev/null
+++ b/src/config/openapi.config.js
@@ -0,0 +1,66 @@
+const openapiConfig = (baseUrl) => ({
+ config: {
+ designApi: {
+ specPath:
+ 'https://raw.githubusercontent.com/reportportal/reportportal-common-api/main/api/openapi/reportportal.yaml',
+ outputDir: 'docs/api/api-design',
+ sidebarOptions: {
+ groupPathsBy: 'tag',
+ categoryLinkSource: 'tag',
+ },
+ },
+ serviceApi: {
+ // "serviceApi" is considered the that you will reference in the CLI
+ specPath: 'apis/service-api.json', // path or URL to the OpenAPI spec
+ outputDir: 'docs/api/service-api', // output directory for generated *.mdx and sidebar.js files
+ sidebarOptions: {
+ groupPathsBy: 'tag', // generate a sidebar.js slice that groups operations by tag
+ categoryLinkSource: 'tag',
+ },
+ version: '5.12',
+ label: 'v5.12',
+ baseUrl: `${baseUrl}category/api/service-api`, // base URL for the API docs,
+ versions: {
+ 5.11: {
+ specPath: 'apis/5.11/service-api.yaml',
+ outputDir: 'docs/api/service-api/versions/5.11',
+ label: 'v5.11',
+ baseUrl: `${baseUrl}category/api/service-api-5.11`,
+ },
+ '5.10': {
+ specPath: 'apis/5.10/service-api.yaml',
+ outputDir: 'docs/api/service-api/versions/5.10',
+ label: 'v5.10',
+ baseUrl: `${baseUrl}category/api/service-api-5.10`,
+ },
+ },
+ },
+ serviceUat: {
+ specPath: 'apis/service-uat.json',
+ outputDir: 'docs/api/service-uat',
+ sidebarOptions: {
+ groupPathsBy: 'tag',
+ categoryLinkSource: 'tag',
+ },
+ version: '5.12',
+ label: 'v5.12',
+ baseUrl: `${baseUrl}category/api/service-uat`,
+ versions: {
+ 5.11: {
+ specPath: 'apis/5.11/service-uat.yaml',
+ outputDir: 'docs/api/service-uat/versions/5.11',
+ label: 'v5.11',
+ baseUrl: `${baseUrl}category/api/service-uat-5.11`,
+ },
+ '5.10': {
+ specPath: 'apis/5.10/service-uat.yaml',
+ outputDir: 'docs/api/service-uat/versions/5.10',
+ label: 'v5.10',
+ baseUrl: `${baseUrl}category/api/service-uat-5.10`,
+ },
+ },
+ },
+ },
+});
+
+export default openapiConfig;