From 95217914675d26553f13a565e860cb8de52f92c6 Mon Sep 17 00:00:00 2001 From: "pavel.butuzov" Date: Mon, 6 Jul 2026 22:57:28 +0300 Subject: [PATCH] feat: support tms 5.8. --- ...cloud-swagger.json => swagger-v2-5.8.json} | 15157 ++++++++++------ README.md | 69 +- docs/AIServicesAPIApi.md | 112 + ...sResultReasonsGroupingSearchPostRequest.md | 13 + .../ApiV2AutotestsResultReasonsPostRequest.md | 15 + docs/ApiV2AutotestsResultReasonsPutRequest.md | 16 + ...AutotestsResultReasonsSearchPostRequest.md | 15 + ...ApiV2CustomAttributesGlobalIdPutRequest.md | 2 +- .../ApiV2CustomAttributesGlobalPostRequest.md | 2 +- ...V2ExternalServicesIdAiModelsPostRequest.md | 12 + ...alServicesExternalServiceIdPatchRequest.md | 13 + ...rnalServicesExternalServiceIdPutRequest.md | 12 + ...ExternalServicesIssuesSearchPostRequest.md | 12 + ...IdAutotestsFailureCategoriesPostRequest.md | 14 + ...tIdAutotestsFailureCategoriesPutRequest.md | 15 + ...tsProjectIdSettingsAutotestsPostRequest.md | 4 +- ...estPlanIdTestPointsAnalyticsPostRequest.md | 13 + ...anIdTestPointsGroupingSearchPostRequest.md | 14 + ...sTestPlanIdTestPointsTestersPostRequest.md | 14 + ...ojectIdWorkItemsPreviewsBulkPostRequest.md | 15 + ...tsProjectIdWorkItemsPreviewsPostRequest.md | 16 + docs/ApiV2UsersPostRequest.md | 19 + ...redStepIdReferencesWorkItemsPostRequest.md | 2 +- ...achmentPutModelAutoTestStepResultsModel.md | 2 +- docs/AttachmentsApi.md | 54 +- docs/AutoTestProjectSettingsApiModel.md | 4 +- docs/AutoTestProjectSettingsApiResult.md | 4 +- docs/AutoTestStepResult.md | 2 +- docs/AutoTestStepResultUpdateRequest.md | 2 +- docs/AutoTestsApi.md | 262 +- docs/BackgroundJobsApi.md | 60 +- docs/ConfigurationsApi.md | 124 +- docs/CreateEmptyRequest.md | 2 +- docs/CreateEmptyTestRunApiModel.md | 2 +- docs/CreateProjectsAttributeRequest.md | 2 +- docs/CreateUserApiModel.md | 18 + docs/CustomAttributeApiResult.md | 4 +- docs/CustomAttributeModel.md | 4 +- docs/CustomAttributePostModel.md | 2 +- docs/CustomAttributePutModel.md | 2 +- docs/CustomAttributeSearchResponseModel.md | 4 +- docs/CustomAttributeTemplatesApi.md | 104 +- docs/CustomAttributesApi.md | 60 +- docs/ExternalIssuesApi.md | 10 +- docs/ExternalServicesApi.md | 96 + docs/FailureCategoriesApi.md | 1342 ++ docs/GlobalCustomAttributePostModel.md | 2 +- docs/GlobalCustomAttributeUpdateModel.md | 2 +- docs/NotificationsApi.md | 62 +- docs/OpenIdConnectionsApi.md | 10 +- docs/ParametersApi.md | 180 +- docs/ProjectAttributeTemplatesApi.md | 34 +- docs/ProjectAttributesApi.md | 76 +- docs/ProjectConfigurationsApi.md | 12 +- docs/ProjectExternalServicesApi.md | 610 + docs/ProjectFailureCategoriesApi.md | 503 + docs/ProjectSectionsApi.md | 12 +- docs/ProjectSettingsApi.md | 20 +- docs/ProjectTestPlanAttributesApi.md | 60 +- docs/ProjectTestPlanTestPointsApi.md | 335 +- docs/ProjectTestPlansApi.md | 68 +- docs/ProjectWorkItemsApi.md | 267 +- docs/ProjectsApi.md | 357 +- ...emoProjectApiResult.md => RoleApiModel.md} | 6 +- docs/RoleApiModelApiCollection.md | 12 + docs/RolesApi.md | 95 + docs/SearchWorkItemsRequest.md | 2 +- docs/SectionsApi.md | 100 +- docs/SharedStepReferencesQueryFilterModel.md | 2 +- docs/TagsApi.md | 84 +- docs/TestPlansApi.md | 458 +- docs/TestPointByTestSuiteModel.md | 2 +- docs/TestPointRelatedToTestResult.md | 2 +- docs/TestPointShortApiResult.md | 2 +- docs/TestPointShortModel.md | 2 +- docs/TestPointsApi.md | 40 +- docs/TestResultHistoryReportApiResult.md | 12 +- docs/TestResultsApi.md | 172 +- docs/TestRunV2ApiResult.md | 6 +- docs/TestRunsApi.md | 320 +- docs/TestStatusesApi.md | 70 +- docs/TestSuiteWorkItemsSearchModel.md | 2 +- docs/TestSuitesApi.md | 158 +- docs/UpdateEmptyRequest.md | 2 +- docs/UpdateEmptyTestRunApiModel.md | 2 +- docs/UpdateProjectsAttributeRequest.md | 2 +- docs/UserApiModel.md | 17 + docs/UserRoleAssignmentsApi.md | 190 + docs/UserStoragesApi.md | 186 + docs/UsersApi.md | 283 +- docs/WebhooksApi.md | 100 +- docs/WebhooksLogsApi.md | 30 +- docs/WorkItemsApi.md | 350 +- docs/WorkItemsCommentsApi.md | 54 +- docs/WorkflowsApi.md | 80 +- genConfig.yml | 2 +- run.sh | 4 +- setup.py | 2 +- src/testit_api_client/__init__.py | 2 +- src/testit_api_client/api/__init__.py | 2 +- .../api/ai_services_api_api.py | 182 + src/testit_api_client/api/attachments_api.py | 12 +- src/testit_api_client/api/auto_tests_api.py | 74 +- .../api/background_jobs_api.py | 12 +- .../api/configurations_api.py | 28 +- .../api/custom_attribute_templates_api.py | 32 +- .../api/custom_attributes_api.py | 12 +- .../api/external_issues_api.py | 2 +- .../api/external_services_api.py | 162 + .../api/failure_categories_api.py | 1954 ++ .../api/notifications_api.py | 20 +- .../api/open_id_connections_api.py | 2 +- src/testit_api_client/api/parameters_api.py | 52 +- .../api/project_attribute_templates_api.py | 10 +- .../api/project_attributes_api.py | 20 +- .../api/project_configurations_api.py | 4 +- .../api/project_external_services_api.py | 918 + .../api/project_failure_categories_api.py | 755 + .../api/project_sections_api.py | 4 +- .../api/project_settings_api.py | 4 +- .../api/project_test_plan_attributes_api.py | 18 +- .../api/project_test_plan_test_points_api.py | 462 +- .../api/project_test_plans_api.py | 18 +- .../api/project_work_items_api.py | 301 +- src/testit_api_client/api/projects_api.py | 197 +- src/testit_api_client/api/roles_api.py | 162 + src/testit_api_client/api/sections_api.py | 28 +- src/testit_api_client/api/tags_api.py | 24 +- src/testit_api_client/api/test_plans_api.py | 154 +- src/testit_api_client/api/test_points_api.py | 8 +- src/testit_api_client/api/test_results_api.py | 42 +- src/testit_api_client/api/test_runs_api.py | 80 +- .../api/test_statuses_api.py | 14 +- src/testit_api_client/api/test_suites_api.py | 40 +- .../api/user_role_assignments_api.py | 327 + .../api/user_storages_api.py | 315 + src/testit_api_client/api/users_api.py | 401 +- src/testit_api_client/api/webhooks_api.py | 20 +- .../api/webhooks_logs_api.py | 6 +- src/testit_api_client/api/work_items_api.py | 112 +- .../api/work_items_comments_api.py | 14 +- src/testit_api_client/api/workflows_api.py | 16 +- src/testit_api_client/api_client.py | 10 +- src/testit_api_client/apis/__init__.py | 10 +- src/testit_api_client/configuration.py | 10 +- ...lt_reasons_grouping_search_post_request.py | 327 + ...2_autotests_result_reasons_post_request.py | 338 + ...v2_autotests_result_reasons_put_request.py | 342 + ...ests_result_reasons_search_post_request.py | 341 + ...custom_attributes_global_id_put_request.py | 4 +- ...2_custom_attributes_global_post_request.py | 4 +- ...rnal_services_id_ai_models_post_request.py | 321 + ...vices_external_service_id_patch_request.py | 323 + ...ervices_external_service_id_put_request.py | 319 + ...nal_services_issues_search_post_request.py | 322 + ...totests_failure_categories_post_request.py | 334 + ...utotests_failure_categories_put_request.py | 338 + ...ject_id_settings_autotests_post_request.py | 8 +- ...n_id_test_points_analytics_post_request.py | 327 + ...est_points_grouping_search_post_request.py | 333 + ...lan_id_test_points_testers_post_request.py | 334 + ...d_work_items_previews_bulk_post_request.py | 335 + ...ect_id_work_items_previews_post_request.py | 351 + .../model/api_v2_users_post_request.py | 350 + ...p_id_references_work_items_post_request.py | 4 +- ..._put_model_auto_test_step_results_model.py | 4 +- .../auto_test_project_settings_api_model.py | 8 +- .../auto_test_project_settings_api_result.py | 8 +- .../model/auto_test_step_result.py | 4 +- .../auto_test_step_result_update_request.py | 4 +- .../model/create_empty_request.py | 4 +- .../model/create_empty_test_run_api_model.py | 4 +- .../create_projects_attribute_request.py | 4 +- .../model/create_user_api_model.py | 302 + .../model/custom_attribute_api_result.py | 8 +- .../model/custom_attribute_model.py | 8 +- .../model/custom_attribute_post_model.py | 4 +- .../model/custom_attribute_put_model.py | 4 +- .../custom_attribute_search_response_model.py | 8 +- .../global_custom_attribute_post_model.py | 4 +- .../global_custom_attribute_update_model.py | 4 +- ...roject_api_result.py => role_api_model.py} | 34 +- .../model/role_api_model_api_collection.py | 274 + .../model/search_work_items_request.py | 4 +- ...ared_step_references_query_filter_model.py | 4 +- .../model/test_point_by_test_suite_model.py | 4 +- .../test_point_related_to_test_result.py | 4 +- .../model/test_point_short_api_result.py | 4 +- .../model/test_point_short_model.py | 4 +- .../test_result_history_report_api_result.py | 24 +- .../model/test_run_v2_api_result.py | 12 +- .../test_suite_work_items_search_model.py | 4 +- .../model/update_empty_request.py | 4 +- .../model/update_empty_test_run_api_model.py | 4 +- .../update_projects_attribute_request.py | 4 +- src/testit_api_client/model/user_api_model.py | 300 + src/testit_api_client/models/__init__.py | 21 +- 197 files changed, 28443 insertions(+), 8254 deletions(-) rename .swagger/{cloud-swagger.json => swagger-v2-5.8.json} (90%) create mode 100644 docs/AIServicesAPIApi.md create mode 100644 docs/ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md create mode 100644 docs/ApiV2AutotestsResultReasonsPostRequest.md create mode 100644 docs/ApiV2AutotestsResultReasonsPutRequest.md create mode 100644 docs/ApiV2AutotestsResultReasonsSearchPostRequest.md create mode 100644 docs/ApiV2ExternalServicesIdAiModelsPostRequest.md create mode 100644 docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md create mode 100644 docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md create mode 100644 docs/ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md create mode 100644 docs/ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md create mode 100644 docs/ApiV2UsersPostRequest.md create mode 100644 docs/CreateUserApiModel.md create mode 100644 docs/ExternalServicesApi.md create mode 100644 docs/FailureCategoriesApi.md create mode 100644 docs/ProjectExternalServicesApi.md create mode 100644 docs/ProjectFailureCategoriesApi.md rename docs/{DemoProjectApiResult.md => RoleApiModel.md} (74%) create mode 100644 docs/RoleApiModelApiCollection.md create mode 100644 docs/RolesApi.md create mode 100644 docs/UserApiModel.md create mode 100644 docs/UserRoleAssignmentsApi.md create mode 100644 docs/UserStoragesApi.md create mode 100644 src/testit_api_client/api/ai_services_api_api.py create mode 100644 src/testit_api_client/api/external_services_api.py create mode 100644 src/testit_api_client/api/failure_categories_api.py create mode 100644 src/testit_api_client/api/project_external_services_api.py create mode 100644 src/testit_api_client/api/project_failure_categories_api.py create mode 100644 src/testit_api_client/api/roles_api.py create mode 100644 src/testit_api_client/api/user_role_assignments_api.py create mode 100644 src/testit_api_client/api/user_storages_api.py create mode 100644 src/testit_api_client/model/api_v2_autotests_result_reasons_grouping_search_post_request.py create mode 100644 src/testit_api_client/model/api_v2_autotests_result_reasons_post_request.py create mode 100644 src/testit_api_client/model/api_v2_autotests_result_reasons_put_request.py create mode 100644 src/testit_api_client/model/api_v2_autotests_result_reasons_search_post_request.py create mode 100644 src/testit_api_client/model/api_v2_external_services_id_ai_models_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_patch_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_put_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_id_external_services_issues_search_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_put_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_bulk_post_request.py create mode 100644 src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_post_request.py create mode 100644 src/testit_api_client/model/api_v2_users_post_request.py create mode 100644 src/testit_api_client/model/create_user_api_model.py rename src/testit_api_client/model/{demo_project_api_result.py => role_api_model.py} (92%) create mode 100644 src/testit_api_client/model/role_api_model_api_collection.py create mode 100644 src/testit_api_client/model/user_api_model.py diff --git a/.swagger/cloud-swagger.json b/.swagger/swagger-v2-5.8.json similarity index 90% rename from .swagger/cloud-swagger.json rename to .swagger/swagger-v2-5.8.json index d8636027..12387c45 100644 --- a/.swagger/cloud-swagger.json +++ b/.swagger/swagger-v2-5.8.json @@ -5,6 +5,110 @@ "version": "v2.0" }, "paths": { + "/api/v2/external-services/{id}/ai/models": { + "post": { + "tags": [ + "AI services API" + ], + "summary": "Ask for models with inquiry filter, cached", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetAIServiceModelsApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AIServiceModelApiResultIReply" + } + } + } + }, + "400": { + "description": "Not valid data or models request errors", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, "/api/v2/attachments/{id}": { "get": { "tags": [ @@ -230,7 +334,7 @@ "Attachments" ], "summary": "Upload new attachment file", - "description": "File size is restricted to 50 MB (52 428 800 bytes)", + "description": "File size is restricted to 1 GB (1 073 741 824 bytes)", "requestBody": { "content": { "multipart/form-data": { @@ -263,7 +367,7 @@ } }, "400": { - "description": "\n- Invalid file contents\n\n- Invalid HTTP headers", + "description": "\r\n- Invalid file contents\r\n\r\n- Invalid HTTP headers", "content": { "application/json": { "schema": { @@ -1000,7 +1104,7 @@ "AutoTests" ], "summary": "Create autotest", - "description": "\nThis method creates a new autotest.\n\nTo add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method.\n\nUse the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan.", + "description": "\r\nThis method creates a new autotest.\r\n\r\nTo add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method.\r\n\r\nUse the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan.", "operationId": "CreateAutoTest", "requestBody": { "content": { @@ -1027,7 +1131,7 @@ } }, "400": { - "description": "\n- Name cannot be empty or contain only white space characters\n\n- External ID cannot be empty or contain only white space characters\n\n- Namespace cannot be empty or contain only white space characters\n\n- Classname cannot be empty or contain only white space characters\n\n- Steps cannot be `null`\n\n- Steps nesting level is more than 15\n\n- Invalid URI", + "description": "\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- External ID cannot be empty or contain only white space characters\r\n\r\n- Namespace cannot be empty or contain only white space characters\r\n\r\n- Classname cannot be empty or contain only white space characters\r\n\r\n- Steps cannot be `null`\r\n\r\n- Steps nesting level is more than 15\r\n\r\n- Invalid URI", "content": { "application/json": { "schema": { @@ -1077,7 +1181,7 @@ } }, "422": { - "description": "\n- Labels have duplicates\n\n- Labels begin with `::`\n\n- Labels with the same base have different values", + "description": "\r\n- Labels have duplicates\r\n\r\n- Labels begin with `::`\r\n\r\n- Labels with the same base have different values", "content": { "application/json": { "schema": { @@ -1093,7 +1197,7 @@ "AutoTests" ], "summary": "Update autotest", - "description": "\nUse case\n\nUser sets autotest updated parameters values (listed in the example) and runs method execution\n\nSystem finds the autotest by the identifier\n\nSystem updates autotest parameters\n\n[Optional] If steps enumeration is set, system creates step items, relates them to autotest\n and deletes relations with current steps( if exist)\n\n[Optional] If Setup enumeration is set, system creates setup items and relates them to autotest\n and deletes relations with current Setup items (if exist)\n\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\n and deletes relations with current teardown items (if exist)\n\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\n and deletes relations with current Labels (if exist)\n\n[Optional] If link enumeration is set, system creates links and relates them to autotest\n and deletes relations with current Links (if exist)\n\nSystem updates autotest and returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets autotest updated parameters values (listed in the example) and runs method execution\r\n\r\nSystem finds the autotest by the identifier\r\n\r\nSystem updates autotest parameters\r\n\r\n[Optional] If steps enumeration is set, system creates step items, relates them to autotest\r\n and deletes relations with current steps( if exist)\r\n\r\n[Optional] If Setup enumeration is set, system creates setup items and relates them to autotest\r\n and deletes relations with current Setup items (if exist)\r\n\r\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\r\n and deletes relations with current teardown items (if exist)\r\n\r\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\r\n and deletes relations with current Labels (if exist)\r\n\r\n[Optional] If link enumeration is set, system creates links and relates them to autotest\r\n and deletes relations with current Links (if exist)\r\n\r\nSystem updates autotest and returns no content response", "operationId": "UpdateAutoTest", "requestBody": { "content": { @@ -1113,7 +1217,7 @@ "description": "OK" }, "400": { - "description": "\n- Name cannot be empty or contain only white space characters\n\n- External ID cannot be empty or contain only white space characters\n\n- Namespace cannot be empty or contain only white space characters\n\n- Classname cannot be empty or contain only white space characters\n\n- Steps cannot be `null`\n\n- Steps nesting level is more than 15\n\n- Invalid URI", + "description": "\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- External ID cannot be empty or contain only white space characters\r\n\r\n- Namespace cannot be empty or contain only white space characters\r\n\r\n- Classname cannot be empty or contain only white space characters\r\n\r\n- Steps cannot be `null`\r\n\r\n- Steps nesting level is more than 15\r\n\r\n- Invalid URI", "content": { "application/json": { "schema": { @@ -1143,7 +1247,7 @@ } }, "404": { - "description": "\n- Autotests with provided ID cannot be found\n\n- Project with provided ID cannot be found\n\n- Link with provided ID cannot be found\n\n- Label with provided ID cannot be found", + "description": "\r\n- Autotests with provided ID cannot be found\r\n\r\n- Project with provided ID cannot be found\r\n\r\n- Link with provided ID cannot be found\r\n\r\n- Label with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -1163,7 +1267,7 @@ } }, "422": { - "description": "\n- Project ID cannot be changed\n\n- Labels have duplicates\n\n- Labels begin with `::`\n\n- Labels with the same base have different values", + "description": "\r\n- Project ID cannot be changed\r\n\r\n- Labels have duplicates\r\n\r\n- Labels begin with `::`\r\n\r\n- Labels with the same base have different values", "content": { "application/json": { "schema": { @@ -1275,7 +1379,7 @@ "AutoTests" ], "summary": "Get autotest by internal or global ID", - "description": "\nUse case\n\nUser sets autotest internal or global identifier and runs method execution\n\nSystem returns autotest, which internal or global identifier equals the identifier value set in the previous action", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal or global identifier and runs method execution\r\n\r\nSystem returns autotest, which internal or global identifier equals the identifier value set in the previous action", "operationId": "GetAutoTestById", "parameters": [ { @@ -1463,7 +1567,7 @@ "AutoTests" ], "summary": "Delete autotest", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier and runs method execution\n\nSystem finds the autotest by the identifier\n\nSystem deletes autotest and returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier and runs method execution\r\n\r\nSystem finds the autotest by the identifier\r\n\r\nSystem deletes autotest and returns no content response", "operationId": "DeleteAutoTest", "parameters": [ { @@ -1550,7 +1654,7 @@ "AutoTests" ], "summary": "Create multiple autotests", - "description": "\nUse case\n\nUser sets autotest parameters (listed in the example) and runs method execution\n\nSystem creates autotest\n\n[Optional] If steps enumeration is set, system creates step items and relates them to autotest\n\n[Optional] If setup enumeration is set, system creates setup items and relates them to autotest\n\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\n\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\n\n[Optional] If link enumeration is set, system creates links and relates them to autotest\n\nSystem returns autotest model (example listed in response parameters)", + "description": "\r\nUse case\r\n\r\nUser sets autotest parameters (listed in the example) and runs method execution\r\n\r\nSystem creates autotest\r\n\r\n[Optional] If steps enumeration is set, system creates step items and relates them to autotest\r\n\r\n[Optional] If setup enumeration is set, system creates setup items and relates them to autotest\r\n\r\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\r\n\r\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\r\n\r\n[Optional] If link enumeration is set, system creates links and relates them to autotest\r\n\r\nSystem returns autotest model (example listed in response parameters)", "operationId": "CreateMultiple", "requestBody": { "content": { @@ -1580,7 +1684,7 @@ } }, "400": { - "description": "\n- Name cannot be empty or contain only white space characters\n\n- External ID cannot be empty or contain only white space characters\n\n- Namespace cannot be empty or contain only white space characters\n\n- Classname cannot be empty or contain only white space characters\n\n- Steps cannot be `null`\n\n- Steps nesting level is more than 15\n\n- Invalid URI", + "description": "\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- External ID cannot be empty or contain only white space characters\r\n\r\n- Namespace cannot be empty or contain only white space characters\r\n\r\n- Classname cannot be empty or contain only white space characters\r\n\r\n- Steps cannot be `null`\r\n\r\n- Steps nesting level is more than 15\r\n\r\n- Invalid URI", "content": { "application/json": { "schema": { @@ -1630,7 +1734,7 @@ } }, "422": { - "description": "\n- Labels have duplicates\n\n- Labels begin with `::`\n\n- Labels with the same base have different values", + "description": "\r\n- Labels have duplicates\r\n\r\n- Labels begin with `::`\r\n\r\n- Labels with the same base have different values", "content": { "application/json": { "schema": { @@ -1646,7 +1750,7 @@ "AutoTests" ], "summary": "Update multiple autotests", - "description": "\nUse case\n\nUser sets autotest updated parameters values (listed in the example) and runs method execution\n\nSystem finds the autotest by the identifier\n\nSystem updates autotest parameters\n\n[Optional] If steps enumeration is set, system creates step items, relates them to autotest\n and deletes relations with current steps( if exist)\n\n[Optional] If Setup enumeration is set, system creates setup items and relates them to autotest\n and deletes relations with current Setup items (if exist)\n\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\n and deletes relations with current teardown items (if exist)\n\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\n and deletes relations with current Labels (if exist)\n\n[Optional] If link enumeration is set, system creates links and relates them to autotest\n and deletes relations with current Links (if exist)\n\nSystem updates autotest and returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets autotest updated parameters values (listed in the example) and runs method execution\r\n\r\nSystem finds the autotest by the identifier\r\n\r\nSystem updates autotest parameters\r\n\r\n[Optional] If steps enumeration is set, system creates step items, relates them to autotest\r\n and deletes relations with current steps( if exist)\r\n\r\n[Optional] If Setup enumeration is set, system creates setup items and relates them to autotest\r\n and deletes relations with current Setup items (if exist)\r\n\r\n[Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest\r\n and deletes relations with current teardown items (if exist)\r\n\r\n[Optional] If label enumeration is set, system creates labels and relates them to autotest\r\n and deletes relations with current Labels (if exist)\r\n\r\n[Optional] If link enumeration is set, system creates links and relates them to autotest\r\n and deletes relations with current Links (if exist)\r\n\r\nSystem updates autotest and returns no content response", "operationId": "UpdateMultiple", "requestBody": { "content": { @@ -1665,7 +1769,7 @@ "description": "No Content" }, "400": { - "description": "\n- Name cannot be empty or contain only white space characters\n\n- External ID cannot be empty or contain only white space characters\n\n- Namespace cannot be empty or contain only white space characters\n\n- Classname cannot be empty or contain only white space characters\n\n- Steps cannot be `null`\n\n- Steps nesting level is more than 15\n\n- Invalid URI", + "description": "\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- External ID cannot be empty or contain only white space characters\r\n\r\n- Namespace cannot be empty or contain only white space characters\r\n\r\n- Classname cannot be empty or contain only white space characters\r\n\r\n- Steps cannot be `null`\r\n\r\n- Steps nesting level is more than 15\r\n\r\n- Invalid URI", "content": { "application/json": { "schema": { @@ -1695,7 +1799,7 @@ } }, "404": { - "description": "\n- Autotests with provided ID cannot be found\n\n- Project with provided ID cannot be found\n\n- Link with provided ID cannot be found\n\n- Label with provided ID cannot be found", + "description": "\r\n- Autotests with provided ID cannot be found\r\n\r\n- Project with provided ID cannot be found\r\n\r\n- Link with provided ID cannot be found\r\n\r\n- Label with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -1715,7 +1819,7 @@ } }, "422": { - "description": "\n- Project ID cannot be changed\n\n- Labels have duplicates\n\n- Labels begin with `::`\n\n- Labels with the same base have different values", + "description": "\r\n- Project ID cannot be changed\r\n\r\n- Labels have duplicates\r\n\r\n- Labels begin with `::`\r\n\r\n- Labels with the same base have different values", "content": { "application/json": { "schema": { @@ -1733,13 +1837,13 @@ "AutoTests" ], "summary": "Get work items linked to autotest", - "description": "\nThis method links an autotest to a test case or a checklist.\n A manual test case with a linked automated work item is marked in the test management system as an autotest.\n You can run it from graphical user interface (GUI). To do that:\n\n1. Open the project in GUI.\n\n 2. Go to Test plans section and switch to the Execution tab.\n\n 3. Select the autotest(s) you want to run using checkboxes.\n\n 4. In the toolbar above the test list, click Run autotests.", + "description": "\r\nThis method links an autotest to a test case or a checklist.\r\n A manual test case with a linked automated work item is marked in the test management system as an autotest.\r\n You can run it from graphical user interface (GUI). To do that:\r\n\r\n1. Open the project in GUI.\r\n\r\n 2. Go to Test plans section and switch to the Execution tab.\r\n\r\n 3. Select the autotest(s) you want to run using checkboxes.\r\n\r\n 4. In the toolbar above the test list, click Run autotests.", "operationId": "GetWorkItemsLinkedToAutoTest", "parameters": [ { "name": "id", "in": "path", - "description": "Specifies the autotest entity ID.\n\nYou can copy it from the address bar in your web browser or use autotest GUID.", + "description": "Specifies the autotest entity ID.\r\n\r\nYou can copy it from the address bar in your web browser or use autotest GUID.", "required": true, "schema": { "type": "string", @@ -1845,7 +1949,7 @@ "AutoTests" ], "summary": "Link autotest with work items", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\nUser sets work item internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem finds the autotest by the autotest identifier\n\nSystem finds the work item by the work item identifier\n\nSystem relates the work item with the autotest and returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\nUser sets work item internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem finds the autotest by the autotest identifier\r\n\r\nSystem finds the work item by the work item identifier\r\n\r\nSystem relates the work item with the autotest and returns no content response", "operationId": "LinkAutoTestToWorkItem", "parameters": [ { @@ -1877,7 +1981,7 @@ "description": "No Content" }, "400": { - "description": "\n- Autotest cannot be linked to shared steps\n\n- Autotest cannot be linked to work item from other project\n\n- Work item ID is invalid", + "description": "\r\n- Autotest cannot be linked to shared steps\r\n\r\n- Autotest cannot be linked to work item from other project\r\n\r\n- Work item ID is invalid", "content": { "application/json": { "schema": { @@ -1907,7 +2011,7 @@ } }, "404": { - "description": "\n- Autotest with provided ID cannot be found\n\n- Work item with provided ID cannot be found", + "description": "\r\n- Autotest with provided ID cannot be found\r\n\r\n- Work item with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -1943,7 +2047,7 @@ "AutoTests" ], "summary": "Unlink autotest from work item", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\n[Optional] User sets workitem internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem finds the autotest by the autotest identifier\n\n[Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it\n from autotest.\n\n[Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest.\n\nSystem returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\n[Optional] User sets workitem internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem finds the autotest by the autotest identifier\r\n\r\n[Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it\r\n from autotest.\r\n\r\n[Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest.\r\n\r\nSystem returns no content response", "operationId": "DeleteAutoTestLinkFromWorkItem", "parameters": [ { @@ -2001,7 +2105,7 @@ } }, "404": { - "description": "\n- Autotest with provided ID cannot be found\n\n- Work item with provided ID cannot be found", + "description": "\r\n- Autotest with provided ID cannot be found\r\n\r\n- Work item with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -2039,7 +2143,7 @@ "AutoTests" ], "summary": "Get test results history for autotest", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\nUser sets getTestResultHistoryReportQuery (listed in the example)\n\nUser runs method execution\n\nSystem search for test results using filters set by user in getTestResultHistoryReportQuery and id\n\nSystem returns the enumeration of test results", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\nUser sets getTestResultHistoryReportQuery (listed in the example)\r\n\r\nUser runs method execution\r\n\r\nSystem search for test results using filters set by user in getTestResultHistoryReportQuery and id\r\n\r\nSystem returns the enumeration of test results", "parameters": [ { "name": "id", @@ -2214,7 +2318,7 @@ "AutoTests" ], "summary": "Get completed tests runs for autotests", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem search for all test runs related to the autotest\n\nSystem returns the enumeration of test runs", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search for all test runs related to the autotest\r\n\r\nSystem returns the enumeration of test runs", "operationId": "GetTestRuns", "parameters": [ { @@ -2311,7 +2415,7 @@ "AutoTests" ], "summary": "Get average autotest duration", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem calculates pass average duration and fail average duration of autotest from all related test results\n\nSystem returns pass average duration and fail average duration for autotest", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem calculates pass average duration and fail average duration of autotest from all related test results\r\n\r\nSystem returns pass average duration and fail average duration for autotest", "operationId": "GetAutoTestAverageDuration", "parameters": [ { @@ -2405,7 +2509,7 @@ "AutoTests" ], "summary": "Get autotest chronology", - "description": "\nUse case\n\nUser sets autotest internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem search all test results related to autotest (with default limit equal 100)\n\nSystem orders the test results by CompletedOn property descending and then orders by CreatedDate property descending\n\nSystem returns test result chronology for autotest", + "description": "\r\nUse case\r\n\r\nUser sets autotest internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search all test results related to autotest (with default limit equal 100)\r\n\r\nSystem orders the test results by CompletedOn property descending and then orders by CreatedDate property descending\r\n\r\nSystem returns test result chronology for autotest", "operationId": "GetAutoTestChronology", "parameters": [ { @@ -2503,7 +2607,7 @@ "AutoTests" ], "summary": "Get identifiers of changed linked work items", - "description": "User permissions for project:\n- Read only\n- Execute\n- Write\n- Full control", + "description": "User permissions for project:\r\n- Read only\r\n- Execute\r\n- Write\r\n- Full control", "parameters": [ { "name": "id", @@ -2599,7 +2703,7 @@ "AutoTests" ], "summary": "Approve changes to work items linked to autotest", - "description": "User permissions for project:\n- Read only\n- Execute\n- Write\n- Full control", + "description": "User permissions for project:\r\n- Read only\r\n- Execute\r\n- Write\r\n- Full control", "parameters": [ { "name": "id", @@ -2693,7 +2797,7 @@ "AutoTests" ], "summary": "Set \"Flaky\" status for multiple autotests", - "description": "User permissions for project:\n- Read only\n- Execute\n- Write\n- Full control", + "description": "User permissions for project:\r\n- Read only\r\n- Execute\r\n- Write\r\n- Full control", "parameters": [ { "name": "Skip", @@ -3669,7 +3773,7 @@ "Configurations" ], "summary": "Get configuration by internal or global ID", - "description": "\nUse case\n\nUser sets configuration internal (guid format) or global (integer format) identifier\n\nUser runs method execution\n\nSystem search configuration using the identifier\n\nSystem returns configuration", + "description": "\r\nUse case\r\n\r\nUser sets configuration internal (guid format) or global (integer format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search configuration using the identifier\r\n\r\nSystem returns configuration", "operationId": "GetConfigurationById", "parameters": [ { @@ -3943,7 +4047,7 @@ "Configurations" ], "summary": "Create Configuration", - "description": "\nUse case\n\nUser sets configuration model (listed in the request example)\n\nUser runs method execution\n\nSystem creates configuration\n\nSystem returns created configuration (listed in the response example)", + "description": "\r\nUse case\r\n\r\nUser sets configuration model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates configuration\r\n\r\nSystem returns created configuration (listed in the response example)", "operationId": "CreateConfiguration", "requestBody": { "content": { @@ -5303,7 +5407,7 @@ "CustomAttributeTemplates" ], "summary": "Get CustomAttributeTemplate by ID", - "description": "\nUse case\n\nUser sets attribute template internal identifier\n\nUser runs method execution\n\nSystem return attribute template (listed in response example)", + "description": "\r\nUse case\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return attribute template (listed in response example)", "parameters": [ { "name": "id", @@ -5394,7 +5498,7 @@ "CustomAttributeTemplates" ], "summary": "Delete CustomAttributeTemplate", - "description": "\nUse case\n\nUser sets attribute template internal identifier\n\nUser runs method execution\n\nSystem search and delete attribute template\n\nSystem returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search and delete attribute template\r\n\r\nSystem returns no content response", "parameters": [ { "name": "id", @@ -5480,7 +5584,7 @@ "CustomAttributeTemplates" ], "summary": "Search CustomAttributeTemplates", - "description": "\nUse case\n\nUser sets search params model (listed in request example)\n\nUser runs method execution\n\nSystem return attribute templates (listed in response example)", + "description": "\r\nUse case\r\n\r\nUser sets search params model (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem return attribute templates (listed in response example)", "parameters": [ { "name": "Skip", @@ -5645,7 +5749,7 @@ "CustomAttributeTemplates" ], "summary": "Create CustomAttributeTemplate", - "description": "\nUse case\n\nUser sets attribute template parameters (listed in request example)\n\nUser runs method execution\n\nSystem creates attribute template\n\nSystem returns attribute template model (example listed in response parameters)", + "description": "\r\nUse case\r\n\r\nUser sets attribute template parameters (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates attribute template\r\n\r\nSystem returns attribute template model (example listed in response parameters)", "requestBody": { "content": { "application/json": { @@ -5823,7 +5927,7 @@ "CustomAttributeTemplates" ], "summary": "Include CustomAttributes to CustomAttributeTemplate", - "description": "\nUse case\n\nUser sets attribute template internal identifier\n\nUser sets attribute internal identifiers\n\nUser runs method execution\n\nSystem add attributes to attributes tempalte", + "description": "\r\nUse case\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser sets attribute internal identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem add attributes to attributes tempalte", "parameters": [ { "name": "id", @@ -5923,7 +6027,7 @@ "CustomAttributeTemplates" ], "summary": "Exclude CustomAttributes from CustomAttributeTemplate", - "description": "\nUse case\n\nUser sets attribute template internal identifier\n\nUser sets attribute internal identifiers\n\nUser runs method execution\n\nSystem delete attributes from attributes tempalte", + "description": "\r\nUse case\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser sets attribute internal identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem delete attributes from attributes tempalte", "parameters": [ { "name": "id", @@ -6023,7 +6127,7 @@ "CustomAttributeTemplates" ], "summary": "Get CustomAttributeTemplate by name", - "description": "\nUse case\n\nUser sets attribute template name\n\nUser runs method execution\n\nSystem search and return list of attribute templates (listed in response example)", + "description": "\r\nUse case\r\n\r\nUser sets attribute template name\r\n\r\nUser runs method execution\r\n\r\nSystem search and return list of attribute templates (listed in response example)", "parameters": [ { "name": "name", @@ -6290,27 +6394,22 @@ } } }, - "/api/v2/notifications/{id}/read": { - "post": { + "/api/v2/external-services/metadata": { + "get": { "tags": [ - "Notifications" - ], - "summary": "Set Notification as read", - "description": "\nUse case\n\nUser sets notification internal (guid format) identifier\n\nUser runs method execution\n\nSystem set notification as read", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "ExternalServices" ], + "summary": "Retrieves the metadata for all available external services", "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalServicesMetadataApiResult" + } + } + } }, "400": { "description": "Bad Request", @@ -6343,7 +6442,7 @@ } }, "404": { - "description": "Can't find notification with notificationId", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -6371,23 +6470,39 @@ } } } - }, - "204": { - "description": "Successful operation" } } } }, - "/api/v2/notifications/read": { + "/api/v2/autotests/resultReasons/grouping-search": { "post": { "tags": [ - "Notifications" + "FailureCategories" ], - "summary": "Set all Notifications as read", - "description": "\nUse case\n\nUser runs method execution\n\nSystem set all notifications as read", + "summary": "Get failure categories with support for filtering, sorting and grouping", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FailureCategoryGroupSearchApiModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "OK" + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FailureCategoryGroupItemApiResultReply" + } + } + } }, "400": { "description": "Bad Request", @@ -6448,69 +6563,23 @@ } } } - }, - "204": { - "description": "Successful operation" } } } }, - "/api/v2/notifications/search": { + "/api/v2/autotests/failure-categories/grouping-search": { "post": { "tags": [ - "Notifications" - ], - "summary": "Search Notifications for current User", - "description": "\nUse case\n\nUser set filter and runs method execution\n\nSystem returns notifications (listed in the response example)", - "parameters": [ - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } - } + "FailureCategories" ], + "summary": "Get failure categories with support for filtering, sorting and grouping", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/NotificationQueryFilterModel" + "$ref": "#/components/schemas/FailureCategoryGroupSearchApiModel" } ] } @@ -6519,40 +6588,11 @@ }, "responses": { "200": { - "description": "Successful operation", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationModel" - } + "$ref": "#/components/schemas/FailureCategoryGroupItemApiResultReply" } } } @@ -6620,25 +6660,12 @@ } } }, - "/api/v2/notifications": { - "get": { + "/api/v2/autotests/resultReasons/search": { + "post": { "tags": [ - "Notifications" + "FailureCategories" ], - "summary": "Get all Notifications for current User", - "description": "\nUse case\n\nUser runs method execution\n\nSystem returns notifications (listed in the response example)", "parameters": [ - { - "name": "notificationType", - "in": "query", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/NotificationTypeModel" - } - ] - } - }, { "name": "Skip", "in": "query", @@ -6680,9 +6707,22 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AutotestResultReasonFilterModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", "headers": { "Pagination-Skip": { "description": "Skipped amount of items", @@ -6714,14 +6754,14 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/NotificationModel" + "$ref": "#/components/schemas/AutotestResultReasonShortGetModel" } } } } }, "400": { - "description": "\norderByStatement must have one '.' and no ',' symbols\n\norderByStatement has invalid length\n\norderByStatement must have uuid as attribute key\n\nSearch field not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6780,33 +6820,106 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/notifications/count": { - "get": { + "/api/v2/autotests/failure-categories/search": { + "post": { "tags": [ - "Notifications" + "FailureCategories" ], - "summary": "Get unread Notifications total in last 7 days", - "description": "\nUse case\n\nUser runs method execution\n\nSystem returns unread notifications total (listed in the response example)", "parameters": [ { - "name": "isRead", + "name": "Skip", "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "boolean" + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AutotestResultReasonFilterModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "type": "integer", - "format": "int32" + "type": "array", + "items": { + "$ref": "#/components/schemas/AutotestResultReasonShortGetModel" + } } } } @@ -6871,13 +6984,25 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/openid-connections": { + "/api/v2/autotests/resultReasons/name/{name}/exists": { "get": { "tags": [ - "OpenIdConnections" + "FailureCategories" + ], + "summary": "Check failure category with the specified name already exists", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } ], "responses": { "200": { @@ -6885,10 +7010,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenIdConnectionClientShortModel" - } + "type": "boolean" } } } @@ -6956,59 +7078,17 @@ } } }, - "/api/v2/parameters": { + "/api/v2/autotests/failure-categories/name/{name}/exists": { "get": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Get all parameters", - "description": "\nUse case\n\n[Optional] User sets isDeleted field value\n\n[Optional] If User sets isDeleted field value as true, System search all deleted parameters\n\n[Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted\n\nIf User did not set isDeleted field value, System search all parameters\n\nSystem returns array of all found parameters(listed in response model)", - "operationId": "GetAllParameters", + "summary": "Check failure category with the specified name already exists", "parameters": [ { - "name": "isDeleted", - "in": "query", - "description": "If result must consist of only actual/deleted parameters", - "schema": { - "type": "boolean" - } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "name", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -7017,39 +7097,10 @@ "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterApiResult" - } + "type": "boolean" } } } @@ -7075,7 +7126,7 @@ } }, "403": { - "description": "Invalid user permissions", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7114,36 +7165,40 @@ } } } - }, - "deprecated": true - }, - "post": { + } + } + }, + "/api/v2/autotests/resultReasons/{id}": { + "get": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Create parameter", - "description": "\nUse case\n\nUser sets parameter model (listed in the request example)\n\nUser runs method execution\n\nSystem creates parameter\n\nSystem returns parameter model", - "operationId": "CreateParameter", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateParameterApiModel" - } - ] - } + "summary": "Get failure category by ID", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "isDeleted", + "in": "query", + "schema": { + "type": "boolean" } } - }, + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ParameterApiResult" + "$ref": "#/components/schemas/FailureCategoryApiResult" } } } @@ -7208,35 +7263,30 @@ } } } - }, - "deprecated": true + } }, - "put": { + "delete": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Update parameter", - "description": "\nUse case\n\nUser sets parameter updated properties(listed in the request example)\n\nUser runs method execution\n\nSystem updated parameter using updated properties\n\nSystem returns no content response", - "operationId": "UpdateParameter", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateParameterApiModel" - } - ] - } + "summary": "Delete failure category", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "204": { "description": "No Content" }, "400": { - "description": "\n- ID is not valid\n\n- DTO is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7266,7 +7316,7 @@ } }, "404": { - "description": "Parameter with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -7295,107 +7345,40 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/search": { - "post": { + "/api/v2/autotests/failure-categories/{id}": { + "get": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Search for parameters", + "summary": "Get failure category by ID", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", + "name": "id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "SearchValue", + "name": "isDeleted", "in": "query", - "description": "Value for searching", "schema": { - "type": "string" + "type": "boolean" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ParametersFilterApiModel" - } - ] - } - } - } - }, "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterApiResult" - } + "$ref": "#/components/schemas/FailureCategoryApiResult" } } } @@ -7460,110 +7443,27 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/parameters/search/groups": { - "post": { + } + }, + "delete": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Search for parameters as group", + "summary": "Delete failure category", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ParameterGroupsFilterApiModel" - } - ] - } - } - } - }, "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterGroupApiResult" - } - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -7625,37 +7525,35 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/{id}": { - "get": { + "/api/v2/autotests/resultReasons": { + "post": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Get parameter by ID", - "description": "\nUse case\n\nUser sets parameter internal (guid format) identifier\n\nUser runs method execution\n\nSystem search parameter using the identifier\n\nSystem returns parameter", - "operationId": "GetParameterById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Parameter internal (UUID) identifier", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Create failure category", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateFailureCategoryApiModel" + } + ] + } } } - ], + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ParameterApiResult" + "$ref": "#/components/schemas/FailureCategoryApiResult" } } } @@ -7691,7 +7589,7 @@ } }, "404": { - "description": "Parameter with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -7720,34 +7618,32 @@ } } } - }, - "deprecated": true + } }, - "delete": { + "put": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Delete parameter", - "description": "\nUse case\n\nUser sets parameter internal (guid format) identifier\n\nSystem search and delete parameter\n\nSystem returns deleted parameter", - "operationId": "DeleteParameter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Parameter internal (UUID) identifier", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Update failure category", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFailureCategoryApiModel" + } + ] + } } } - ], + }, "responses": { "200": { "description": "OK" }, "400": { - "description": "\n- ID is not valid\n\n- DTO is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7797,7 +7693,7 @@ } }, "422": { - "description": "Parameter is in use in iterations", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -7806,133 +7702,35 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/groups": { - "get": { + "/api/v2/autotests/failure-categories": { + "post": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Get parameters as group", - "description": "\nUse case\n\nUser runs method execution\n\nSystem search parameters\n\nSystem returns parameters models as groups (listed in the response example)", - "parameters": [ - { - "name": "parameterKeyIds", - "in": "query", - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - { - "name": "name", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "isDeleted", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "projectIds", - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "nullable": true + "summary": "Create failure category", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateFailureCategoryApiModel" + } + ] } } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } } - ], + }, "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterGroupApiResult" - } + "$ref": "#/components/schemas/FailureCategoryApiResult" } } } @@ -7997,37 +7795,29 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/parameters/key/name/{name}/exists": { - "get": { + } + }, + "put": { "tags": [ - "Parameters" + "FailureCategories" ], - "summary": "Check existence parameter key in system", - "description": "\nUse case\n\nUser sets name of parameter key\n\nUser runs method execution\n\nSystem search parameter key\n\nSystem returns the flag for the existence of the parameter key in the system", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" + "summary": "Update failure category", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFailureCategoryApiModel" + } + ] + } } } - ], + }, "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -8089,45 +7879,33 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/bulk": { + "/api/v2/notifications/{id}/read": { "post": { "tags": [ - "Parameters" + "Notifications" ], - "summary": "Create multiple parameters", - "description": "\nUse case\n\nUser sets list of parameter model (listed in the request example)\n\nUser runs method execution\n\nSystem creates parameters\n\nSystem returns list of parameter model (listed in the response example)", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateParameterApiModel" - } - } + "summary": "Set Notification as read", + "description": "\r\nUse case\r\n\r\nUser sets notification internal (guid format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem set notification as read", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParameterApiResult" - } - } - } - } + "200": { + "description": "OK" }, "400": { - "description": "\n- Parameter model is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8157,7 +7935,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find notification with notificationId", "content": { "application/json": { "schema": { @@ -8185,34 +7963,26 @@ } } } + }, + "204": { + "description": "Successful operation" } - }, - "deprecated": true - }, - "put": { + } + } + }, + "/api/v2/notifications/read": { + "post": { "tags": [ - "Parameters" + "Notifications" ], - "summary": "Update multiple parameters", - "description": "\nUse case\n\nUser sets list of parameter model (listed in the request example)\n\nUser runs method execution\n\nSystem updates parameters", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UpdateParameterApiModel" - } - } - } - } - }, + "summary": "Set all Notifications as read", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem set all notifications as read", "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" }, "400": { - "description": "\n- Parameter model is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8232,7 +8002,7 @@ } }, "403": { - "description": "Invalid user permissions", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8270,38 +8040,117 @@ } } } + }, + "204": { + "description": "Successful operation" } - }, - "deprecated": true + } } }, - "/api/v2/parameters/name/{name}": { - "delete": { + "/api/v2/notifications/search": { + "post": { "tags": [ - "Parameters" + "Notifications" ], - "summary": "Delete parameter by name", - "description": "Deletes parameter and all it's values", - "operationId": "DeleteByName", + "summary": "Search Notifications for current User", + "description": "\r\nUse case\r\n\r\nUser set filter and runs method execution\r\n\r\nSystem returns notifications (listed in the response example)", "parameters": [ { - "name": "name", - "in": "path", - "description": "Name of the parameter", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", "schema": { - "maxLength": 255, - "minLength": 0, "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/NotificationQueryFilterModel" + } + ] + } + } + } + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationModel" + } + } + } + } }, "400": { - "description": "Provided name either is empty or contains only white spaces", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8351,7 +8200,7 @@ } }, "422": { - "description": "Parameter is in use in iterations", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8360,28 +8209,26 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/keys": { + "/api/v2/notifications": { "get": { "tags": [ - "Parameters" + "Notifications" ], - "summary": "Get all parameter keys", - "description": "\nUse case\n\nUser runs method execution\n\nSystem search all parameter keys\n\nSystem returns parameter keys", + "summary": "Get all Notifications for current User", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem returns notifications (listed in the response example)", "parameters": [ { - "name": "projectIds", + "name": "notificationType", "in": "query", "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "nullable": true - } + "allOf": [ + { + "$ref": "#/components/schemas/NotificationTypeModel" + } + ] } }, { @@ -8459,14 +8306,14 @@ "schema": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/NotificationModel" } } } } }, "400": { - "description": "Bad Request", + "description": "\r\norderByStatement must have one '.' and no ',' symbols\r\n\r\norderByStatement has invalid length\r\n\r\norderByStatement must have uuid as attribute key\r\n\r\nSearch field not found", "content": { "application/json": { "schema": { @@ -8525,27 +8372,23 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/{key}/values": { + "/api/v2/notifications/count": { "get": { "tags": [ - "Parameters" + "Notifications" ], - "summary": "Get all parameter key values", - "description": "\nUse case\n\nUser sets parameter key (string format)\n\nUser runs method execution\n\nSystem search parameter values using the key\n\nSystem returns parameter", + "summary": "Get unread Notifications total in last 7 days", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem returns unread notifications total (listed in the response example)", "parameters": [ { - "name": "key", - "in": "path", - "description": "Parameter key (string format)", - "required": true, + "name": "isRead", + "in": "query", "schema": { - "type": "string" - }, - "example": "SomeKey" + "type": "boolean" + } } ], "responses": { @@ -8554,10 +8397,8 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "type": "integer", + "format": "int32" } } } @@ -8622,33 +8463,27 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/parameters/keyId/{keyId}": { - "delete": { + "/api/v2/openid-connections": { + "get": { "tags": [ - "Parameters" - ], - "summary": "Delete parameters by parameter key identifier", - "description": "Deletes parameter and all it's values by parameter key identifier", - "operationId": "DeleteByParameterKeyId", - "parameters": [ - { - "name": "keyId", - "in": "path", - "description": "Identifier of the parameter key", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "OpenIdConnections" ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenIdConnectionClientShortModel" + } + } + } + } }, "400": { "description": "Bad Request", @@ -8671,7 +8506,7 @@ } }, "403": { - "description": "Invalid user permissions", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8701,7 +8536,7 @@ } }, "422": { - "description": "Parameter is in use in iterations", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -8710,42 +8545,106 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/projects/{projectId}/attributes/templates/{templateId}": { - "post": { + "/api/v2/parameters": { + "get": { "tags": [ - "Project attribute templates" + "Parameters" ], - "summary": "Add CustomAttributeTemplate to Project", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser sets attribute template internal identifier\n\nUser runs method execution\n\nSystem add attribute template to project", + "summary": "Get all parameters", + "description": "\r\nUse case\r\n\r\n[Optional] User sets isDeleted field value\r\n\r\n[Optional] If User sets isDeleted field value as true, System search all deleted parameters\r\n\r\n[Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted\r\n\r\nIf User did not set isDeleted field value, System search all parameters\r\n\r\nSystem returns array of all found parameters(listed in response model)", + "operationId": "GetAllParameters", "parameters": [ { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, + "name": "isDeleted", + "in": "query", + "description": "If result must consist of only actual/deleted parameters", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "type": "boolean" } }, { - "name": "templateId", - "in": "path", - "description": "CustomAttributeTemplate internal (UUID) identifier", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "string", - "format": "uuid" + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ParameterApiResult" + } + } + } + } }, "400": { "description": "Bad Request", @@ -8768,7 +8667,7 @@ } }, "403": { - "description": "Update project settings permission for project required", + "description": "Invalid user permissions", "content": { "application/json": { "schema": { @@ -8778,7 +8677,7 @@ } }, "404": { - "description": "Can't find a Project with identifier", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8807,42 +8706,129 @@ } } } - } + }, + "deprecated": true }, - "delete": { + "post": { "tags": [ - "Project attribute templates" + "Parameters" ], - "summary": "Delete CustomAttributeTemplate from Project", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser sets attribute template internal identifier\n\nUser runs method execution\n\nSystem delete attribute template from project", - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "summary": "Create parameter", + "description": "\r\nUse case\r\n\r\nUser sets parameter model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates parameter\r\n\r\nSystem returns parameter model", + "operationId": "CreateParameter", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateParameterApiModel" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ParameterApiResult" + } + } } }, - { - "name": "templateId", - "in": "path", - "description": "CustomAttributeTemplate internal (UUID) identifier", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } } + }, + "deprecated": true + }, + "put": { + "tags": [ + "Parameters" ], + "summary": "Update parameter", + "description": "\r\nUse case\r\n\r\nUser sets parameter updated properties(listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem updated parameter using updated properties\r\n\r\nSystem returns no content response", + "operationId": "UpdateParameter", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateParameterApiModel" + } + ] + } + } + } + }, "responses": { "204": { "description": "No Content" }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is not valid\r\n\r\n- DTO is not valid", "content": { "application/json": { "schema": { @@ -8862,7 +8848,7 @@ } }, "403": { - "description": "Update project settings permission for project required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8872,7 +8858,7 @@ } }, "404": { - "description": "Can't find a Project with identifier", + "description": "Parameter with provided ID was not found", "content": { "application/json": { "schema": { @@ -8901,26 +8887,17 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/attributes/templates/search": { + "/api/v2/parameters/search": { "post": { "tags": [ - "Project attribute templates" + "Parameters" ], - "summary": "Search for custom attributes templates", + "summary": "Search for parameters", "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } - }, { "name": "Skip", "in": "query", @@ -8968,10 +8945,9 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/ProjectCustomAttributesTemplatesFilterModel" + "$ref": "#/components/schemas/ParametersFilterApiModel" } - ], - "description": "Collection of filters to apply to search" + ] } } } @@ -9010,7 +8986,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/ProjectCustomAttributeTemplateGetModel" + "$ref": "#/components/schemas/ParameterApiResult" } } } @@ -9037,7 +9013,7 @@ } }, "403": { - "description": "Project admin permission for project settings is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9076,49 +9052,106 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/attributes": { - "get": { + "/api/v2/parameters/search/groups": { + "post": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Get project attributes", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\n[Optional] User sets isDeleted field value\n\nUser runs method execution\n\nSystem search project\n\n[Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project\n\n[Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted\n\n[Optional] If User did not set isDeleted field value, System search all attributes related to project\n\nSystem returns array of found attributes (listed in response model)", - "operationId": "GetAttributesByProjectId", + "summary": "Search for parameters as group", "parameters": [ { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "type": "integer" } }, { - "name": "isDeleted", + "name": "Take", "in": "query", + "description": "Amount of items to be taken (limit)", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeletionState" - } - ] + "type": "integer" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeModel" + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ParameterGroupsFilterApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ParameterGroupApiResult" } } } @@ -9145,7 +9178,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9184,53 +9217,43 @@ } } } - } - }, - "post": { + }, + "deprecated": true + } + }, + "/api/v2/parameters/{id}": { + "get": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Create project attribute", - "description": "\nUse case\n\nUser sets attribute parameters (listed in request example) and runs method execution\n\nSystem search project\n\nSystem creates attribute and relates it to the project\n\nSystem returns project attribute properties (example listed in response parameters)", - "operationId": "CreateProjectsAttribute", + "summary": "Get parameter by ID", + "description": "\r\nUse case\r\n\r\nUser sets parameter internal (guid format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search parameter using the identifier\r\n\r\nSystem returns parameter", + "operationId": "GetParameterById", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Parameter internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CustomAttributePostModel" - } - ] - } - } - } - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomAttributeModel" + "$ref": "#/components/schemas/ParameterApiResult" } } } }, "400": { - "description": "\n- Attribute is `null`\n\n- Priority is invalid\n\n- Attribute with `Options` type must have an options\n\n- ID is not `null`\n\n- Option ID is not `null`", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9250,7 +9273,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9260,7 +9283,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Parameter with provided ID was not found", "content": { "application/json": { "schema": { @@ -9270,7 +9293,7 @@ } }, "409": { - "description": "\n`CustomAttribute.Name` or `CustomAttribute.Id` are not unique in attributes schemes\n\n`CustomAttributeOptionModel.Id` or `CustomAttributeOptionModel.Value` are not unique in `attributesScheme.Options`", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -9280,7 +9303,7 @@ } }, "422": { - "description": "Cannot add new attribute from template which is in use", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -9289,45 +9312,34 @@ } } } - } + }, + "deprecated": true }, - "put": { + "delete": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Edit attribute of the project", - "operationId": "UpdateProjectsAttribute", + "summary": "Delete parameter", + "description": "\r\nUse case\r\n\r\nUser sets parameter internal (guid format) identifier\r\n\r\nSystem search and delete parameter\r\n\r\nSystem returns deleted parameter", + "operationId": "DeleteParameter", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Unique or global project ID", + "description": "Parameter internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CustomAttributePutModel" - } - ] - } - } - } - }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is not valid\r\n\r\n- DTO is not valid", "content": { "application/json": { "schema": { @@ -9347,7 +9359,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9377,7 +9389,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Parameter is in use in iterations", "content": { "application/json": { "schema": { @@ -9386,25 +9398,54 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/attributes/search": { - "post": { + "/api/v2/parameters/groups": { + "get": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Search for attributes used in the project", - "operationId": "SearchAttributesInProject", + "summary": "Get parameters as group", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem search parameters\r\n\r\nSystem returns parameters models as groups (listed in the response example)", "parameters": [ { - "name": "projectId", - "in": "path", - "description": "Unique or global project ID", - "required": true, + "name": "parameterKeyIds", + "in": "query", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + { + "name": "name", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "isDeleted", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "projectIds", + "in": "query", + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "nullable": true + } } }, { @@ -9448,19 +9489,6 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ProjectAttributesFilterModel" - } - ] - } - } - } - }, "responses": { "200": { "description": "OK", @@ -9495,7 +9523,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomAttributeGetModel" + "$ref": "#/components/schemas/ParameterGroupApiResult" } } } @@ -9522,7 +9550,7 @@ } }, "403": { - "description": "Read permission for project is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9561,36 +9589,24 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/attributes/{attributeId}": { + "/api/v2/parameters/key/name/{name}/exists": { "get": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Get project attribute", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser sets project attribute identifier\n\nUser runs method execution\n\nSystem search project\n\nSystem search project attribute\n\nSystem returns project attribute (listed in response model)", - "operationId": "GetAttributeByProjectId", + "summary": "Check existence parameter key in system", + "description": "\r\nUse case\r\n\r\nUser sets name of parameter key\r\n\r\nUser runs method execution\r\n\r\nSystem search parameter key\r\n\r\nSystem returns the flag for the existence of the parameter key in the system", "parameters": [ { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } - }, - { - "name": "attributeId", + "name": "name", "in": "path", - "description": "Project attribute internal (UUID) or global (integer) identifier", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -9600,7 +9616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomAttributeModel" + "type": "boolean" } } } @@ -9626,7 +9642,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9636,7 +9652,7 @@ } }, "404": { - "description": "\n- Project with provided ID was not found\n\n- Project attribute with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -9665,43 +9681,130 @@ } } } - } - }, - "delete": { + }, + "deprecated": true + } + }, + "/api/v2/parameters/bulk": { + "post": { "tags": [ - "Project attributes" + "Parameters" ], - "summary": "Delete project attribute", - "description": "\nUse case\n\nUser sets project identifier and runs method execution\n\nUser sets attribute identifier\n\nUser runs method execution\n\nSystem search project\n\nSystem search and delete attribute\n\nSystem returns no content response", - "operationId": "DeleteProjectsAttribute", - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "summary": "Create multiple parameters", + "description": "\r\nUse case\r\n\r\nUser sets list of parameter model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates parameters\r\n\r\nSystem returns list of parameter model (listed in the response example)", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateParameterApiModel" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ParameterApiResult" + } + } + } } }, - { - "name": "attributeId", - "in": "path", - "description": "Project attribute internal (UUID)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "400": { + "description": "\r\n- Parameter model is not valid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } } + }, + "deprecated": true + }, + "put": { + "tags": [ + "Parameters" ], + "summary": "Update multiple parameters", + "description": "\r\nUse case\r\n\r\nUser sets list of parameter model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem updates parameters", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UpdateParameterApiModel" + } + } + } + } + }, "responses": { "204": { - "description": "Successful operation" + "description": "No Content" }, "400": { - "description": "\n- Project ID is invalid\n\n- Project attribute ID is invalid\n\n- Attribute is empty", + "description": "\r\n- Parameter model is not valid", "content": { "application/json": { "schema": { @@ -9721,7 +9824,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Invalid user permissions", "content": { "application/json": { "schema": { @@ -9731,7 +9834,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -9760,45 +9863,37 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/configurations": { - "get": { + "/api/v2/parameters/name/{name}": { + "delete": { "tags": [ - "Project configurations" + "Parameters" ], - "summary": "Get project configurations", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser runs method execution\n\nSystem search project\n\nSystem search all configurations related to project\n\nSystem returns array of found configurations (listed in response model)", - "operationId": "GetConfigurationsByProjectId", + "summary": "Delete parameter by name", + "description": "Deletes parameter and all it's values", + "operationId": "DeleteByName", "parameters": [ { - "name": "projectId", + "name": "name", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Name of the parameter", "required": true, "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "maxLength": 255, + "minLength": 0, + "type": "string" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConfigurationModel" - } - } - } - } + "204": { + "description": "No Content" }, "400": { - "description": "Bad Request", + "description": "Provided name either is empty or contains only white spaces", "content": { "application/json": { "schema": { @@ -9818,7 +9913,7 @@ } }, "403": { - "description": "Read permission for configurations required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9828,7 +9923,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -9848,7 +9943,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Parameter is in use in iterations", "content": { "application/json": { "schema": { @@ -9857,26 +9952,28 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/sections": { + "/api/v2/parameters/keys": { "get": { "tags": [ - "Project sections" + "Parameters" ], - "summary": "Get project sections", - "description": "\nUse case\n\nUser sets project internal or global identifier and runs method execution\n\nSystem search project\n\nSystem search all sections related to the project\n\nSystem returns array of sections (listed in response)", - "operationId": "GetSectionsByProjectId", + "summary": "Get all parameter keys", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem search all parameter keys\r\n\r\nSystem returns parameter keys", "parameters": [ { - "name": "projectId", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, + "name": "projectIds", + "in": "query", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "nullable": true + } } }, { @@ -9922,7 +10019,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successful operation", "headers": { "Pagination-Skip": { "description": "Skipped amount of items", @@ -9954,7 +10051,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/SectionModel" + "type": "string" } } } @@ -9981,7 +10078,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -10020,35 +10117,39 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/settings/autotests": { + "/api/v2/parameters/{key}/values": { "get": { "tags": [ - "Project settings" + "Parameters" ], - "summary": "Get autotest project settings.", - "operationId": "GetAutotestProjectSettings", + "summary": "Get all parameter key values", + "description": "\r\nUse case\r\n\r\nUser sets parameter key (string format)\r\n\r\nUser runs method execution\r\n\r\nSystem search parameter values using the key\r\n\r\nSystem returns parameter", "parameters": [ { - "name": "projectId", + "name": "key", "in": "path", - "description": "Internal (UUID) or global (integer) identifier", + "description": "Parameter key (string format)", "required": true, "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } + "type": "string" + }, + "example": "SomeKey" } ], "responses": { "200": { - "description": "OK", + "description": "Successful operation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AutoTestProjectSettingsApiResult" + "type": "array", + "items": { + "type": "string" + } } } } @@ -10113,38 +10214,30 @@ } } } - } - }, - "post": { + }, + "deprecated": true + } + }, + "/api/v2/parameters/keyId/{keyId}": { + "delete": { "tags": [ - "Project settings" + "Parameters" ], - "summary": "Set autotest project settings.", + "summary": "Delete parameters by parameter key identifier", + "description": "Deletes parameter and all it's values by parameter key identifier", + "operationId": "DeleteByParameterKeyId", "parameters": [ { - "name": "projectId", + "name": "keyId", "in": "path", - "description": "Internal (UUID) or global (integer) identifier", + "description": "Identifier of the parameter key", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/AutoTestProjectSettingsApiModel" - } - ] - } - } - } - }, "responses": { "204": { "description": "No Content" @@ -10170,7 +10263,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Invalid user permissions", "content": { "application/json": { "schema": { @@ -10200,7 +10293,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Parameter is in use in iterations", "content": { "application/json": { "schema": { @@ -10209,17 +10302,17 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{projectId}/testPlans/attributes": { - "get": { + "/api/v2/projects/{projectId}/attributes/templates/{templateId}": { + "post": { "tags": [ - "Project test plan attributes" + "Project attribute templates" ], - "summary": "Get project's test plan attributes", - "description": "\nUse case\n\nUser runs method execution\n\nSystem returns project for test plans attributes by project identifier", - "operationId": "GetCustomAttributeTestPlanProjectRelations", + "summary": "Add CustomAttributeTemplate to Project", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser runs method execution\r\n\r\nSystem add attribute template to project", "parameters": [ { "name": "projectId", @@ -10230,21 +10323,21 @@ "type": "string", "description": "Internal (UUID) or global (integer) identifier" } + }, + { + "name": "templateId", + "in": "path", + "description": "CustomAttributeTemplate internal (UUID) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomAttributeModel" - } - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -10267,7 +10360,7 @@ } }, "403": { - "description": "Read permission for project settings is required", + "description": "Update project settings permission for project required", "content": { "application/json": { "schema": { @@ -10277,7 +10370,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a Project with identifier", "content": { "application/json": { "schema": { @@ -10308,13 +10401,12 @@ } } }, - "post": { + "delete": { "tags": [ - "Project test plan attributes" + "Project attribute templates" ], - "summary": "Add attributes to project's test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier and attributes identifiers\n\nUser runs method execution\n\nSystem updates project and add attributes to project for test plans\n\nSystem returns no content response", - "operationId": "CreateCustomAttributeTestPlanProjectRelations", + "summary": "Delete CustomAttributeTemplate from Project", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser sets attribute template internal identifier\r\n\r\nUser runs method execution\r\n\r\nSystem delete attribute template from project", "parameters": [ { "name": "projectId", @@ -10325,120 +10417,18 @@ "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "\nAttributes must be global", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Update permission for project settings is required", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } }, - "422": { - "description": "Unprocessable Entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - }, - "put": { - "tags": [ - "Project test plan attributes" - ], - "summary": "Update attribute of project's test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier and attribute model\n\nUser runs method execution\n\nSystem updates project and project attribute for test plan\n\nSystem returns no content response", - "operationId": "UpdateCustomAttributeTestPlanProjectRelations", - "parameters": [ { - "name": "projectId", + "name": "templateId", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "CustomAttributeTemplate internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CustomAttributeTestPlanProjectRelationPutModel" - } - ] - } - } - } - }, "responses": { "204": { "description": "No Content" @@ -10464,7 +10454,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Update project settings permission for project required", "content": { "application/json": { "schema": { @@ -10474,7 +10464,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a Project with identifier", "content": { "application/json": { "schema": { @@ -10506,18 +10496,17 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/attributes/search": { + "/api/v2/projects/{projectId}/attributes/templates/search": { "post": { "tags": [ - "Project test plan attributes" + "Project attribute templates" ], - "summary": "Search for attributes used in the project test plans", - "operationId": "SearchTestPlanAttributesInProject", + "summary": "Search for custom attributes templates", "parameters": [ { "name": "projectId", "in": "path", - "description": "Unique or global project ID", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", @@ -10571,9 +10560,10 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/ProjectAttributesFilterModel" + "$ref": "#/components/schemas/ProjectCustomAttributesTemplatesFilterModel" } - ] + ], + "description": "Collection of filters to apply to search" } } } @@ -10612,7 +10602,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomAttributeGetModel" + "$ref": "#/components/schemas/ProjectCustomAttributeTemplateGetModel" } } } @@ -10639,7 +10629,7 @@ } }, "403": { - "description": "Read permission for project is required", + "description": "Project admin permission for project settings is required", "content": { "application/json": { "schema": { @@ -10681,14 +10671,14 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/attributes/{attributeId}": { - "delete": { + "/api/v2/projects/{projectId}/attributes": { + "get": { "tags": [ - "Project test plan attributes" + "Project attributes" ], - "summary": "Delete attribute from project's test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier and attribute identifier\n\nUser runs method execution\n\nSystem updates project and delete attribute from project for test plans\n\nSystem returns no content response", - "operationId": "DeleteCustomAttributeTestPlanProjectRelations", + "summary": "Get project attributes", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\n[Optional] User sets isDeleted field value\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\n[Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project\r\n\r\n[Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted\r\n\r\n[Optional] If User did not set isDeleted field value, System search all attributes related to project\r\n\r\nSystem returns array of found attributes (listed in response model)", + "operationId": "GetAttributesByProjectId", "parameters": [ { "name": "projectId", @@ -10701,18 +10691,30 @@ } }, { - "name": "attributeId", - "in": "path", - "required": true, + "name": "isDeleted", + "in": "query", "schema": { - "type": "string", - "format": "uuid" + "allOf": [ + { + "$ref": "#/components/schemas/DeletionState" + } + ] } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeModel" + } + } + } + } }, "400": { "description": "Bad Request", @@ -10735,7 +10737,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -10775,33 +10777,24 @@ } } } - } - }, - "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun": { + }, "post": { "tags": [ - "Project test plan test points" + "Project attributes" ], - "summary": "Rerun autotests.", + "summary": "Create project attribute", + "description": "\r\nUse case\r\n\r\nUser sets attribute parameters (listed in request example) and runs method execution\r\n\r\nSystem search project\r\n\r\nSystem creates attribute and relates it to the project\r\n\r\nSystem returns project attribute properties (example listed in response parameters)", + "operationId": "CreateProjectsAttribute", "parameters": [ { "name": "projectId", "in": "path", - "description": "Internal (UUID) or global (integer) identifier", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "testPlanId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "requestBody": { @@ -10810,7 +10803,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestPlanTestPointsAutoTestsRerunApiModel" + "$ref": "#/components/schemas/CustomAttributePostModel" } ] } @@ -10818,11 +10811,18 @@ } }, "responses": { - "200": { - "description": "OK" + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomAttributeModel" + } + } + } }, "400": { - "description": "Bad Request", + "description": "\r\n- Attribute is `null`\r\n\r\n- Priority is invalid\r\n\r\n- Attribute with `Options` type must have an options\r\n\r\n- ID is not `null`\r\n\r\n- Option ID is not `null`", "content": { "application/json": { "schema": { @@ -10842,7 +10842,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for project settings is required", "content": { "application/json": { "schema": { @@ -10852,7 +10852,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -10862,7 +10862,7 @@ } }, "409": { - "description": "Conflict", + "description": "\r\n`CustomAttribute.Name` or `CustomAttribute.Id` are not unique in attributes schemes\r\n\r\n`CustomAttributeOptionModel.Id` or `CustomAttributeOptionModel.Value` are not unique in `attributesScheme.Options`", "content": { "application/json": { "schema": { @@ -10872,7 +10872,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Cannot add new attribute from template which is in use", "content": { "application/json": { "schema": { @@ -10882,33 +10882,23 @@ } } } - } - }, - "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run": { - "post": { + }, + "put": { "tags": [ - "Project test plan test points" + "Project attributes" ], - "summary": "Run autotests.", + "summary": "Edit attribute of the project", + "operationId": "UpdateProjectsAttribute", "parameters": [ { "name": "projectId", "in": "path", - "description": "Internal (UUID) or global (integer) identifier", + "description": "Unique or global project ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "testPlanId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "requestBody": { @@ -10917,7 +10907,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestPlanTestPointsAutoTestsRunApiModel" + "$ref": "#/components/schemas/CustomAttributePutModel" } ] } @@ -10925,15 +10915,8 @@ } }, "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestRunNameApiResult" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -10956,7 +10939,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for project settings is required", "content": { "application/json": { "schema": { @@ -10998,32 +10981,24 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/search": { + "/api/v2/projects/{projectId}/attributes/search": { "post": { "tags": [ - "Project test plans" + "Project attributes" ], - "summary": "Get Project TestPlans with analytics", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser sets request body\n\nUser runs method execution\n\nSystem returns project testplans with analytics", + "summary": "Search for attributes used in the project", + "operationId": "SearchAttributesInProject", "parameters": [ { "name": "projectId", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Unique or global project ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } }, - { - "name": "mustUpdateCache", - "in": "query", - "schema": { - "type": "boolean", - "default": false - } - }, { "name": "Skip", "in": "query", @@ -11071,7 +11046,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/ProjectTestPlansFilterModel" + "$ref": "#/components/schemas/ProjectAttributesFilterModel" } ] } @@ -11112,7 +11087,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanWithAnalyticModel" + "$ref": "#/components/schemas/CustomAttributeGetModel" } } } @@ -11139,7 +11114,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for project is required", "content": { "application/json": { "schema": { @@ -11181,13 +11156,14 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/{name}/exists": { + "/api/v2/projects/{projectId}/attributes/{attributeId}": { "get": { "tags": [ - "Project test plans" + "Project attributes" ], - "summary": "Checks if TestPlan exists with the specified name exists for the project", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser runs method execution\n\nSystem purge delete project workitems", + "summary": "Get project attribute", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser sets project attribute identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search project attribute\r\n\r\nSystem returns project attribute (listed in response model)", + "operationId": "GetAttributeByProjectId", "parameters": [ { "name": "projectId", @@ -11196,16 +11172,17 @@ "required": true, "schema": { "type": "string", - "format": "uuid" + "description": "Internal (UUID) or global (integer) identifier" } }, { - "name": "name", + "name": "attributeId", "in": "path", - "description": "TestPlan name to check", + "description": "Project attribute internal (UUID) or global (integer) identifier", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -11215,7 +11192,7 @@ "content": { "application/json": { "schema": { - "type": "boolean" + "$ref": "#/components/schemas/CustomAttributeModel" } } } @@ -11241,7 +11218,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -11251,7 +11228,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\n- Project with provided ID was not found\r\n\r\n- Project attribute with provided ID was not found", "content": { "application/json": { "schema": { @@ -11281,117 +11258,132 @@ } } } - } - }, - "/api/v2/projects/{projectId}/testPlans/analytics": { - "get": { + }, + "delete": { "tags": [ - "Project test plans" + "Project attributes" ], - "summary": "Get TestPlans analytics", - "description": "\nUse case\n\nUser sets project internal identifier\n\nUser sets query params\n\nUser runs method execution\n\nSystem return analytics", + "summary": "Delete project attribute", + "description": "\r\nUse case\r\n\r\nUser sets project identifier and runs method execution\r\n\r\nUser sets attribute identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search and delete attribute\r\n\r\nSystem returns no content response", + "operationId": "DeleteProjectsAttribute", "parameters": [ { "name": "projectId", "in": "path", - "description": "Project internal (UUID) identifier", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", - "format": "uuid" + "description": "Internal (UUID) or global (integer) identifier" } }, { - "name": "isDeleted", - "in": "query", + "name": "attributeId", + "in": "path", + "description": "Project attribute internal (UUID)", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "204": { + "description": "Successful operation" }, - { - "name": "mustUpdateCache", - "in": "query", - "schema": { - "type": "boolean", - "default": false + "400": { + "description": "\r\n- Project ID is invalid\r\n\r\n- Project attribute ID is invalid\r\n\r\n- Attribute is empty", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } } }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" + "403": { + "description": "Update permission for project settings is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" + "404": { + "description": "Project with provided ID was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/configurations": { + "get": { + "tags": [ + "Project configurations" + ], + "summary": "Get project configurations", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search all configurations related to project\r\n\r\nSystem returns array of found configurations (listed in response model)", + "operationId": "GetConfigurationsByProjectId", + "parameters": [ { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, "schema": { - "type": "string" + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" } } ], "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanWithAnalyticModel" + "$ref": "#/components/schemas/ConfigurationModel" } } } @@ -11418,7 +11410,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for configurations required", "content": { "application/json": { "schema": { @@ -11428,7 +11420,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -11460,48 +11452,42 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/delete/bulk": { - "post": { + "/api/v2/projects/{id}/external-services": { + "get": { "tags": [ - "Project test plans" + "Project external services" ], - "summary": "Delete multiple test plans", + "summary": "Retrieves information about external services, including their integration status (enabled or not)", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestPlanSelectModel" - } - ] - } + }, + { + "name": "category", + "in": "query", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiExternalServiceCategory" + } + ] } } - }, + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/ProjectExternalServicesApiResult" } } } @@ -11527,7 +11513,7 @@ } }, "403": { - "description": "- Read permission for the project is required\n- Delete permission for test plans is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -11569,48 +11555,41 @@ } } }, - "/api/v2/projects/{projectId}/testPlans/restore/bulk": { - "post": { + "/api/v2/projects/{id}/external-services/{externalServiceId}": { + "get": { "tags": [ - "Project test plans" + "Project external services" ], - "summary": "Restore multiple test plans", + "summary": "Retrieves settings of an external service", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestPlanSelectModel" - } - ] - } + }, + { + "name": "externalServiceId", + "in": "path", + "description": "External service ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/ProjectExternalServiceSettingsApiResult" } } } @@ -11636,7 +11615,7 @@ } }, "403": { - "description": "Read permission for the archive is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -11676,24 +11655,32 @@ } } } - } - }, - "/api/v2/projects/{projectId}/testPlans/purge/bulk": { - "post": { + }, + "put": { "tags": [ - "Project test plans" + "Project external services" ], - "summary": "Permanently delete multiple archived test plans", + "summary": "Enable an external service", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } + }, + { + "name": "externalServiceId", + "in": "path", + "description": "External service ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -11702,7 +11689,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestPlanSelectModel" + "$ref": "#/components/schemas/EnableProjectExternalServiceApiModel" } ] } @@ -11710,8 +11697,8 @@ } }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" }, "400": { "description": "Bad Request", @@ -11734,7 +11721,7 @@ } }, "403": { - "description": "Full access permission for the archive is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -11774,21 +11761,18 @@ } } } - } - }, - "/api/v2/projects/{projectId}/workItems": { - "get": { + }, + "patch": { "tags": [ - "Project work items" + "Project external services" ], - "summary": "Get project work items", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\n[Optional] User sets isDeleted field value\n\nUser runs method execution\n\nSystem search project\n\n[Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project\n\n[Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted\n\nIf User did not set isDeleted field value, System search all workitems related to project\n\nSystem returns array of found workitems (listed in response model)", - "operationId": "GetWorkItemsByProjectId", + "summary": "Replaces one active external service with another", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Project ID", "required": true, "schema": { "type": "string", @@ -11796,116 +11780,128 @@ } }, { - "name": "isDeleted", - "in": "query", - "description": "If result must consist of only actual/deleted work items", + "name": "externalServiceId", + "in": "path", + "description": "External service ID", + "required": true, "schema": { - "type": "boolean", - "default": false + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ReplaceProjectExternalServiceApiModel" + } + ] + } } + } + }, + "responses": { + "200": { + "description": "OK" }, - { - "name": "tagNames", - "in": "query", - "description": "List of tags to filter by", - "schema": { - "type": "array", - "items": { - "type": "string" + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } } } }, - { - "name": "includeIterations", - "in": "query", - "schema": { - "type": "boolean", - "default": true + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Project external services" + ], + "summary": "Disable an external service", + "parameters": [ { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", + "name": "id", + "in": "path", + "description": "Project ID", + "required": true, "schema": { - "type": "string" + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" } }, { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "externalServiceId", + "in": "path", + "description": "External service ID", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkItemShortModel" - } - } - } - } + "description": "OK" }, "400": { - "description": "\n- `orderBy` statement must have one `.` and no `,` characters\n\n- `orderBy` statement has invalid length\n\n- `orderBy` statement must have UUID as attribute key\n\n- Search field was not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -11925,7 +11921,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -11935,7 +11931,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -11964,66 +11960,25 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/projects/{projectId}/workItems/search": { + "/api/v2/projects/{id}/external-services/issues/search": { "post": { "tags": [ - "Project work items" + "Project external services" ], - "summary": "Search for work items", + "summary": "Searches for external issues using enabled external services in project", "parameters": [ { - "name": "projectId", + "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -12032,7 +11987,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/WorkItemSelectApiModel" + "$ref": "#/components/schemas/SearchExternalIssuesApiModel" } ] } @@ -12042,38 +11997,12 @@ "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/WorkItemShortApiResult" + "$ref": "#/components/schemas/ExternalIssueApiResult" } } } @@ -12100,7 +12029,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -12142,62 +12071,22 @@ } } }, - "/api/v2/projects/{projectId}/workItems/search/grouped": { + "/api/v2/projects/{projectId}/autotests/failure-categories/grouping-search": { "post": { "tags": [ - "Project work items" + "Project failure categories" ], - "summary": "Search for work items and group results by attribute", + "summary": "Get failure categories with support for filtering, sorting and grouping", "parameters": [ { "name": "projectId", "in": "path", - "description": "Unique or global ID of the project", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -12206,7 +12095,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/WorkItemGroupGetModel" + "$ref": "#/components/schemas/FailureCategoryGroupSearchApiModel" } ] } @@ -12216,39 +12105,10 @@ "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkItemGroupModel" - } + "$ref": "#/components/schemas/ProjectFailureCategoryGroupItemApiResultReply" } } } @@ -12316,17 +12176,17 @@ } } }, - "/api/v2/projects/{projectId}/workItems/search/id": { - "post": { + "/api/v2/projects/{projectId}/autotests/failure-categories/{id}": { + "get": { "tags": [ - "Project work items" + "Project failure categories" ], - "summary": "Search for work items and extract IDs only", + "summary": "Get failure category by ID", "parameters": [ { "name": "projectId", "in": "path", - "description": "Unique or global ID of the project", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", @@ -12334,97 +12194,22 @@ } }, { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkItemSelectModel" - } - ], - "description": "Model containing options to filter work items" - } - } - } - }, "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/ProjectDetailedFailureCategoryApiResult" } } } @@ -12450,7 +12235,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -12490,47 +12275,36 @@ } } } - } - }, - "/api/v2/projects/{projectId}/workItems/tags": { - "get": { + }, + "delete": { "tags": [ - "Project work items" + "Project failure categories" ], - "summary": "Get WorkItems Tags", - "description": "\nUse case\n\nUser sets project internal identifier\n\nUser runs method execution\n\nSystem returns work items tags", + "summary": "Delete failure category", "parameters": [ { "name": "projectId", "in": "path", - "description": "Project internal (UUID) identifier", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", - "format": "uuid" + "description": "Internal (UUID) or global (integer) identifier" } }, { - "name": "isDeleted", - "in": "query", + "name": "id", + "in": "path", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TagShortApiResult" - } - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -12595,12 +12369,12 @@ } } }, - "/api/v2/projects/{projectId}/workItems/search/{workItemId}/index": { + "/api/v2/projects/{projectId}/autotests/failure-categories": { "post": { "tags": [ - "Project work items" + "Project failure categories" ], - "summary": "Get work item index (position) in a collection by its id.", + "summary": "Create failure category", "parameters": [ { "name": "projectId", @@ -12611,16 +12385,3997 @@ "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "workItemId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProjectFailureCategoryApiModel" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProjectDetailedFailureCategoryApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Project failure categories" + ], + "summary": "Update failure category", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFailureCategoryProjectApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/sections": { + "get": { + "tags": [ + "Project sections" + ], + "summary": "Get project sections", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search all sections related to the project\r\n\r\nSystem returns array of sections (listed in response)", + "operationId": "GetSectionsByProjectId", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SectionModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for test library is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/settings/autotests": { + "get": { + "tags": [ + "Project settings" + ], + "summary": "Get autotest project settings.", + "operationId": "GetAutotestProjectSettings", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTestProjectSettingsApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "Project settings" + ], + "summary": "Set autotest project settings.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AutoTestProjectSettingsApiModel" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/attributes": { + "get": { + "tags": [ + "Project test plan attributes" + ], + "summary": "Get project's test plan attributes", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem returns project for test plans attributes by project identifier", + "operationId": "GetCustomAttributeTestPlanProjectRelations", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for project settings is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "Project test plan attributes" + ], + "summary": "Add attributes to project's test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attributes identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem updates project and add attributes to project for test plans\r\n\r\nSystem returns no content response", + "operationId": "CreateCustomAttributeTestPlanProjectRelations", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "\r\nAttributes must be global", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Update permission for project settings is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Project test plan attributes" + ], + "summary": "Update attribute of project's test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attribute model\r\n\r\nUser runs method execution\r\n\r\nSystem updates project and project attribute for test plan\r\n\r\nSystem returns no content response", + "operationId": "UpdateCustomAttributeTestPlanProjectRelations", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CustomAttributeTestPlanProjectRelationPutModel" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Update permission for project settings is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/attributes/search": { + "post": { + "tags": [ + "Project test plan attributes" + ], + "summary": "Search for attributes used in the project test plans", + "operationId": "SearchTestPlanAttributesInProject", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global project ID", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ProjectAttributesFilterModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomAttributeGetModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for project is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/attributes/{attributeId}": { + "delete": { + "tags": [ + "Project test plan attributes" + ], + "summary": "Delete attribute from project's test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attribute identifier\r\n\r\nUser runs method execution\r\n\r\nSystem updates project and delete attribute from project for test plans\r\n\r\nSystem returns no content response", + "operationId": "DeleteCustomAttributeTestPlanProjectRelations", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "attributeId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Update permission for project settings is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun": { + "post": { + "tags": [ + "Project test plan test points" + ], + "summary": "Rerun autotests.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "testPlanId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanTestPointsAutoTestsRerunApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run": { + "post": { + "tags": [ + "Project test plan test points" + ], + "summary": "Run autotests.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "testPlanId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanTestPointsAutoTestsRunApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestRunNameApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/grouping-search": { + "post": { + "tags": [ + "Project test plan test points" + ], + "summary": "Search test points in test plan.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "testPlanId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanTestPointsApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestPlanTestPointsGroupSearchApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/testers": { + "post": { + "tags": [ + "Project test plan test points" + ], + "summary": "Distribute test points between the users.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "testPlanId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanTestPointsSetTestersApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/analytics": { + "post": { + "tags": [ + "Project test plan test points" + ], + "summary": "Get test points analytics.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "testPlanId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanTestPointsAnalyticsApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestPlanTestPointsAnalyticsApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/search": { + "post": { + "tags": [ + "Project test plans" + ], + "summary": "Get Project TestPlans with analytics", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser sets request body\r\n\r\nUser runs method execution\r\n\r\nSystem returns project testplans with analytics", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "mustUpdateCache", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ProjectTestPlansFilterModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPlanWithAnalyticModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/{name}/exists": { + "get": { + "tags": [ + "Project test plans" + ], + "summary": "Checks if TestPlan exists with the specified name exists for the project", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser runs method execution\r\n\r\nSystem purge delete project workitems", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "name", + "in": "path", + "description": "TestPlan name to check", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/analytics": { + "get": { + "tags": [ + "Project test plans" + ], + "summary": "Get TestPlans analytics", + "description": "\r\nUse case\r\n\r\nUser sets project internal identifier\r\n\r\nUser sets query params\r\n\r\nUser runs method execution\r\n\r\nSystem return analytics", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "isDeleted", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mustUpdateCache", + "in": "query", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPlanWithAnalyticModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/delete/bulk": { + "post": { + "tags": [ + "Project test plans" + ], + "summary": "Delete multiple test plans", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanSelectModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "- Read permission for the project is required\r\n- Delete permission for test plans is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/restore/bulk": { + "post": { + "tags": [ + "Project test plans" + ], + "summary": "Restore multiple test plans", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanSelectModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for the archive is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/testPlans/purge/bulk": { + "post": { + "tags": [ + "Project test plans" + ], + "summary": "Permanently delete multiple archived test plans", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPlanSelectModel" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Full access permission for the archive is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/workItems": { + "get": { + "tags": [ + "Project work items" + ], + "summary": "Get project work items", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\n[Optional] User sets isDeleted field value\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\n[Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project\r\n\r\n[Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted\r\n\r\nIf User did not set isDeleted field value, System search all workitems related to project\r\n\r\nSystem returns array of found workitems (listed in response model)", + "operationId": "GetWorkItemsByProjectId", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "isDeleted", + "in": "query", + "description": "If result must consist of only actual/deleted work items", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "tagNames", + "in": "query", + "description": "List of tags to filter by", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "includeIterations", + "in": "query", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkItemShortModel" + } + } + } + } + }, + "400": { + "description": "\r\n- `orderBy` statement must have one `.` and no `,` characters\r\n\r\n- `orderBy` statement has invalid length\r\n\r\n- `orderBy` statement must have UUID as attribute key\r\n\r\n- Search field was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for test library is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Project with provided ID was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": true + } + }, + "/api/v2/projects/{projectId}/workItems/search": { + "post": { + "tags": [ + "Project work items" + ], + "summary": "Search for work items", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/WorkItemSelectApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkItemShortApiResult" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for test library is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/workItems/search/grouped": { + "post": { + "tags": [ + "Project work items" + ], + "summary": "Search for work items and group results by attribute", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/WorkItemGroupGetModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkItemGroupModel" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/workItems/search/id": { + "post": { + "tags": [ + "Project work items" + ], + "summary": "Search for work items and extract IDs only", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/WorkItemSelectModel" + } + ], + "description": "Model containing options to filter work items" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Read permission for test library is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/workItems/tags": { + "get": { + "tags": [ + "Project work items" + ], + "summary": "Get WorkItems Tags", + "description": "\r\nUse case\r\n\r\nUser sets project internal identifier\r\n\r\nUser runs method execution\r\n\r\nSystem returns work items tags", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project internal (UUID) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "isDeleted", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagShortApiResult" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/work-items/previews": { + "post": { + "tags": [ + "Project work items" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GenerateWorkItemPreviewsApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateWorkItemPreviewsApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/work-items/previews/bulk": { + "post": { + "tags": [ + "Project work items" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateWorkItemPreviewsApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/{projectId}/workItems/search/{workItemId}/index": { + "post": { + "tags": [ + "Project work items" + ], + "summary": "Get work item index (position) in a collection by its id.", + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "workItemId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/WorkItemSelectApiModel" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkItemIndexApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects": { + "get": { + "tags": [ + "Projects" + ], + "summary": "Get all projects", + "description": "\r\nUse case\r\n\r\n[Optional] User sets isDeleted field value\r\n\r\n[Optional] If User sets isDeleted field value as true, System search all deleted projects\r\n\r\n[Optional] If User sets isDeleted field value as false, System search all projects which are not deleted\r\n\r\nIf User did not set isDeleted field value, System search all projects\r\n\r\nSystem returns array of all found projects(listed in response model)", + "operationId": "GetAllProjects", + "parameters": [ + { + "name": "isDeleted", + "in": "query", + "description": "If result must consist of only actual/deleted parameters", + "schema": { + "type": "boolean" + } + }, + { + "name": "projectName", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProjectApiResult" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Invalid user permissions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": true + }, + "post": { + "tags": [ + "Projects" + ], + "summary": "Create project", + "description": "\r\nUse case\r\n\r\nUser sets project parameters (listed in request example) and runs method execution\r\n\r\nSystem creates project\r\n\r\nSystem returns project model (example listed in response parameters)", + "operationId": "CreateProject", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProjectApiModel" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProjectApiResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Project creator or admin system role is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Project with the same name already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "summary": "Update project", + "description": "\r\nUse case\r\n\r\nUser sets project parameters (listed in request example) and runs method execution\r\n\r\nSystem updates project\r\n\r\nSystem returns updated project model (example listed in response parameters)", + "operationId": "UpdateProject", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProjectApiModel" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "\r\n- ID is invalid\r\n\r\n- Field is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Update permission for projects is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Project with provided ID was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Project with the same name already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/projects/search": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Search for projects", + "parameters": [ { "name": "Skip", "in": "query", @@ -12668,7 +16423,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/WorkItemSelectApiModel" + "$ref": "#/components/schemas/ProjectsFilterModel" } ] } @@ -12707,7 +16462,10 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkItemIndexApiResult" + "type": "array", + "items": { + "$ref": "#/components/schemas/ProjectApiResult" + } } } } @@ -12775,110 +16533,215 @@ } } }, - "/api/v2/projects": { + "/api/v2/projects/{id}": { "get": { "tags": [ "Projects" ], - "summary": "Get all projects", - "description": "\nUse case\n\n[Optional] User sets isDeleted field value\n\n[Optional] If User sets isDeleted field value as true, System search all deleted projects\n\n[Optional] If User sets isDeleted field value as false, System search all projects which are not deleted\n\nIf User did not set isDeleted field value, System search all projects\n\nSystem returns array of all found projects(listed in response model)", - "operationId": "GetAllProjects", + "summary": "Get project by ID", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and runs method execution\r\n\r\nSystem search project\r\n\r\nSystem returns project (example listed in response parameters)", + "operationId": "GetProjectById", "parameters": [ { - "name": "isDeleted", - "in": "query", - "description": "If result must consist of only actual/deleted parameters", + "name": "id", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DetailedProjectApiResult" + } + } } }, - { - "name": "projectName", - "in": "query", - "schema": { - "type": "string" + "400": { + "description": "ID is invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } } }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" + "403": { + "description": "Read permission for projects is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" + "404": { + "description": "Project with provided ID was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "summary": "Patch project", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "parameters": [ { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "description": "Unique or global Id of project", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } + } + } + } + }, "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { "schema": { - "type": "integer" + "$ref": "#/components/schemas/ValidationProblemDetails" } - }, - "Pagination-Take": { - "description": "Taken items", + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { - "type": "integer" + "$ref": "#/components/schemas/ProblemDetails" } - }, - "Pagination-Pages": { - "description": "Expected number of pages", + } + } + }, + "403": { + "description": "Update permission for projects is required", + "content": { + "application/json": { "schema": { - "type": "integer" + "$ref": "#/components/schemas/ProblemDetails" } - }, - "Pagination-Total-Items": { - "description": "Total count of items", + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { "schema": { - "type": "integer" + "$ref": "#/components/schemas/ProblemDetails" } } - }, + } + }, + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProjectApiResult" - } + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "summary": "Archive project", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "responses": { + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -12901,7 +16764,7 @@ } }, "403": { - "description": "Invalid user permissions", + "description": "Project manager or admin system role is required", "content": { "application/json": { "schema": { @@ -12940,39 +16803,119 @@ } } } - }, - "deprecated": true - }, - "post": { + } + } + }, + "/api/v2/projects/name/{name}/exists": { + "get": { "tags": [ "Projects" ], - "summary": "Create project", - "description": "\nUse case\n\nUser sets project parameters (listed in request example) and runs method execution\n\nSystem creates project\n\nSystem returns project model (example listed in response parameters)", - "operationId": "CreateProject", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateProjectApiModel" - } - ] - } + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProjectApiResult" + "type": "boolean" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } + } + } + } + }, + "/api/v2/projects/{id}/restore": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Restore archived project", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + } + ], + "responses": { + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -12995,7 +16938,7 @@ } }, "403": { - "description": "Project creator or admin system role is required", + "description": "Project manager or admin system role is required", "content": { "application/json": { "schema": { @@ -13015,7 +16958,7 @@ } }, "409": { - "description": "Project with the same name already exists", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -13035,33 +16978,32 @@ } } } - }, - "put": { + } + }, + "/api/v2/projects/{id}/purge": { + "post": { "tags": [ "Projects" ], - "summary": "Update project", - "description": "\nUse case\n\nUser sets project parameters (listed in request example) and runs method execution\n\nSystem updates project\n\nSystem returns updated project model (example listed in response parameters)", - "operationId": "UpdateProject", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateProjectApiModel" - } - ] - } + "summary": "Purge the project", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" } } - }, + ], "responses": { - "204": { - "description": "No Content" + "202": { + "description": "Accepted" }, "400": { - "description": "\n- ID is invalid\n\n- Field is required", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -13081,7 +17023,7 @@ } }, "403": { - "description": "Update permission for projects is required", + "description": "Admin system role is required", "content": { "application/json": { "schema": { @@ -13091,7 +17033,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -13101,7 +17043,7 @@ } }, "409": { - "description": "Project with the same name already exists", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -13123,61 +17065,19 @@ } } }, - "/api/v2/projects/search": { + "/api/v2/projects/restore/bulk": { "post": { "tags": [ "Projects" ], - "summary": "Search for projects", - "parameters": [ - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } - } - ], + "summary": "Restore multiple projects", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ProjectsFilterModel" + "$ref": "#/components/schemas/ProjectSelectModel" } ] } @@ -13187,39 +17087,11 @@ "responses": { "200": { "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProjectApiResult" - } + "type": "integer", + "format": "int64" } } } @@ -13245,7 +17117,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Project manager or admin system role is required", "content": { "application/json": { "schema": { @@ -13287,39 +17159,39 @@ } } }, - "/api/v2/projects/{id}": { - "get": { + "/api/v2/projects/purge/bulk": { + "post": { "tags": [ "Projects" ], - "summary": "Get project by ID", - "description": "\nUse case\n\nUser sets project internal or global identifier and runs method execution\n\nSystem search project\n\nSystem returns project (example listed in response parameters)", - "operationId": "GetProjectById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "summary": "Purge multiple projects", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ProjectSelectModel" + } + ] + } } } - ], + }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DetailedProjectApiResult" + "type": "integer", + "format": "int64" } } } }, "400": { - "description": "ID is invalid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -13339,7 +17211,7 @@ } }, "403": { - "description": "Read permission for projects is required", + "description": "Admin system role is required", "content": { "application/json": { "schema": { @@ -13349,7 +17221,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -13379,40 +17251,41 @@ } } } - }, - "patch": { + } + }, + "/api/v2/projects/{id}/autoTestsNamespaces": { + "get": { "tags": [ "Projects" ], - "summary": "Patch project", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "summary": "Get namespaces of autotests in project", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search all autotest related to the project\r\n\r\nSystem returns array of autotest with namespaces and classnames (listed in response)", + "operationId": "GetAutoTestsNamespaces", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global Id of project", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", - "format": "uuid" + "description": "Internal (UUID) or global (integer) identifier" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AutoTestNamespaceApiResult" + } } } } - } - }, - "responses": { - "204": { - "description": "No Content" }, "400": { "description": "Bad Request", @@ -13435,7 +17308,7 @@ } }, "403": { - "description": "Update permission for projects is required", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -13445,7 +17318,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -13475,17 +17348,21 @@ } } } - }, - "delete": { + } + }, + "/api/v2/projects/{id}/globalAttributes": { + "post": { "tags": [ "Projects" ], - "summary": "Archive project", + "summary": "Add global attributes to project", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attributes identifiers\r\n\r\nSystem search project\r\n\r\nSystem relates global attributes with project\r\n\r\nSystem returns no content response", + "operationId": "AddGlobalAttributesToProject", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", @@ -13493,12 +17370,26 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Success" }, "400": { - "description": "Bad Request", + "description": "\r\nAttributes must be global", "content": { "application/json": { "schema": { @@ -13518,7 +17409,7 @@ } }, "403": { - "description": "Project manager or admin system role is required", + "description": "Project admin permission for project settings is required", "content": { "application/json": { "schema": { @@ -13528,7 +17419,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -13560,18 +17451,31 @@ } } }, - "/api/v2/projects/name/{name}/exists": { + "/api/v2/projects/{id}/testPlans": { "get": { "tags": [ "Projects" ], + "summary": "Get project test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\n[Optional] User sets isDeleted field value\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\n[Optional] If User sets isDeleted field value as true, System search all deleted test plans related to\r\n project\r\n\r\n[Optional] If User sets isDeleted field value as false, System search all test plans related to project which\r\n are not deleted\r\n\r\n[Optional] If User did not set isDeleted field value, System search all v related to project\r\n\r\nSystem returns array of found test plans (listed in response model)", + "operationId": "GetTestPlansByProjectId", "parameters": [ { - "name": "name", + "name": "id", "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { - "type": "string" + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "isDeleted", + "in": "query", + "description": "If result must consist of only actual/archived test plans", + "schema": { + "type": "boolean" } } ], @@ -13581,7 +17485,10 @@ "content": { "application/json": { "schema": { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPlanModel" + } } } } @@ -13607,7 +17514,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -13617,7 +17524,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -13649,18 +17556,158 @@ } } }, - "/api/v2/projects/demo": { - "post": { + "/api/v2/projects/{id}/testRuns": { + "get": { "tags": [ "Projects" ], + "summary": "Get project test runs", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search project\r\n\r\nSystem search all test runs related to project\r\n\r\nSystem returns array of found test runs (listed in response model)", + "operationId": "GetTestRunsByProjectId", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Project internal (UUID) or global (integer) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "notStarted", + "in": "query", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "inProgress", + "in": "query", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "stopped", + "in": "query", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "completed", + "in": "query", + "required": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "createdDateFrom", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "createdDateTo", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "testPlanId", + "in": "query", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DemoProjectApiResult" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestRunV2ApiResult" + } } } } @@ -13686,7 +17733,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test result is required", "content": { "application/json": { "schema": { @@ -13696,7 +17743,7 @@ } }, "404": { - "description": "Not Found", + "description": "Project with provided ID was not found", "content": { "application/json": { "schema": { @@ -13728,22 +17775,32 @@ } } }, - "/api/v2/projects/{id}/restore": { - "post": { + "/api/v2/projects/{id}/testPlans/attribute/{attributeId}": { + "delete": { "tags": [ "Projects" ], - "summary": "Restore archived project", + "summary": "Delete attribute from project's test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attribute identifier\r\n\r\nUser runs method execution\r\n\r\nSystem updates project and delete attribute from project for test plans\r\n\r\nSystem returns no content response", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } + }, + { + "name": "attributeId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -13771,7 +17828,7 @@ } }, "403": { - "description": "Project manager or admin system role is required", + "description": "Update permission for project settings is required", "content": { "application/json": { "schema": { @@ -13810,20 +17867,22 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{id}/purge": { - "post": { + "/api/v2/projects/{id}/testPlans/attribute": { + "put": { "tags": [ "Projects" ], - "summary": "Purge the project", + "summary": "Update attribute of project's test plans", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier and attribute model\r\n\r\nUser runs method execution\r\n\r\nSystem updates project and project attribute for test plan\r\n\r\nSystem returns no content response", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Project internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", @@ -13831,9 +17890,22 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CustomAttributeTestPlanProjectRelationPutModel" + } + ] + } + } + } + }, "responses": { - "202": { - "description": "Accepted" + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -13856,7 +17928,7 @@ } }, "403": { - "description": "Admin system role is required", + "description": "Update permission for project settings is required", "content": { "application/json": { "schema": { @@ -13895,39 +17967,32 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/restore/bulk": { - "post": { + "/api/v2/projects/{id}/autoTests": { + "delete": { "tags": [ "Projects" ], - "summary": "Restore multiple projects", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ProjectSelectModel" - } - ] - } + "summary": "Delete all autotests from project", + "operationId": "DeleteProjectAutoTests", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique or global ID of the project", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" } } - }, + ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -13950,7 +18015,7 @@ } }, "403": { - "description": "Project manager or admin system role is required", + "description": "Delete permission for AutoTest is required", "content": { "application/json": { "schema": { @@ -13992,19 +18057,20 @@ } } }, - "/api/v2/projects/purge/bulk": { + "/api/v2/projects/shorts": { "post": { "tags": [ "Projects" ], - "summary": "Purge multiple projects", + "summary": "Get projects short models", + "description": "\r\nUse case\r\n\r\nUser sets query params\r\n\r\nUser runs method execution\r\n\r\nSystem return projects short models", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ProjectSelectModel" + "$ref": "#/components/schemas/GetShortProjectsApiModel" } ] } @@ -14017,8 +18083,7 @@ "content": { "application/json": { "schema": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/ProjectShortApiResultIReply" } } } @@ -14044,7 +18109,7 @@ } }, "403": { - "description": "Admin system role is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -14086,14 +18151,12 @@ } } }, - "/api/v2/projects/{id}/autoTestsNamespaces": { - "get": { + "/api/v2/projects/{id}/favorite": { + "put": { "tags": [ "Projects" ], - "summary": "Get namespaces of autotests in project", - "description": "\nUse case\n\nUser sets project internal or global identifier and runs method execution\n\nSystem search project\n\nSystem search all autotest related to the project\n\nSystem returns array of autotest with namespaces and classnames (listed in response)", - "operationId": "GetAutoTestsNamespaces", + "summary": "Mark Project as favorite", "parameters": [ { "name": "id", @@ -14107,18 +18170,8 @@ } ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AutoTestNamespaceApiResult" - } - } - } - } + "204": { + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -14141,7 +18194,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -14151,7 +18204,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -14183,46 +18236,47 @@ } } }, - "/api/v2/projects/{id}/globalAttributes": { - "post": { + "/api/v2/projects/{id}/failureClasses": { + "get": { "tags": [ "Projects" ], - "summary": "Add global attributes to project", - "description": "\nUse case\n\nUser sets project internal or global identifier and attributes identifiers\n\nSystem search project\n\nSystem relates global attributes with project\n\nSystem returns no content response", - "operationId": "AddGlobalAttributesToProject", + "summary": "Get failure classes", "parameters": [ { "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Unique or global ID of the project", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" } + }, + { + "name": "isDeleted", + "in": "query", + "schema": { + "type": "boolean" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FailureCategoryApiResult" + } } } } - } - }, - "responses": { - "200": { - "description": "Success" }, "400": { - "description": "\nAttributes must be global", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -14242,7 +18296,7 @@ } }, "403": { - "description": "Project admin permission for project settings is required", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -14252,7 +18306,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -14281,17 +18335,17 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{id}/testPlans": { + "/api/v2/projects/{id}/filters": { "get": { "tags": [ "Projects" ], - "summary": "Get project test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\n[Optional] User sets isDeleted field value\n\nUser runs method execution\n\nSystem search project\n\n[Optional] If User sets isDeleted field value as true, System search all deleted test plans related to\n project\n\n[Optional] If User sets isDeleted field value as false, System search all test plans related to project which\n are not deleted\n\n[Optional] If User did not set isDeleted field value, System search all v related to project\n\nSystem returns array of found test plans (listed in response model)", - "operationId": "GetTestPlansByProjectId", + "summary": "Get Project filters", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser runs method execution\r\n\r\nSystem returns project filters", "parameters": [ { "name": "id", @@ -14302,14 +18356,6 @@ "type": "string", "description": "Internal (UUID) or global (integer) identifier" } - }, - { - "name": "isDeleted", - "in": "query", - "description": "If result must consist of only actual/archived test plans", - "schema": { - "type": "boolean" - } } ], "responses": { @@ -14320,7 +18366,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanModel" + "$ref": "#/components/schemas/FilterModel" } } } @@ -14347,7 +18393,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -14357,7 +18403,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -14389,14 +18435,13 @@ } } }, - "/api/v2/projects/{id}/testRuns": { + "/api/v2/projects/{id}/testRuns/full": { "get": { "tags": [ "Projects" ], - "summary": "Get project test runs", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser runs method execution\n\nSystem search project\n\nSystem search all test runs related to project\n\nSystem returns array of found test runs (listed in response model)", - "operationId": "GetTestRunsByProjectId", + "summary": "Get Project TestRuns full models", + "description": "\r\nUse case\r\n\r\nUser sets project internal or global identifier\r\n\r\nUser sets query params\r\n\r\nUser runs method execution\r\n\r\nSystem returns project test runs full models", "parameters": [ { "name": "id", @@ -14408,10 +18453,23 @@ "description": "Internal (UUID) or global (integer) identifier" } }, + { + "name": "includeTestResults", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mustAggregateTestResults", + "in": "query", + "schema": { + "type": "boolean" + } + }, { "name": "notStarted", "in": "query", - "required": true, "schema": { "type": "boolean" } @@ -14419,7 +18477,6 @@ { "name": "inProgress", "in": "query", - "required": true, "schema": { "type": "boolean" } @@ -14427,7 +18484,6 @@ { "name": "stopped", "in": "query", - "required": true, "schema": { "type": "boolean" } @@ -14435,7 +18491,6 @@ { "name": "completed", "in": "query", - "required": true, "schema": { "type": "boolean" } @@ -14539,7 +18594,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestRunV2ApiResult" + "$ref": "#/components/schemas/TestRunApiResult" } } } @@ -14566,7 +18621,7 @@ } }, "403": { - "description": "Read permission for test result is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -14576,7 +18631,7 @@ } }, "404": { - "description": "Project with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -14608,37 +18663,126 @@ } } }, - "/api/v2/projects/{id}/testPlans/attribute/{attributeId}": { - "delete": { + "/api/v2/roles": { + "get": { "tags": [ - "Projects" + "Roles" ], - "summary": "Delete attribute from project's test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier and attribute identifier\n\nUser runs method execution\n\nSystem updates project and delete attribute from project for test plans\n\nSystem returns no content response", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoleApiModelApiCollection" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "/api/v2/sections/{id}": { + "get": { + "tags": [ + "Sections" + ], + "summary": "Get section", + "description": "\r\nUse case\r\n\r\nUser sets section internal (guid format) identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search section by the section identifier\r\n\r\n[Optional] If isDeleted flag equals false, deleted work items are not being searched.\r\n If true, deleted work items are also being searched, null for all work items.\r\n\r\nSystem returns section", + "operationId": "GetSectionById", "parameters": [ { "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Section internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } }, { - "name": "attributeId", - "in": "path", - "required": true, + "name": "isDeleted", + "in": "query", "schema": { - "type": "string", - "format": "uuid" + "allOf": [ + { + "$ref": "#/components/schemas/DeletionState" + } + ] } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SectionWithStepsModel" + } + } + } }, "400": { "description": "Bad Request", @@ -14661,7 +18805,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -14671,7 +18815,7 @@ } }, "404": { - "description": "Not Found", + "description": "Section with provided ID was not found", "content": { "application/json": { "schema": { @@ -14700,26 +18844,23 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/projects/{id}/testPlans/attribute": { - "put": { + } + }, + "patch": { "tags": [ - "Projects" + "Sections" ], - "summary": "Update attribute of project's test plans", - "description": "\nUse case\n\nUser sets project internal or global identifier and attribute model\n\nUser runs method execution\n\nSystem updates project and project attribute for test plan\n\nSystem returns no content response", + "summary": "Patch section", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", "parameters": [ { "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Section internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], @@ -14727,11 +18868,10 @@ "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CustomAttributeTestPlanProjectRelationPutModel" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } } } } @@ -14761,7 +18901,7 @@ } }, "403": { - "description": "Update permission for project settings is required", + "description": "Update permission for section is required", "content": { "application/json": { "schema": { @@ -14800,26 +18940,24 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/projects/{id}/autoTests": { + } + }, "delete": { "tags": [ - "Projects" + "Sections" ], - "summary": "Delete all autotests from project", - "operationId": "DeleteProjectAutoTests", + "summary": "Delete section", + "description": "\r\nUse case\r\n\r\nUser sets section identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search section by the identifier\r\n\r\nSystem search and delete nested sections of the found section\r\n\r\nSystem search and delete workitems related to the found nested sections\r\n\r\nSystem deletes initial section and related workitem\r\n\r\nSystem returns no content response", + "operationId": "DeleteSection", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the project", + "description": "Section internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" } } ], @@ -14848,7 +18986,7 @@ } }, "403": { - "description": "Delete permission for AutoTest is required", + "description": "Delete permission for test library is required", "content": { "application/json": { "schema": { @@ -14858,7 +18996,7 @@ } }, "404": { - "description": "Not Found", + "description": "Section with provided ID was not found", "content": { "application/json": { "schema": { @@ -14878,7 +19016,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Cannot delete root section", "content": { "application/json": { "schema": { @@ -14887,23 +19025,25 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/shorts": { + "/api/v2/sections": { "post": { "tags": [ - "Projects" + "Sections" ], - "summary": "Get projects short models", - "description": "\nUse case\n\nUser sets query params\n\nUser runs method execution\n\nSystem return projects short models", + "summary": "Create section", + "description": "\r\nUse case\r\n\r\nUser sets section properties (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates section property values\r\n\r\nSystem returns section (listed in response example)", + "operationId": "CreateSection", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetShortProjectsApiModel" + "$ref": "#/components/schemas/SectionPostModel" } ] } @@ -14911,18 +19051,18 @@ } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProjectShortApiResultIReply" + "$ref": "#/components/schemas/SectionWithStepsModel" } } } }, "400": { - "description": "Bad Request", + "description": "Cannot create section without parent ID", "content": { "application/json": { "schema": { @@ -14942,7 +19082,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test library is required", "content": { "application/json": { "schema": { @@ -14952,7 +19092,7 @@ } }, "404": { - "description": "Not Found", + "description": "Parent section with provided ID was not found", "content": { "application/json": { "schema": { @@ -14962,7 +19102,7 @@ } }, "409": { - "description": "Conflict", + "description": "Section with the same name already exists in the parent section", "content": { "application/json": { "schema": { @@ -14982,32 +19122,33 @@ } } } - } - }, - "/api/v2/projects/{id}/favorite": { + }, "put": { "tags": [ - "Projects" + "Sections" ], - "summary": "Mark Project as favorite", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "summary": "Update section", + "description": "\r\nUse case\r\n\r\nUser sets section properties (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem search section by the identifier\r\n\r\nSystem updates section using the property values\r\n\r\nSystem returns no content response", + "operationId": "UpdateSection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SectionPutModel" + } + ] + } } } - ], + }, "responses": { "204": { - "description": "Successful operation" + "description": "No Content" }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is invalid\r\n\r\n- Root section cannot be create", "content": { "application/json": { "schema": { @@ -15027,7 +19168,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test library is required", "content": { "application/json": { "schema": { @@ -15037,7 +19178,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\n- Section cannot be found\r\n\r\n- Parent section cannot be found\r\n\r\n- Project cannot be found", "content": { "application/json": { "schema": { @@ -15047,7 +19188,7 @@ } }, "409": { - "description": "Conflict", + "description": "Section with the same name already exists in the parent section", "content": { "application/json": { "schema": { @@ -15057,7 +19198,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "\r\n- Root section cannot be edited\r\n\r\n- Parent ID cannot be changed\r\n\r\n- Project ID cannot be changed", "content": { "application/json": { "schema": { @@ -15069,44 +19210,117 @@ } } }, - "/api/v2/projects/{id}/failureClasses": { - "get": { + "/api/v2/sections/rename": { + "post": { "tags": [ - "Projects" + "Sections" ], - "summary": "Get failure classes", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique or global ID of the project", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } - }, - { - "name": "isDeleted", - "in": "query", - "schema": { - "type": "boolean" + "summary": "Rename section", + "description": "\r\nUse case\r\n\r\nUser sets section identifier and new name (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem search section by the identifier\r\n\r\nSystem updates section name using the new name\r\n\r\nSystem returns no content response", + "operationId": "Rename", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SectionRenameModel" + } + ] + } } } - ], + }, "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FailureCategoryApiResult" - } + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Update permission for test library is required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Section with provided ID was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Section with the same name already exists in the parent section", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Root section cannot be renamed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } + } + } + } + }, + "/api/v2/sections/move": { + "post": { + "tags": [ + "Sections" + ], + "summary": "Move section with all work items into another section", + "operationId": "Move", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SectionMoveModel" + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -15129,7 +19343,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Update permission for test library is required", "content": { "application/json": { "schema": { @@ -15168,45 +19382,139 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/projects/{id}/filters": { + "/api/v2/sections/{id}/workItems": { "get": { "tags": [ - "Projects" + "Sections" ], - "summary": "Get Project filters", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser runs method execution\n\nSystem returns project filters", + "summary": "Get section work items", + "description": "\r\nUse case\r\n\r\nUser sets section identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search section by the identifier\r\n\r\nSystem search work items related to the section\r\n\r\n[Optional] If isDeleted flag equals false, deleted work items are not being searched.\r\n If true, deleted work items are also being searched, null for all work items.\r\n\r\nSystem returns work item collection", + "operationId": "GetWorkItemsBySectionId", "parameters": [ { "name": "id", "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", + "description": "Section internal (UUID) identifier", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" + "format": "uuid" + } + }, + { + "name": "isDeleted", + "in": "query", + "description": "Requested section is deleted", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "tagNames", + "in": "query", + "description": "List of work item tags", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "includeIterations", + "in": "query", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } ], "responses": { "200": { "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterModel" + "$ref": "#/components/schemas/WorkItemShortModel" } } } } }, "400": { - "description": "Bad Request", + "description": "\r\n- `orderBy` statement must have one `.` and no `,` symbols\r\n\r\n- `orderBy` statement has invalid length\r\n\r\n- `orderBy` statement must have UUID as attribute key\r\n\r\n- Search field was not found", "content": { "application/json": { "schema": { @@ -15226,7 +19534,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test library is required", "content": { "application/json": { "schema": { @@ -15236,7 +19544,7 @@ } }, "404": { - "description": "Not Found", + "description": "Section with provided ID was not found", "content": { "application/json": { "schema": { @@ -15265,93 +19573,18 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/projects/{id}/testRuns/full": { + "/api/v2/tags/search": { "get": { "tags": [ - "Projects" + "Tags" ], - "summary": "Get Project TestRuns full models", - "description": "\nUse case\n\nUser sets project internal or global identifier\n\nUser sets query params\n\nUser runs method execution\n\nSystem returns project test runs full models", + "summary": "Search tags", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem returns collection of tags (listed in the response example)", "parameters": [ - { - "name": "id", - "in": "path", - "description": "Project internal (UUID) or global (integer) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } - }, - { - "name": "includeTestResults", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "mustAggregateTestResults", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "notStarted", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "inProgress", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "stopped", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "completed", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "createdDateFrom", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "createdDateTo", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "testPlanId", - "in": "query", - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "Skip", "in": "query", @@ -15395,7 +19628,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successful operation", "headers": { "Pagination-Skip": { "description": "Skipped amount of items", @@ -15427,14 +19660,14 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestRunApiResult" + "$ref": "#/components/schemas/TagApiResult" } } } } }, "400": { - "description": "Bad Request", + "description": "\r\norderByStatement must have one '.' and no ',' symbols\r\n\r\norderByStatement has invalid length\r\n\r\norderByStatement must have uuid as attribute key\r\n\r\nSearch field not found", "content": { "application/json": { "schema": { @@ -15496,50 +19729,97 @@ } } }, - "/api/v2/sections/{id}": { + "/api/v2/tags/testPlansTags": { "get": { "tags": [ - "Sections" + "Tags" ], - "summary": "Get section", - "description": "\nUse case\n\nUser sets section internal (guid format) identifier\n\nUser runs method execution\n\nSystem search section by the section identifier\n\n[Optional] If isDeleted flag equals false, deleted work items are not being searched.\n If true, deleted work items are also being searched, null for all work items.\n\nSystem returns section", - "operationId": "GetSectionById", + "summary": "Get all Tags that are used in TestPlans", + "description": "\r\nUse case\r\n\r\nUser runs method execution\r\n\r\nSystem returns tags (listed in the response example)", "parameters": [ { - "name": "id", - "in": "path", - "description": "Section internal (UUID) identifier", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "string", - "format": "uuid" + "type": "integer" } }, { - "name": "isDeleted", + "name": "Take", "in": "query", + "description": "Amount of items to be taken (limit)", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeletionState" - } - ] + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } ], "responses": { "200": { - "description": "OK", + "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SectionWithStepsModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/TagApiResult" + } } } } }, "400": { - "description": "Bad Request", + "description": "\r\norderByStatement must have one '.' and no ',' symbols\r\n\r\norderByStatement has invalid length\r\n\r\norderByStatement must have uuid as attribute key\r\n\r\nSearch field not found", "content": { "application/json": { "schema": { @@ -15559,7 +19839,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -15569,7 +19849,7 @@ } }, "404": { - "description": "Section with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -15599,43 +19879,68 @@ } } } - }, - "patch": { + } + }, + "/api/v2/tags": { + "post": { "tags": [ - "Sections" - ], - "summary": "Patch section", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Section internal (UUID) identifier", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "Tags" ], + "summary": "Create tag", + "description": "\r\nUse case\r\n\r\nUser sets tag model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates tag\r\n\r\nSystem returns tag model (listed in the response example)", "requestBody": { "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTagApiModel" + } + ] + } + }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" - } + "allOf": [ + { + "$ref": "#/components/schemas/CreateTagApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTagApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTagApiModel" + } + ] } } } }, "responses": { - "204": { - "description": "No Content" + "201": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagApiResult" + } + } + } }, "400": { - "description": "Bad Request", + "description": "\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- Name already in use\r\n\r\n- Name must be no more than 30 characters long", "content": { "application/json": { "schema": { @@ -15655,7 +19960,7 @@ } }, "403": { - "description": "Update permission for section is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -15696,31 +20001,75 @@ } } }, - "delete": { + "put": { "tags": [ - "Sections" + "Tags" ], - "summary": "Delete section", - "description": "\nUse case\n\nUser sets section identifier\n\nUser runs method execution\n\nSystem search section by the identifier\n\nSystem search and delete nested sections of the found section\n\nSystem search and delete workitems related to the found nested sections\n\nSystem deletes initial section and related workitem\n\nSystem returns no content response", - "operationId": "DeleteSection", + "summary": "Update tag", + "description": "\r\nUse case\r\n\r\nUser sets tag ID and model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem updates tag\r\n\r\nSystem returns tag model (listed in the response example)", "parameters": [ { "name": "id", - "in": "path", - "description": "Section internal (UUID) identifier", - "required": true, + "in": "query", "schema": { "type": "string", "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTagApiModel" + } + ] + } + }, + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTagApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTagApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTagApiModel" + } + ] + } + } + } + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagApiResult" + } + } + } }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is not valid\r\n\r\n- Name cannot be empty or contain only white space characters\r\n\r\n- Name already in use\r\n\r\n- Name must be no more than 30 characters long", "content": { "application/json": { "schema": { @@ -15740,7 +20089,7 @@ } }, "403": { - "description": "Delete permission for test library is required", + "description": "Project creator role is required", "content": { "application/json": { "schema": { @@ -15750,7 +20099,7 @@ } }, "404": { - "description": "Section with provided ID was not found", + "description": "Tag with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -15770,7 +20119,7 @@ } }, "422": { - "description": "Cannot delete root section", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -15779,25 +20128,48 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/sections": { - "post": { + } + }, + "delete": { "tags": [ - "Sections" + "Tags" ], - "summary": "Create section", - "description": "\nUse case\n\nUser sets section properties (listed in request example)\n\nUser runs method execution\n\nSystem creates section property values\n\nSystem returns section (listed in response example)", - "operationId": "CreateSection", + "summary": "Delete tags", + "description": "\r\nUse case\r\n\r\nUser sets collection of tags internal (guid format) identifiers\r\n\r\nSystem searches and deletes a collection of tags", "requestBody": { "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectTagsApiModel" + } + ] + } + }, "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SectionPostModel" + "$ref": "#/components/schemas/SelectTagsApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectTagsApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectTagsApiModel" } ] } @@ -15805,18 +20177,11 @@ } }, "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SectionWithStepsModel" - } - } - } + "204": { + "description": "No Content" }, "400": { - "description": "Cannot create section without parent ID", + "description": "\r\n- ID is not valid", "content": { "application/json": { "schema": { @@ -15836,7 +20201,7 @@ } }, "403": { - "description": "Update permission for test library is required", + "description": "System administrator role is required", "content": { "application/json": { "schema": { @@ -15846,7 +20211,7 @@ } }, "404": { - "description": "Parent section with provided ID was not found", + "description": "No tags with provided IDs were found", "content": { "application/json": { "schema": { @@ -15856,7 +20221,7 @@ } }, "409": { - "description": "Section with the same name already exists in the parent section", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -15876,33 +20241,33 @@ } } } - }, - "put": { + } + }, + "/api/v2/tags/{id}": { + "delete": { "tags": [ - "Sections" + "Tags" ], - "summary": "Update section", - "description": "\nUse case\n\nUser sets section properties (listed in request example)\n\nUser runs method execution\n\nSystem search section by the identifier\n\nSystem updates section using the property values\n\nSystem returns no content response", - "operationId": "UpdateSection", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SectionPutModel" - } - ] - } + "summary": "Delete tag", + "description": "\r\nUse case\r\n\r\nUser sets tag internal (guid format) identifier\r\n\r\nSystem search and delete tag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Tag internal (UUID) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "204": { "description": "No Content" }, "400": { - "description": "\n- ID is invalid\n\n- Root section cannot be create", + "description": "\r\n- ID is not valid", "content": { "application/json": { "schema": { @@ -15922,7 +20287,7 @@ } }, "403": { - "description": "Update permission for test library is required", + "description": "System administrator role is required", "content": { "application/json": { "schema": { @@ -15932,7 +20297,7 @@ } }, "404": { - "description": "\n- Section cannot be found\n\n- Parent section cannot be found\n\n- Project cannot be found", + "description": "Tag with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -15942,7 +20307,7 @@ } }, "409": { - "description": "Section with the same name already exists in the parent section", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -15952,7 +20317,7 @@ } }, "422": { - "description": "\n- Root section cannot be edited\n\n- Parent ID cannot be changed\n\n- Project ID cannot be changed", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -15964,30 +20329,37 @@ } } }, - "/api/v2/sections/rename": { - "post": { + "/api/v2/testPlans/{id}": { + "get": { "tags": [ - "Sections" + "TestPlans" ], - "summary": "Rename section", - "description": "\nUse case\n\nUser sets section identifier and new name (listed in request example)\n\nUser runs method execution\n\nSystem search section by the identifier\n\nSystem updates section name using the new name\n\nSystem returns no content response", - "operationId": "Rename", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SectionRenameModel" - } - ] - } - } + "summary": "Get TestPlan by Id", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test plan by the identifier\r\n\r\nSystem returns test plan", + "operationId": "GetTestPlanById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestPlanModel" + } + } + } }, "400": { "description": "Bad Request", @@ -16010,7 +20382,7 @@ } }, "403": { - "description": "Update permission for test library is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -16020,7 +20392,7 @@ } }, "404": { - "description": "Section with provided ID was not found", + "description": "Can't find a Project with id", "content": { "application/json": { "schema": { @@ -16030,7 +20402,7 @@ } }, "409": { - "description": "Section with the same name already exists in the parent section", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -16040,7 +20412,7 @@ } }, "422": { - "description": "Root section cannot be renamed", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -16050,24 +20422,33 @@ } } } - } - }, - "/api/v2/sections/move": { - "post": { + }, + "patch": { "tags": [ - "Sections" + "TestPlans" + ], + "summary": "Patch test plan", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique ID of the test plan", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Move section with all work items into another section", - "operationId": "Move", "requestBody": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SectionMoveModel" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } } } } @@ -16097,7 +20478,7 @@ } }, "403": { - "description": "Update permission for test library is required", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -16137,138 +20518,33 @@ } } } - } - }, - "/api/v2/sections/{id}/workItems": { - "get": { + }, + "delete": { "tags": [ - "Sections" + "TestPlans" ], - "summary": "Get section work items", - "description": "\nUse case\n\nUser sets section identifier\n\nUser runs method execution\n\nSystem search section by the identifier\n\nSystem search work items related to the section\n\n[Optional] If isDeleted flag equals false, deleted work items are not being searched.\n If true, deleted work items are also being searched, null for all work items.\n\nSystem returns work item collection", - "operationId": "GetWorkItemsBySectionId", + "summary": "Delete TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem delete test plan\r\n\r\nSystem returns no content response", + "operationId": "DeleteTestPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Section internal (UUID) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", - "format": "uuid" - } - }, - { - "name": "isDeleted", - "in": "query", - "description": "Requested section is deleted", - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "tagNames", - "in": "query", - "description": "List of work item tags", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeIterations", - "in": "query", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkItemShortModel" - } - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\n- `orderBy` statement must have one `.` and no `,` symbols\n\n- `orderBy` statement has invalid length\n\n- `orderBy` statement must have UUID as attribute key\n\n- Search field was not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -16288,7 +20564,7 @@ } }, "403": { - "description": "Read permission for test library is required", + "description": "Delete permission for test plan required", "content": { "application/json": { "schema": { @@ -16298,7 +20574,7 @@ } }, "404": { - "description": "Section with provided ID was not found", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -16327,101 +20603,42 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/tags/search": { + "/api/v2/testPlans/{id}/analytics": { "get": { "tags": [ - "Tags" + "TestPlans" ], - "summary": "Search tags", - "description": "\nUse case\n\nUser runs method execution\n\nSystem returns collection of tags (listed in the response example)", + "summary": "Get analytics by TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem returns analytics by test plan", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, "schema": { - "type": "string" - } + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Successful operation", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TagApiResult" - } + "$ref": "#/components/schemas/TestPointAnalyticResult" } } } }, "400": { - "description": "\norderByStatement must have one '.' and no ',' symbols\n\norderByStatement has invalid length\n\norderByStatement must have uuid as attribute key\n\nSearch field not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -16451,7 +20668,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a Project with id", "content": { "application/json": { "schema": { @@ -16483,97 +20700,39 @@ } } }, - "/api/v2/tags/testPlansTags": { + "/api/v2/testPlans/{id}/summaries": { "get": { "tags": [ - "Tags" + "TestPlans" ], - "summary": "Get all Tags that are used in TestPlans", - "description": "\nUse case\n\nUser runs method execution\n\nSystem returns tags (listed in the response example)", + "summary": "Get summary by TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem returns summary by test plan", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, "schema": { - "type": "string" - } + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Successful operation", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TagApiResult" - } + "$ref": "#/components/schemas/TestPlanSummaryModel" } } } }, "400": { - "description": "\norderByStatement must have one '.' and no ',' symbols\n\norderByStatement has invalid length\n\norderByStatement must have uuid as attribute key\n\nSearch field not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -16603,7 +20762,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a Test Plan with id", "content": { "application/json": { "schema": { @@ -16635,47 +20794,21 @@ } } }, - "/api/v2/tags": { + "/api/v2/testPlans": { "post": { "tags": [ - "Tags" + "TestPlans" ], - "summary": "Create tag", - "description": "\nUse case\n\nUser sets tag model (listed in the request example)\n\nUser runs method execution\n\nSystem creates tag\n\nSystem returns tag model (listed in the response example)", + "summary": "Create TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan properties (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates test plan\r\n\r\nSystem returns test plan (listed in response example)", + "operationId": "CreateTestPlan", "requestBody": { "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTagApiModel" - } - ] - } - }, "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateTagApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTagApiModel" - } - ] - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTagApiModel" + "$ref": "#/components/schemas/CreateTestPlanApiModel" } ] } @@ -16688,13 +20821,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagApiResult" + "$ref": "#/components/schemas/TestPlanModel" } } } }, "400": { - "description": "\n- Name cannot be empty or contain only white space characters\n\n- Name already in use\n\n- Name must be no more than 30 characters long", + "description": "\r\nField is required\r\n\r\nTags must be no more than 10!", "content": { "application/json": { "schema": { @@ -16714,7 +20847,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -16734,7 +20867,7 @@ } }, "409": { - "description": "Conflict", + "description": "TestPlan with the same name already exists!", "content": { "application/json": { "schema": { @@ -16757,54 +20890,18 @@ }, "put": { "tags": [ - "Tags" - ], - "summary": "Update tag", - "description": "\nUse case\n\nUser sets tag ID and model (listed in the request example)\n\nUser runs method execution\n\nSystem updates tag\n\nSystem returns tag model (listed in the response example)", - "parameters": [ - { - "name": "id", - "in": "query", - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestPlans" ], + "summary": "Update TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan properties(listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem updates test plan\r\n\r\nSystem returns no content response", + "operationId": "UpdateTestPlan", "requestBody": { "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTagApiModel" - } - ] - } - }, "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateTagApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTagApiModel" - } - ] - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTagApiModel" + "$ref": "#/components/schemas/UpdateTestPlanApiModel" } ] } @@ -16812,18 +20909,11 @@ } }, "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagApiResult" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\n- ID is not valid\n\n- Name cannot be empty or contain only white space characters\n\n- Name already in use\n\n- Name must be no more than 30 characters long", + "description": "\r\nField is required\r\n\r\nTags must be no more than 10!\r\n\r\nStartDate can't be more than EndDate!", "content": { "application/json": { "schema": { @@ -16843,7 +20933,7 @@ } }, "403": { - "description": "Project creator role is required", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -16853,7 +20943,7 @@ } }, "404": { - "description": "Tag with provided ID cannot be found", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -16863,7 +20953,7 @@ } }, "409": { - "description": "Conflict", + "description": "TestPlan with the same name already exists!", "content": { "application/json": { "schema": { @@ -16873,7 +20963,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Can't change ProjectId", "content": { "application/json": { "schema": { @@ -16883,59 +20973,35 @@ } } } - }, - "delete": { + } + }, + "/api/v2/testPlans/{id}/restore": { + "post": { "tags": [ - "Tags" + "TestPlans" ], - "summary": "Delete tags", - "description": "\nUse case\n\nUser sets collection of tags internal (guid format) identifiers\n\nSystem searches and deletes a collection of tags", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectTagsApiModel" - } - ] - } - }, - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectTagsApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectTagsApiModel" - } - ] - } + "summary": "Restore TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem restores test plan\r\n\r\nSystem returns no content response", + "operationId": "RestoreTestPlan", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectTagsApiModel" - } - ] - } - } + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { "204": { - "description": "No Content" + "description": "Successful operation" }, "400": { - "description": "\n- ID is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -16955,7 +21021,7 @@ } }, "403": { - "description": "System administrator role is required", + "description": "Update permission for the archive is required", "content": { "application/json": { "schema": { @@ -16965,7 +21031,7 @@ } }, "404": { - "description": "No tags with provided IDs were found", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -16997,22 +21063,22 @@ } } }, - "/api/v2/tags/{id}": { - "delete": { + "/api/v2/testPlans/{id}/purge": { + "post": { "tags": [ - "Tags" + "TestPlans" ], - "summary": "Delete tag", - "description": "\nUse case\n\nUser sets tag internal (guid format) identifier\n\nSystem search and delete tag", + "summary": "Permanently delete test plan from archive", + "operationId": "PurgeTestPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Tag internal (UUID) identifier", + "description": "Unique or global ID of the test plan", "required": true, "schema": { "type": "string", - "format": "uuid" + "description": "Internal (UUID) or global (integer) identifier" } } ], @@ -17021,7 +21087,7 @@ "description": "No Content" }, "400": { - "description": "\n- ID is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -17041,7 +21107,7 @@ } }, "403": { - "description": "System administrator role is required", + "description": "Full access permission for the archive is required", "content": { "application/json": { "schema": { @@ -17051,7 +21117,7 @@ } }, "404": { - "description": "Tag with provided ID cannot be found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -17083,19 +21149,19 @@ } } }, - "/api/v2/testPlans/{id}": { - "get": { + "/api/v2/testPlans/{id}/clone": { + "post": { "tags": [ "TestPlans" ], - "summary": "Get TestPlan by Id", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem search test plan by the identifier\n\nSystem returns test plan", - "operationId": "GetTestPlanById", + "summary": "Clone TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem clones test plan\r\n\r\nSystem returns test plan (listed in response example)", + "operationId": "Clone", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -17105,7 +21171,7 @@ } ], "responses": { - "200": { + "201": { "description": "Successful operation", "content": { "application/json": { @@ -17136,7 +21202,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -17146,7 +21212,7 @@ } }, "404": { - "description": "Can't find a Project with id", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -17176,40 +21242,32 @@ } } } - }, - "patch": { + } + }, + "/api/v2/testPlans/{id}/start": { + "post": { "tags": [ "TestPlans" ], - "summary": "Patch test plan", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "summary": "Start TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem starts the test plan and updates test plan status\r\n\r\nSystem returns no content response", + "operationId": "Start", "parameters": [ { "name": "id", "in": "path", - "description": "Unique ID of the test plan", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", - "format": "uuid" - } + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" - } - } - } - } - }, "responses": { "204": { - "description": "No Content" + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -17232,7 +21290,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -17242,7 +21300,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -17272,19 +21330,21 @@ } } } - }, - "delete": { + } + }, + "/api/v2/testPlans/{id}/pause": { + "post": { "tags": [ "TestPlans" ], - "summary": "Delete TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem delete test plan\n\nSystem returns no content response", - "operationId": "DeleteTestPlan", + "summary": "Pause TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem pauses the test plan and updates test plan status\r\n\r\nSystem returns no content response", + "operationId": "Pause", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -17298,7 +21358,7 @@ "description": "Successful operation" }, "400": { - "description": "Bad Request", + "description": "\r\nExecute status from New to Paused forbidden\r\n\r\nExecute status from Paused to Paused forbidden\r\n\r\nExecute status from Completed to Paused forbidden", "content": { "application/json": { "schema": { @@ -17318,7 +21378,7 @@ } }, "403": { - "description": "Delete permission for test plan required", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -17360,18 +21420,19 @@ } } }, - "/api/v2/testPlans/{id}/analytics": { - "get": { + "/api/v2/testPlans/{id}/complete": { + "post": { "tags": [ "TestPlans" ], - "summary": "Get analytics by TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem returns analytics by test plan", + "summary": "Complete TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem completes the test plan and updates test plan status\r\n\r\nSystem returns no content response", + "operationId": "Complete", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -17381,18 +21442,11 @@ } ], "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestPointAnalyticResult" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "Bad Request", + "description": "\r\nExecute status from New to Completed forbidden\r\n\r\nExecute status from Completed to Completed forbidden", "content": { "application/json": { "schema": { @@ -17412,7 +21466,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -17422,7 +21476,7 @@ } }, "404": { - "description": "Can't find a Project with id", + "description": "Can't find a TestPlan with id!", "content": { "application/json": { "schema": { @@ -17454,18 +21508,19 @@ } } }, - "/api/v2/testPlans/{id}/summaries": { + "/api/v2/testPlans/{id}/testSuites": { "get": { "tags": [ "TestPlans" ], - "summary": "Get summary by TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem returns summary by test plan", + "summary": "Get TestSuites Tree By Id", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem finds test suites related to the test plan\r\n\r\nSystem returns test suites as a tree model (listed in response example)", + "operationId": "GetTestSuitesById", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -17480,7 +21535,10 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestPlanSummaryModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestSuiteHierarchyApiResult" + } } } } @@ -17506,7 +21564,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -17516,7 +21574,7 @@ } }, "404": { - "description": "Can't find a Test Plan with id", + "description": "Can't find a TestRun with id!", "content": { "application/json": { "schema": { @@ -17548,40 +21606,47 @@ } } }, - "/api/v2/testPlans": { + "/api/v2/testPlans/{id}/workItems/withSections": { "post": { "tags": [ "TestPlans" ], - "summary": "Create TestPlan", - "description": "\nUse case\n\nUser sets test plan properties (listed in request example)\n\nUser runs method execution\n\nSystem creates test plan\n\nSystem returns test plan (listed in response example)", - "operationId": "CreateTestPlan", + "summary": "Add WorkItems to TestPlan with Sections as TestSuites", + "description": "\r\nUse case\r\n\r\nUser sets TestPlan identifier\r\n\r\nUser sets WorkItem identifiers (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem added WorkItems and Sections to TestPlan\r\n\r\nSystem returns no content response", + "operationId": "AddWorkItemsWithSections", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], "requestBody": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestPlanApiModel" - } - ] + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } } } }, "responses": { - "201": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestPlanModel" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\nField is required\n\nTags must be no more than 10!", + "description": "\r\nTestPlan is locked\r\n\r\nSome of configurations do not exist in the project, or they are not active", "content": { "application/json": { "schema": { @@ -17601,7 +21666,7 @@ } }, "403": { - "description": "Update permission for test plan required", + "description": "Update permission for TestPlan required", "content": { "application/json": { "schema": { @@ -17611,7 +21676,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nCan't find a TestPlan with id\r\n\r\nSome of workItems do not exist", "content": { "application/json": { "schema": { @@ -17621,7 +21686,7 @@ } }, "409": { - "description": "TestPlan with the same name already exists!", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -17631,7 +21696,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Can't put a SharedSteps in the TestSuite", "content": { "application/json": { "schema": { @@ -17641,23 +21706,39 @@ } } } - }, - "put": { + } + }, + "/api/v2/testPlans/{id}/test-points/withSections": { + "post": { "tags": [ "TestPlans" ], - "summary": "Update TestPlan", - "description": "\nUse case\n\nUser sets test plan properties(listed in request example)\n\nUser runs method execution\n\nSystem updates test plan\n\nSystem returns no content response", - "operationId": "UpdateTestPlan", + "summary": "Add test-points to TestPlan with sections", + "operationId": "AddTestPointsWithSections", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", + "required": true, + "schema": { + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], "requestBody": { + "description": "Filter object to retrieve work items for test-suite's project", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateTestPlanApiModel" + "$ref": "#/components/schemas/WorkItemSelectModel" } - ] + ], + "description": "Model containing options to filter work items" } } } @@ -17667,7 +21748,7 @@ "description": "Successful operation" }, "400": { - "description": "\nField is required\n\nTags must be no more than 10!\n\nStartDate can't be more than EndDate!", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -17687,7 +21768,7 @@ } }, "403": { - "description": "Update permission for test plan required", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -17697,7 +21778,7 @@ } }, "404": { - "description": "Can't find a TestPlan with id!", + "description": "Test suite with provided ID was not found", "content": { "application/json": { "schema": { @@ -17707,7 +21788,7 @@ } }, "409": { - "description": "TestPlan with the same name already exists!", + "description": "Conflict", "content": { "application/json": { "schema": { @@ -17717,7 +21798,7 @@ } }, "422": { - "description": "Can't change ProjectId", + "description": "Shared steps cannot be added to test suite", "content": { "application/json": { "schema": { @@ -17729,30 +21810,47 @@ } } }, - "/api/v2/testPlans/{id}/restore": { + "/api/v2/testPlans/{id}/autobalance": { "post": { "tags": [ "TestPlans" ], - "summary": "Restore TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem restores test plan\n\nSystem returns no content response", - "operationId": "RestoreTestPlan", + "summary": "Distribute test points between the users", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan unique or global ID", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + }, + { + "name": "testers", + "in": "query", + "description": "Specifies a project user IDs to distribute", + "schema": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } } ], "responses": { - "204": { - "description": "Successful operation" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestPlanWithTestSuiteTreeModel" + } + } + } }, "400": { "description": "Bad Request", @@ -17775,7 +21873,7 @@ } }, "403": { - "description": "Update permission for the archive is required", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -17785,7 +21883,7 @@ } }, "404": { - "description": "Can't find a TestPlan with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -17814,21 +21912,21 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/testPlans/{id}/purge": { - "post": { + "/api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDate": { + "get": { "tags": [ "TestPlans" ], - "summary": "Permanently delete test plan from archive", - "operationId": "PurgeTestPlan", + "summary": "Get last modification date of test plan's test results", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the test plan", + "description": "Internal (UUID) or global (integer) identifier", "required": true, "schema": { "type": "string", @@ -17861,7 +21959,7 @@ } }, "403": { - "description": "Full access permission for the archive is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -17903,34 +22001,115 @@ } } }, - "/api/v2/testPlans/{id}/clone": { + "/api/v2/testPlans/{id}/testRuns/search": { "post": { "tags": [ "TestPlans" ], - "summary": "Clone TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem clones test plan\n\nSystem returns test plan (listed in response example)", - "operationId": "Clone", + "summary": "Search TestRuns of TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets TestRuns filter (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem returns TestRuns for TestPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchTestRunsApiModel" + } + ] + } + } + } + }, "responses": { - "201": { + "200": { "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestPlanModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestRunApiResult" + } } } } @@ -17956,7 +22135,7 @@ } }, "403": { - "description": "Update permission for test plan required", + "description": "Read permission for test plan is required", "content": { "application/json": { "schema": { @@ -17966,7 +22145,7 @@ } }, "404": { - "description": "Can't find a TestPlan with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -17998,121 +22177,136 @@ } } }, - "/api/v2/testPlans/{id}/start": { - "post": { + "/api/v2/testPlans/{id}/testRuns": { + "get": { "tags": [ "TestPlans" ], - "summary": "Start TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem starts the test plan and updates test plan status\n\nSystem returns no content response", - "operationId": "Start", + "summary": "Get TestRuns of TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets TestRun status filter (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem returns TestRuns for TestPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - ], - "responses": { - "204": { - "description": "Successful operation" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } + { + "name": "notStarted", + "in": "query", + "schema": { + "type": "boolean" } }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "inProgress", + "in": "query", + "schema": { + "type": "boolean" } }, - "403": { - "description": "Update permission for test plan required", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "stopped", + "in": "query", + "schema": { + "type": "boolean" } }, - "404": { - "description": "Can't find a TestPlan with id!", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "completed", + "in": "query", + "schema": { + "type": "boolean" } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" } } - } - }, - "422": { - "description": "Unprocessable Entity", + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestRunApiResult" + } } } } - } - } - } - }, - "/api/v2/testPlans/{id}/pause": { - "post": { - "tags": [ - "TestPlans" - ], - "summary": "Pause TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem pauses the test plan and updates test plan status\n\nSystem returns no content response", - "operationId": "Pause", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - ], - "responses": { - "204": { - "description": "Successful operation" }, "400": { - "description": "\nExecute status from New to Paused forbidden\n\nExecute status from Paused to Paused forbidden\n\nExecute status from Completed to Paused forbidden", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -18132,7 +22326,7 @@ } }, "403": { - "description": "Update permission for test plan required", + "description": "Read permission for test plan is required", "content": { "application/json": { "schema": { @@ -18142,7 +22336,7 @@ } }, "404": { - "description": "Can't find a TestPlan with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -18174,113 +22368,47 @@ } } }, - "/api/v2/testPlans/{id}/complete": { - "post": { + "/api/v2/testPlans/{id}/links": { + "get": { "tags": [ "TestPlans" ], - "summary": "Complete TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem completes the test plan and updates test plan status\n\nSystem returns no content response", - "operationId": "Complete", + "summary": "Get Links of TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets pagination filter (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem returns links of TestPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - ], - "responses": { - "204": { - "description": "Successful operation" - }, - "400": { - "description": "\nExecute status from New to Completed forbidden\n\nExecute status from Completed to Completed forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Update permission for test plan required", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } }, - "404": { - "description": "Can't find a TestPlan with id!", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "skip", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "take", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" } }, - "422": { - "description": "Unprocessable Entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } - }, - "/api/v2/testPlans/{id}/testSuites": { - "get": { - "tags": [ - "TestPlans" - ], - "summary": "Get TestSuites Tree By Id", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem finds test suites related to the test plan\n\nSystem returns test suites as a tree model (listed in response example)", - "operationId": "GetTestSuitesById", - "parameters": [ { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, + "name": "orderBy", + "in": "query", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "type": "string" + } } ], "responses": { @@ -18291,7 +22419,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestSuiteHierarchyApiResult" + "$ref": "#/components/schemas/TestPlanLink" } } } @@ -18318,7 +22446,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for test plan is required", "content": { "application/json": { "schema": { @@ -18328,7 +22456,7 @@ } }, "404": { - "description": "Can't find a TestRun with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -18360,19 +22488,18 @@ } } }, - "/api/v2/testPlans/{id}/workItems/withSections": { + "/api/v2/testPlans/{id}/testPoints/reset": { "post": { "tags": [ "TestPlans" ], - "summary": "Add WorkItems to TestPlan with Sections as TestSuites", - "description": "\nUse case\n\nUser sets TestPlan identifier\n\nUser sets WorkItem identifiers (listed in request example)\n\nUser runs method execution\n\nSystem added WorkItems and Sections to TestPlan\n\nSystem returns no content response", - "operationId": "AddWorkItemsWithSections", + "summary": "Reset TestPoints status of TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets test points identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem reset test points statuses of test plan", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -18396,11 +22523,11 @@ } }, "responses": { - "204": { + "200": { "description": "Successful operation" }, "400": { - "description": "\nTestPlan is locked\n\nSome of configurations do not exist in the project, or they are not active", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -18420,7 +22547,7 @@ } }, "403": { - "description": "Update permission for TestPlan required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -18430,7 +22557,7 @@ } }, "404": { - "description": "\nCan't find a TestPlan with id\n\nSome of workItems do not exist", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -18450,7 +22577,7 @@ } }, "422": { - "description": "Can't put a SharedSteps in the TestSuite", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -18462,44 +22589,49 @@ } } }, - "/api/v2/testPlans/{id}/test-points/withSections": { + "/api/v2/testPlans/shorts": { "post": { "tags": [ "TestPlans" ], - "summary": "Add test-points to TestPlan with sections", - "operationId": "AddTestPointsWithSections", + "summary": "Get TestPlans short models by Project identifiers", + "description": "\r\nUse case\r\n\r\nUser sets projects identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem return test plans short models (listed in response example)", "parameters": [ { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, + "name": "isDeleted", + "in": "query", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "type": "boolean" + } } ], "requestBody": { - "description": "Filter object to retrieve work items for test-suite's project", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkItemSelectModel" - } - ], - "description": "Model containing options to filter work items" + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } } } }, "responses": { - "204": { - "description": "Successful operation" + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPlanShortModel" + } + } + } + } }, "400": { "description": "Bad Request", @@ -18522,7 +22654,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Read permission for project required", "content": { "application/json": { "schema": { @@ -18532,7 +22664,7 @@ } }, "404": { - "description": "Test suite with provided ID was not found", + "description": "Project not found", "content": { "application/json": { "schema": { @@ -18552,7 +22684,7 @@ } }, "422": { - "description": "Shared steps cannot be added to test suite", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -18564,47 +22696,50 @@ } } }, - "/api/v2/testPlans/{id}/autobalance": { + "/api/v2/testPlans/{id}/export/testPoints/xlsx": { "post": { "tags": [ "TestPlans" ], - "summary": "Distribute test points between the users", + "summary": "Export TestPoints from TestPlan in xls format", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets filter model (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem return export xlsx file", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan unique or global ID", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" - } + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { - "name": "testers", - "in": "query", - "description": "Specifies a project user IDs to distribute", + "name": "time-Zone-Offset-In-Minutes", + "in": "header", "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "type": "integer", + "format": "int64" } } ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestPlanWithTestSuiteTreeModel" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetXlsxTestPointsByTestPlanApiModel" + } + ] } } + } + }, + "responses": { + "200": { + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -18627,7 +22762,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -18637,7 +22772,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -18666,31 +22801,61 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDate": { - "get": { + "/api/v2/testPlans/{id}/export/testResultHistory/xlsx": { + "post": { "tags": [ "TestPlans" ], - "summary": "Get last modification date of test plan's test results", + "summary": "Export TestResults history from TestPlan in xls format", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets filter model (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem return export xlsx file", "parameters": [ { "name": "id", "in": "path", - "description": "Internal (UUID) or global (integer) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "mustReturnOnlyLastTestResult", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "includeSteps", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "includeDeletedTestSuites", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "time-Zone-Offset-In-Minutes", + "in": "header", + "schema": { + "type": "integer", + "format": "int64" } } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -18713,7 +22878,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -18723,7 +22888,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -18755,18 +22920,18 @@ } } }, - "/api/v2/testPlans/{id}/testRuns/search": { - "post": { + "/api/v2/testPlans/{id}/testPoints/lastResults": { + "get": { "tags": [ "TestPlans" ], - "summary": "Search TestRuns of TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets TestRuns filter (listed in request example)\n\nUser runs method execution\n\nSystem returns TestRuns for TestPlan", + "summary": "Get TestPoints with last result from TestPlan", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser sets filter (listed in request example)\r\n\r\nUser runs method execution\r\n\r\nSystem return test points with last result from test plan", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", @@ -18774,6 +22939,14 @@ }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, + { + "name": "testerId", + "in": "query", + "schema": { + "type": "string", + "format": "uuid" + } + }, { "name": "Skip", "in": "query", @@ -18815,19 +22988,6 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SearchTestRunsApiModel" - } - ] - } - } - } - }, "responses": { "200": { "description": "Successful operation", @@ -18862,7 +23022,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestRunApiResult" + "$ref": "#/components/schemas/TestPointWithLastResultResponseModel" } } } @@ -18889,7 +23049,7 @@ } }, "403": { - "description": "Read permission for test plan is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -18899,7 +23059,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -18928,136 +23088,33 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/testPlans/{id}/testRuns": { - "get": { + "/api/v2/testPlans/{id}/unlock/request": { + "post": { "tags": [ "TestPlans" ], - "summary": "Get TestRuns of TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets TestRun status filter (listed in request example)\n\nUser runs method execution\n\nSystem returns TestRuns for TestPlan", + "summary": "Send unlock TestPlan notification", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem send unlock test plan notification", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "notStarted", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "inProgress", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "stopped", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "completed", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } } ], "responses": { "200": { - "description": "Successful operation", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestRunApiResult" - } - } - } - } + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -19080,7 +23137,7 @@ } }, "403": { - "description": "Read permission for test plan is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -19090,7 +23147,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -19122,47 +23179,24 @@ } } }, - "/api/v2/testPlans/{id}/links": { + "/api/v2/testPlans/{id}/configurations": { "get": { "tags": [ "TestPlans" ], - "summary": "Get Links of TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets pagination filter (listed in request example)\n\nUser runs method execution\n\nSystem returns links of TestPlan", + "summary": "Get TestPlan configurations", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return test plan configurations", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "skip", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "take", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "orderBy", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -19173,7 +23207,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanLink" + "$ref": "#/components/schemas/ConfigurationModel" } } } @@ -19200,7 +23234,7 @@ } }, "403": { - "description": "Read permission for test plan is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -19210,7 +23244,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -19242,43 +23276,105 @@ } } }, - "/api/v2/testPlans/{id}/testPoints/reset": { - "post": { + "/api/v2/testPlans/{id}/history": { + "get": { "tags": [ "TestPlans" ], - "summary": "Reset TestPoints status of TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets test points identifiers\n\nUser runs method execution\n\nSystem reset test points statuses of test plan", + "summary": "Get TestPlan history", + "description": "\r\nUse case\r\n\r\nUser sets test plan identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return test plan history", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test plan internal (guid format) or global (int\r\nformat) identifier", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" + "responses": { + "200": { + "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPlanChangeModel" + } } } } - } - }, - "responses": { - "200": { - "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -19301,7 +23397,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -19311,7 +23407,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestPlan not found", "content": { "application/json": { "schema": { @@ -19343,19 +23439,31 @@ } } }, - "/api/v2/testPlans/shorts": { + "/api/v2/testPlans/{id}/testPoints/tester/{userId}": { "post": { "tags": [ "TestPlans" ], - "summary": "Get TestPlans short models by Project identifiers", - "description": "\nUse case\n\nUser sets projects identifiers\n\nUser runs method execution\n\nSystem return test plans short models (listed in response example)", + "summary": "Assign user as a tester to multiple test points", "parameters": [ { - "name": "isDeleted", - "in": "query", + "name": "id", + "in": "path", + "description": "Unique or global ID of the test plan", + "required": true, "schema": { - "type": "boolean" + "type": "string", + "description": "Internal (UUID) or global (integer) identifier" + } + }, + { + "name": "userId", + "in": "path", + "description": "Unique ID of the user", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], @@ -19363,25 +23471,25 @@ "content": { "application/json": { "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "allOf": [ + { + "$ref": "#/components/schemas/TestPointSelectModel" + } + ] } } } }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanShortModel" + "type": "string", + "format": "uuid" } } } @@ -19408,7 +23516,7 @@ } }, "403": { - "description": "Read permission for project required", + "description": "Update permission for test plans is required", "content": { "application/json": { "schema": { @@ -19418,7 +23526,7 @@ } }, "404": { - "description": "Project not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -19450,31 +23558,21 @@ } } }, - "/api/v2/testPlans/{id}/export/testPoints/xlsx": { - "post": { + "/api/v2/testPlans/{id}/testPoints/tester": { + "delete": { "tags": [ "TestPlans" ], - "summary": "Export TestPoints from TestPlan in xls format", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets filter model (listed in request example)\n\nUser runs method execution\n\nSystem return export xlsx file", + "summary": "Unassign users from multiple test points", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Unique or global ID of the test plan", "required": true, "schema": { "type": "string", "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "time-Zone-Offset-In-Minutes", - "in": "header", - "schema": { - "type": "integer", - "format": "int64" } } ], @@ -19484,7 +23582,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetXlsxTestPointsByTestPlanApiModel" + "$ref": "#/components/schemas/TestPointSelectModel" } ] } @@ -19493,7 +23591,18 @@ }, "responses": { "200": { - "description": "Successful operation" + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } }, "400": { "description": "Bad Request", @@ -19516,7 +23625,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Update permission for test plans is required", "content": { "application/json": { "schema": { @@ -19526,7 +23635,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -19558,58 +23667,106 @@ } } }, - "/api/v2/testPlans/{id}/export/testResultHistory/xlsx": { + "/api/v2/testPoints/search": { "post": { "tags": [ - "TestPlans" + "TestPoints" ], - "summary": "Export TestResults history from TestPlan in xls format", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets filter model (listed in request example)\n\nUser runs method execution\n\nSystem return export xlsx file", + "summary": "Search for test points", "parameters": [ { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "type": "integer" + } }, { - "name": "mustReturnOnlyLastTestResult", + "name": "Take", "in": "query", + "description": "Amount of items to be taken (limit)", "schema": { - "type": "boolean" + "type": "integer" } }, { - "name": "includeSteps", + "name": "OrderBy", "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", "schema": { - "type": "boolean" + "type": "string" } }, { - "name": "includeDeletedTestSuites", + "name": "SearchField", "in": "query", + "description": "Property name for searching", "schema": { - "type": "boolean" + "type": "string" } }, { - "name": "time-Zone-Offset-In-Minutes", - "in": "header", + "name": "SearchValue", + "in": "query", + "description": "Value for searching", "schema": { - "type": "integer", - "format": "int64" + "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPointFilterRequestModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Successful operation" + "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPointShortResponseModel" + } + } + } + } }, "400": { "description": "Bad Request", @@ -19632,7 +23789,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for all requested test plans is required", "content": { "application/json": { "schema": { @@ -19642,7 +23799,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -19674,33 +23831,13 @@ } } }, - "/api/v2/testPlans/{id}/testPoints/lastResults": { - "get": { + "/api/v2/testPoints/search/id": { + "post": { "tags": [ - "TestPlans" + "TestPoints" ], - "summary": "Get TestPoints with last result from TestPlan", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser sets filter (listed in request example)\n\nUser runs method execution\n\nSystem return test points with last result from test plan", + "summary": "Search for test points and extract IDs only", "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "testerId", - "in": "query", - "schema": { - "type": "string", - "format": "uuid" - } - }, { "name": "Skip", "in": "query", @@ -19742,9 +23879,22 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestPointFilterRequestModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", "headers": { "Pagination-Skip": { "description": "Skipped amount of items", @@ -19776,7 +23926,8 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPointWithLastResultResponseModel" + "type": "string", + "format": "uuid" } } } @@ -19803,7 +23954,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for all requested test plans is required", "content": { "application/json": { "schema": { @@ -19813,7 +23964,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -19842,33 +23993,40 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/testPlans/{id}/unlock/request": { - "post": { + "/api/v2/testPoints/{id}/testRuns": { + "get": { "tags": [ - "TestPlans" + "TestPoints" ], - "summary": "Send unlock TestPlan notification", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem send unlock test plan notification", + "summary": "Get all test runs which use test point", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test point unique ID", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "format": "uuid" + } } ], "responses": { "200": { - "description": "Successful operation" + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestRunApiResult" + } + } + } + } }, "400": { "description": "Bad Request", @@ -19891,7 +24049,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for test points is required", "content": { "application/json": { "schema": { @@ -19901,7 +24059,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -19933,36 +24091,31 @@ } } }, - "/api/v2/testPlans/{id}/configurations": { + "/api/v2/testPoints/{id}/workItem": { "get": { "tags": [ - "TestPlans" + "TestPoints" ], - "summary": "Get TestPlan configurations", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem return test plan configurations", + "summary": "Get work item represented by test point", "parameters": [ { "name": "id", "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", + "description": "Test point unique ID", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "format": "uuid" + } } ], "responses": { "200": { - "description": "Successful operation", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConfigurationModel" - } + "$ref": "#/components/schemas/WorkItemModel" } } } @@ -19988,7 +24141,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for test points is required", "content": { "application/json": { "schema": { @@ -19998,7 +24151,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -20030,25 +24183,13 @@ } } }, - "/api/v2/testPlans/{id}/history": { - "get": { + "/api/v2/testResults/search": { + "post": { "tags": [ - "TestPlans" + "TestResults" ], - "summary": "Get TestPlan history", - "description": "\nUse case\n\nUser sets test plan identifier\n\nUser runs method execution\n\nSystem return test plan history", + "summary": "Search for test results", "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test plan internal (guid format) or global (int\nformat) identifier", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, { "name": "Skip", "in": "query", @@ -20090,9 +24231,22 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestResultsFilterApiModel" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", "headers": { "Pagination-Skip": { "description": "Skipped amount of items", @@ -20124,7 +24278,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPlanChangeModel" + "$ref": "#/components/schemas/TestResultShortResponse" } } } @@ -20151,7 +24305,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Read permission for all requested test runs is required", "content": { "application/json": { "schema": { @@ -20161,7 +24315,7 @@ } }, "404": { - "description": "TestPlan not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -20193,41 +24347,19 @@ } } }, - "/api/v2/testPlans/{id}/testPoints/tester/{userId}": { + "/api/v2/testResults/statistics/filter": { "post": { "tags": [ - "TestPlans" - ], - "summary": "Assign user as a tester to multiple test points", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique or global ID of the test plan", - "required": true, - "schema": { - "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } - }, - { - "name": "userId", - "in": "path", - "description": "Unique ID of the user", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestResults" ], + "summary": "Search for test results and extract statistics", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestPointSelectModel" + "$ref": "#/components/schemas/TestResultsFilterApiModel" } ] } @@ -20240,11 +24372,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "$ref": "#/components/schemas/TestResultsStatisticsApiResult" } } } @@ -20270,7 +24398,7 @@ } }, "403": { - "description": "Update permission for test plans is required", + "description": "Read permission for all requested test runs is required", "content": { "application/json": { "schema": { @@ -20312,37 +24440,27 @@ } } }, - "/api/v2/testPlans/{id}/testPoints/tester": { - "delete": { + "/api/v2/testResults/{id}/attachments": { + "get": { "tags": [ - "TestPlans" + "TestResults" ], - "summary": "Unassign users from multiple test points", + "summary": "Get all attachments of TestResult", + "description": "\r\nUse case\r\n\r\nUser sets testResultId\r\n\r\nUser runs method execution\r\n\r\nSystem search all attachments of the test result\r\n\r\nSystem returns attachments enumeration", + "operationId": "GetAttachments", "parameters": [ { "name": "id", "in": "path", - "description": "Unique or global ID of the test plan", + "description": "Test result internal identifier (guid format)", "required": true, "schema": { "type": "string", - "description": "Internal (UUID) or global (integer) identifier" - } + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestPointSelectModel" - } - ] - } - } - } - }, "responses": { "200": { "description": "OK", @@ -20351,8 +24469,7 @@ "schema": { "type": "array", "items": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/AttachmentApiResult" } } } @@ -20379,7 +24496,7 @@ } }, "403": { - "description": "Update permission for test plans is required", + "description": "Read permission for test result required", "content": { "application/json": { "schema": { @@ -20389,7 +24506,7 @@ } }, "404": { - "description": "Not Found", + "description": "TestResult not found", "content": { "application/json": { "schema": { @@ -20419,105 +24536,50 @@ } } } - } - }, - "/api/v2/testPoints/search": { + }, "post": { "tags": [ - "TestPoints" + "TestResults" ], - "summary": "Search for test points", + "summary": "Upload and link attachment to TestResult", + "description": "\r\nUse case\r\n\r\nUser sets testResultId\r\n\r\nUser attaches a file\r\n\r\nSystem creates attachment and links it to the test result\r\n\r\nSystem returns attachment identifier", + "operationId": "CreateAttachment", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "id", + "in": "path", + "description": "Test result internal identifier (guid format)", + "required": true, "schema": { - "type": "string" - } + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "content": { - "application/json": { + "multipart/form-data": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestPointFilterRequestModel" + "type": "object", + "properties": { + "file": { + "type": "string", + "description": "Select file", + "format": "binary" } - ] + } } } } }, "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, + "413": { + "description": "Multipart body length limit exceeded (default constraint is one gigabyte)", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestPointShortResponseModel" - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -20543,7 +24605,7 @@ } }, "403": { - "description": "Read permission for all requested test plans is required", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -20553,7 +24615,7 @@ } }, "404": { - "description": "Not Found", + "description": "", "content": { "application/json": { "schema": { @@ -20581,111 +24643,101 @@ } } } + }, + "200": { + "description": "Successful operation" } } } }, - "/api/v2/testPoints/search/id": { - "post": { + "/api/v2/testResults/{id}/attachments/{attachmentId}": { + "get": { "tags": [ - "TestPoints" + "TestResults" ], - "summary": "Search for test points and extract IDs only", + "summary": "Get attachment of TestResult", + "description": "\r\nUse case\r\n\r\nUser sets attachmentId and testResultId\r\n\r\n[Optional] User sets resize configuration\r\n\r\nUser runs method execution\r\n\r\nSystem search attachments by the attachmentId and the testResultId\r\n\r\n[Optional] If resize configuration is set, System resizes the attachment according to the resize\r\n configuration\r\n\r\n[Optional] Otherwise, System does not resize the attachment\r\n\r\nSystem returns attachment as a file", + "operationId": "DownloadAttachment", "parameters": [ { - "name": "Skip", + "name": "attachmentId", + "in": "path", + "description": "Attachment internal identifier (guid format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "id", + "in": "path", + "description": "Test result internal identifier (guid format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "width", "in": "query", - "description": "Amount of items to be skipped (offset)", + "description": "Width of the result image", "schema": { - "type": "integer" + "maximum": 2147483647, + "minimum": 1, + "type": "integer", + "format": "int32" } }, { - "name": "Take", + "name": "height", "in": "query", - "description": "Amount of items to be taken (limit)", + "description": "Height of the result image", "schema": { - "type": "integer" + "maximum": 2147483647, + "minimum": 1, + "type": "integer", + "format": "int32" } }, { - "name": "OrderBy", + "name": "resizeType", "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "description": "Type of resizing to apply to the result image", "schema": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/ImageResizeType" + } + ] } }, { - "name": "SearchField", + "name": "backgroundColor", "in": "query", - "description": "Property name for searching", + "description": "Color of the background if the `resizeType` is `AddBackgroundStripes`", "schema": { + "maxLength": 7, + "minLength": 7, + "pattern": "#[0-9A-Fa-f]{6}", "type": "string" } }, { - "name": "SearchValue", + "name": "preview", "in": "query", - "description": "Value for searching", + "description": "If image must be converted to a preview (lower quality, no animation)", "schema": { - "type": "string" + "type": "boolean" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestPointFilterRequestModel" - } - ] - } - } - } - }, "responses": { "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -20708,7 +24760,7 @@ } }, "403": { - "description": "Read permission for all requested test plans is required", + "description": "Read permission for test result required", "content": { "application/json": { "schema": { @@ -20718,7 +24770,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nFile not found\r\n\r\nAttachment not found", "content": { "application/json": { "schema": { @@ -20748,39 +24800,41 @@ } } } - } - }, - "/api/v2/testPoints/{id}/testRuns": { - "get": { + }, + "delete": { "tags": [ - "TestPoints" + "TestResults" ], - "summary": "Get all test runs which use test point", + "summary": "Remove attachment and unlink from TestResult", + "description": "\r\nUse case\r\n\r\nUser sets testResultId and attachmentId\r\n\r\nUser attaches a file\r\n\r\nUser runs method execution\r\n\r\nSystem deletes attachment and unlinks it from the test result\r\n\r\nSystem returns attachment identifier", + "operationId": "DeleteAttachment", "parameters": [ { "name": "id", "in": "path", - "description": "Test point unique ID", + "description": "Test result internal identifier (guid format)", "required": true, "schema": { "type": "string", "format": "uuid" - } + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment internal identifier (guid format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestRunApiResult" - } - } - } - } + "204": { + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -20803,7 +24857,7 @@ } }, "403": { - "description": "Read permission for test points is required", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -20843,19 +24897,27 @@ } } } - } - }, - "/api/v2/testPoints/{id}/workItem": { - "get": { + }, + "put": { "tags": [ - "TestPoints" + "TestResults" ], - "summary": "Get work item represented by test point", + "summary": "Attach file to the test result", "parameters": [ { "name": "id", "in": "path", - "description": "Test point unique ID", + "description": "Test result unique ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment unique ID", "required": true, "schema": { "type": "string", @@ -20865,14 +24927,7 @@ ], "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkItemModel" - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -20895,7 +24950,7 @@ } }, "403": { - "description": "Read permission for test points is required", + "description": "Only edits from assigned user are allowed", "content": { "application/json": { "schema": { @@ -20937,103 +24992,45 @@ } } }, - "/api/v2/testResults/search": { - "post": { + "/api/v2/testResults/{id}/attachments/{attachmentId}/info": { + "get": { "tags": [ "TestResults" ], - "summary": "Search for test results", + "summary": "Get Metadata of TestResult's attachment", + "description": "\r\nUse case\r\n\r\nUser sets attachmentId and testResultId\r\n\r\nUser runs method execution\r\n\r\nSystem search attachment by the attachmentId and the testResultId\r\n\r\nSystem returns attachment data", + "operationId": "GetAttachment", "parameters": [ { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", + "name": "id", + "in": "path", + "description": "Test result internal identifier (guid format)", + "required": true, "schema": { - "type": "string" - } + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "attachmentId", + "in": "path", + "description": "Attachment internal identifier (guid format)", + "required": true, "schema": { - "type": "string" - } + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestResultsFilterApiModel" - } - ] - } - } - } - }, "responses": { "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, + "description": "Successful operation", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestResultShortResponse" - } + "$ref": "#/components/schemas/AttachmentApiResult" } } } @@ -21059,7 +25056,7 @@ } }, "403": { - "description": "Read permission for all requested test runs is required", + "description": "Read permission for test result required", "content": { "application/json": { "schema": { @@ -21069,7 +25066,7 @@ } }, "404": { - "description": "Not Found", + "description": "File not found", "content": { "application/json": { "schema": { @@ -21101,32 +25098,34 @@ } } }, - "/api/v2/testResults/statistics/filter": { - "post": { + "/api/v2/testResults/{id}/attachments/info": { + "get": { "tags": [ "TestResults" ], - "summary": "Search for test results and extract statistics", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestResultsFilterApiModel" - } - ] - } + "summary": "Get test result attachments meta-information", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test result unique ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestResultsStatisticsApiResult" + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachmentApiResult" + } } } } @@ -21152,7 +25151,7 @@ } }, "403": { - "description": "Read permission for all requested test runs is required", + "description": "Read permission for the test result is required", "content": { "application/json": { "schema": { @@ -21194,25 +25193,22 @@ } } }, - "/api/v2/testResults/{id}/attachments": { + "/api/v2/testResults/{id}": { "get": { "tags": [ "TestResults" ], - "summary": "Get all attachments of TestResult", - "description": "\nUse case\n\nUser sets testResultId\n\nUser runs method execution\n\nSystem search all attachments of the test result\n\nSystem returns attachments enumeration", - "operationId": "GetAttachments", + "summary": "Get test result by ID", "parameters": [ { "name": "id", "in": "path", - "description": "Test result internal identifier (guid format)", + "description": "Test result unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "responses": { @@ -21221,10 +25217,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentApiResult" - } + "$ref": "#/components/schemas/TestResultResponse" } } } @@ -21250,7 +25243,7 @@ } }, "403": { - "description": "Read permission for test result required", + "description": "Read permission for the test result is required", "content": { "application/json": { "schema": { @@ -21260,7 +25253,7 @@ } }, "404": { - "description": "TestResult not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -21291,52 +25284,39 @@ } } }, - "post": { + "put": { "tags": [ "TestResults" ], - "summary": "Upload and link attachment to TestResult", - "description": "\nUse case\n\nUser sets testResultId\n\nUser attaches a file\n\nSystem creates attachment and links it to the test result\n\nSystem returns attachment identifier", - "operationId": "CreateAttachment", + "summary": "Edit test result by ID", "parameters": [ { "name": "id", "in": "path", - "description": "Test result internal identifier (guid format)", + "description": "Test result unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "description": "Select file", - "format": "binary" + "allOf": [ + { + "$ref": "#/components/schemas/TestResultUpdateV2Request" } - } + ] } } } }, "responses": { - "413": { - "description": "Multipart body length limit exceeded (default constraint is one gigabyte)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } + "200": { + "description": "OK" }, "400": { "description": "Bad Request", @@ -21359,7 +25339,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Only edits from assigned user are allowed", "content": { "application/json": { "schema": { @@ -21369,7 +25349,7 @@ } }, "404": { - "description": "", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -21397,101 +25377,42 @@ } } } - }, - "200": { - "description": "Successful operation" } } - } - }, - "/api/v2/testResults/{id}/attachments/{attachmentId}": { - "get": { + }, + "patch": { "tags": [ "TestResults" ], - "summary": "Get attachment of TestResult", - "description": "\nUse case\n\nUser sets attachmentId and testResultId\n\n[Optional] User sets resize configuration\n\nUser runs method execution\n\nSystem search attachments by the attachmentId and the testResultId\n\n[Optional] If resize configuration is set, System resizes the attachment according to the resize\n configuration\n\n[Optional] Otherwise, System does not resize the attachment\n\nSystem returns attachment as a file", - "operationId": "DownloadAttachment", + "summary": "Patch test result by ID", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", "parameters": [ - { - "name": "attachmentId", - "in": "path", - "description": "Attachment internal identifier (guid format)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, { "name": "id", "in": "path", - "description": "Test result internal identifier (guid format)", + "description": "Test result unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "width", - "in": "query", - "description": "Width of the result image", - "schema": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer", - "format": "int32" - } - }, - { - "name": "height", - "in": "query", - "description": "Height of the result image", - "schema": { - "maximum": 2147483647, - "minimum": 1, - "type": "integer", - "format": "int32" } - }, - { - "name": "resizeType", - "in": "query", - "description": "Type of resizing to apply to the result image", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ImageResizeType" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" } - ] - } - }, - { - "name": "backgroundColor", - "in": "query", - "description": "Color of the background if the `resizeType` is `AddBackgroundStripes`", - "schema": { - "maxLength": 7, - "minLength": 7, - "pattern": "#[0-9A-Fa-f]{6}", - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If image must be converted to a preview (lower quality, no animation)", - "schema": { - "type": "boolean" + } } } - ], + }, "responses": { - "200": { - "description": "OK" + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -21514,7 +25435,7 @@ } }, "403": { - "description": "Read permission for test result required", + "description": "Only edits from assigned user are allowed", "content": { "application/json": { "schema": { @@ -21524,7 +25445,7 @@ } }, "404": { - "description": "\nFile not found\n\nAttachment not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -21554,41 +25475,47 @@ } } } - }, - "delete": { + } + }, + "/api/v2/testResults/external-projects/{externalProjectId}/defects/external-forms": { + "post": { "tags": [ "TestResults" ], - "summary": "Remove attachment and unlink from TestResult", - "description": "\nUse case\n\nUser sets testResultId and attachmentId\n\nUser attaches a file\n\nUser runs method execution\n\nSystem deletes attachment and unlinks it from the test result\n\nSystem returns attachment identifier", - "operationId": "DeleteAttachment", "parameters": [ { - "name": "id", - "in": "path", - "description": "Test result internal identifier (guid format)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "attachmentId", + "name": "externalProjectId", "in": "path", - "description": "Attachment internal identifier (guid format)", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestResultsSelectApiModel" + } + ] + } + } + } + }, "responses": { - "204": { - "description": "Successful operation" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetExternalFormApiResult" + } + } + } }, "400": { "description": "Bad Request", @@ -21611,7 +25538,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -21650,28 +25577,19 @@ } } } - } - }, - "put": { + }, + "deprecated": true + } + }, + "/api/v2/testResults/external-projects/{externalProjectId}/defects": { + "post": { "tags": [ "TestResults" ], - "summary": "Attach file to the test result", "parameters": [ { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attachmentId", + "name": "externalProjectId", "in": "path", - "description": "Attachment unique ID", "required": true, "schema": { "type": "string", @@ -21679,9 +25597,29 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateDefectApiModel" + } + ] + } + } + } + }, "responses": { - "200": { - "description": "OK" + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefectApiModel" + } + } + } }, "400": { "description": "Bad Request", @@ -21704,7 +25642,7 @@ } }, "403": { - "description": "Only edits from assigned user are allowed", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -21743,48 +25681,35 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/testResults/{id}/attachments/{attachmentId}/info": { + "/api/v2/testResults/{id}/aggregated": { "get": { "tags": [ "TestResults" ], - "summary": "Get Metadata of TestResult's attachment", - "description": "\nUse case\n\nUser sets attachmentId and testResultId\n\nUser runs method execution\n\nSystem search attachment by the attachmentId and the testResultId\n\nSystem returns attachment data", - "operationId": "GetAttachment", + "summary": "Get test result by ID aggregated with previous results", "parameters": [ { "name": "id", "in": "path", - "description": "Test result internal identifier (guid format)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "attachmentId", - "in": "path", - "description": "Attachment internal identifier (guid format)", + "description": "Test result unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "responses": { "200": { - "description": "Successful operation", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AttachmentApiResult" + "$ref": "#/components/schemas/TestResultResponse" } } } @@ -21810,7 +25735,7 @@ } }, "403": { - "description": "Read permission for test result required", + "description": "Read permission for the test result is required", "content": { "application/json": { "schema": { @@ -21820,7 +25745,7 @@ } }, "404": { - "description": "File not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -21849,15 +25774,16 @@ } } } - } + }, + "deprecated": true } }, - "/api/v2/testResults/{id}/attachments/info": { + "/api/v2/testResults/{id}/reruns": { "get": { "tags": [ "TestResults" ], - "summary": "Get test result attachments meta-information", + "summary": "Get reruns", "parameters": [ { "name": "id", @@ -21876,10 +25802,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachmentApiResult" - } + "$ref": "#/components/schemas/RerunsApiResult" } } } @@ -21905,7 +25828,7 @@ } }, "403": { - "description": "Read permission for the test result is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -21947,31 +25870,103 @@ } } }, - "/api/v2/testResults/{id}": { - "get": { + "/api/v2/testRuns/search": { + "post": { "tags": [ - "TestResults" + "TestRuns" ], - "summary": "Get test result by ID", + "summary": "Search for test runs", "parameters": [ { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", "schema": { - "type": "string", - "format": "uuid" + "type": "integer" + } + }, + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" + } + }, + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" + } + }, + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" + } + }, + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestRunFilterApiModel" + } + ] + } + } + } + }, "responses": { "200": { "description": "OK", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestResultResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestRunShortApiResult" + } } } } @@ -21997,7 +25992,7 @@ } }, "403": { - "description": "Read permission for the test result is required", + "description": "Read permission for autotests library is required", "content": { "application/json": { "schema": { @@ -22037,31 +26032,23 @@ } } } - }, - "put": { + } + }, + "/api/v2/testRuns": { + "post": { "tags": [ - "TestResults" - ], - "summary": "Edit test result by ID", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestRuns" ], + "summary": "Create empty TestRun", + "description": "\r\nUse case\r\n\r\nUser sets test run model (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem creates test run\r\n\r\nSystem returns test run model", + "operationId": "CreateEmpty", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestResultUpdateV2Request" + "$ref": "#/components/schemas/CreateEmptyTestRunApiModel" } ] } @@ -22069,11 +26056,18 @@ } }, "responses": { - "200": { - "description": "OK" + "201": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestRunV2ApiResult" + } + } + } }, "400": { - "description": "Bad Request", + "description": "\r\nField is required\r\n\r\nTestRun must be automated\r\n\r\nProjectId is not a valid!", "content": { "application/json": { "schema": { @@ -22083,7 +26077,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "TestRunTesterRequirement permission required", "content": { "application/json": { "schema": { @@ -22093,7 +26087,7 @@ } }, "403": { - "description": "Only edits from assigned user are allowed", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -22103,7 +26097,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a TestRun with id = testRunId", "content": { "application/json": { "schema": { @@ -22134,42 +26128,32 @@ } } }, - "patch": { + "put": { "tags": [ - "TestResults" - ], - "summary": "Patch test result by ID", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestRuns" ], + "summary": "Update empty TestRun", + "description": "\r\nUse case\r\n\r\nUser sets test run properties (listed in the request example)\r\n\r\nUser runs method execution\r\n\r\nSystem updates test run\r\n\r\nSystem returns returns no content response", + "operationId": "UpdateEmpty", "requestBody": { "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" - } + "allOf": [ + { + "$ref": "#/components/schemas/UpdateEmptyTestRunApiModel" + } + ] } } } }, "responses": { "204": { - "description": "No Content" + "description": "Successful operation" }, "400": { - "description": "Bad Request", + "description": "\r\nField is required\r\n\r\nName is not valid", "content": { "application/json": { "schema": { @@ -22189,7 +26173,7 @@ } }, "403": { - "description": "Only edits from assigned user are allowed", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -22199,7 +26183,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nCan't find a TestRun with id!", "content": { "application/json": { "schema": { @@ -22229,33 +26213,23 @@ } } } - } - }, - "/api/v2/testResults/external-projects/{externalProjectId}/defects/external-forms": { - "post": { + }, + "delete": { "tags": [ - "TestResults" - ], - "parameters": [ - { - "name": "externalProjectId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestRuns" ], + "summary": "Delete multiple test runs", + "description": "\r\nUse case\r\n\r\nUser sets selection parameters of test runs\r\n\r\nSystem search and delete collection of test runs\r\n\r\nSystem returns the number of deleted test runs", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestResultsSelectApiModel" + "$ref": "#/components/schemas/TestRunSelectApiModel" } - ] + ], + "description": "Model containing options to filter test runs" } } } @@ -22266,13 +26240,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetExternalFormApiResult" + "type": "integer", + "format": "int32" } } } }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is not valid\r\n\r\n- Project was archived and cannot be edited anymore", "content": { "application/json": { "schema": { @@ -22331,33 +26306,24 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/testResults/external-projects/{externalProjectId}/defects": { + "/api/v2/testRuns/byWorkItems": { "post": { "tags": [ - "TestResults" - ], - "parameters": [ - { - "name": "externalProjectId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestRuns" ], + "summary": "Create test run based on configurations and work items", + "description": "This method creates a test run based on a combination of configuration and work item (test case or checklist).\r\nBefore you create a test run using this method, make sure to create a test plan.\r\nWork items must be automated.", + "operationId": "CreateAndFillByWorkItems", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateDefectApiModel" + "$ref": "#/components/schemas/CreateTestRunAndFillByWorkItemsApiModel" } ] } @@ -22370,13 +26336,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DefectApiModel" + "$ref": "#/components/schemas/TestRunV2ApiResult" } } } }, "400": { - "description": "Bad Request", + "description": "\r\n- Field is required\r\n\r\n- Test run cannot be created with deleted test points\r\n\r\n- Test suites with IDs [ids] is archived\r\n\r\n- Configurations with IDs [ids] is archived\r\n\r\n- Test run cannot be created with non-automated test point\r\n\r\n- Some work items do not exist\r\n\r\n- Project ID is invalid", "content": { "application/json": { "schema": { @@ -22396,7 +26362,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test results is required", "content": { "application/json": { "schema": { @@ -22406,7 +26372,7 @@ } }, "404": { - "description": "Not Found", + "description": "Some test points, work items or configurations do not exist", "content": { "application/json": { "schema": { @@ -22435,41 +26401,43 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/testResults/{id}/aggregated": { - "get": { + "/api/v2/testRuns/byConfigurations": { + "post": { "tags": [ - "TestResults" + "TestRuns" ], - "summary": "Get test result by ID aggregated with previous results", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Create test runs picking the needed test points", + "description": "This method creates a test run based on a combination of a configuration and a work item(test case or checklist).\r\nBefore you create a test run using this method, make sure to create a test plan. Work items must be automated.\r\nThis method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a\r\njagged array within the \"testPointSelectors\" parameter.", + "operationId": "CreateAndFillByConfigurations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTestRunAndFillByConfigurationsApiModel" + } + ] + } } } - ], + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestResultResponse" + "$ref": "#/components/schemas/TestRunV2ApiResult" } } } }, "400": { - "description": "Bad Request", + "description": "\r\n- Field is required\r\n\r\n- Test run cannot be created with deleted test points\r\n\r\n- Test suites with IDs [ids] is archived\r\n\r\n- Configurations with IDs [ids] is archived\r\n\r\n- Test run cannot be created with non-automated test point\r\n\r\n- Test run must be automated\r\n\r\n- Some work items do not exist\r\n\r\n- Project ID is invalid\r\n\r\n- Test point selectors are required\r\n\r\n- Some work item IDs are invalid\r\n\r\n- Some configuration IDs are invalid", "content": { "application/json": { "schema": { @@ -22489,7 +26457,7 @@ } }, "403": { - "description": "Read permission for the test result is required", + "description": "Update permission for test results is required", "content": { "application/json": { "schema": { @@ -22499,7 +26467,7 @@ } }, "404": { - "description": "Not Found", + "description": "Some test points do not exists", "content": { "application/json": { "schema": { @@ -22528,41 +26496,43 @@ } } } - }, - "deprecated": true + } } }, - "/api/v2/testResults/{id}/reruns": { - "get": { + "/api/v2/testRuns/byAutoTests": { + "post": { "tags": [ - "TestResults" + "TestRuns" ], - "summary": "Get reruns", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test result unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Create test runs based on autotests and configurations", + "description": "This method creates a test run based on an autotest and a configuration.\r\nThe difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is\r\nthat in this method there is no need to create a test plan and work items (test cases and checklists).", + "operationId": "CreateAndFillByAutoTests", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTestRunAndFillByAutoTestsApiModel" + } + ] + } } } - ], + }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RerunsApiResult" + "$ref": "#/components/schemas/TestRunV2ApiResult" } } } }, "400": { - "description": "Bad Request", + "description": "\r\n- Field is required\r\n\r\n- Configuration does not exist in the project\r\n\r\n- Autotest does not exist in the project\r\n\r\n- Test run must be automated\r\n\r\n- Project ID is invalid\r\n\r\n- Autotest external IDs are required\r\n\r\n- Configuration IDs are required", "content": { "application/json": { "schema": { @@ -22582,7 +26552,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test results is required", "content": { "application/json": { "schema": { @@ -22592,7 +26562,7 @@ } }, "404": { - "description": "Not Found", + "description": "Some autotests do not exist", "content": { "application/json": { "schema": { @@ -22624,61 +26594,19 @@ } } }, - "/api/v2/testRuns/search": { + "/api/v2/testRuns/updateMultiple": { "post": { "tags": [ "TestRuns" ], - "summary": "Search for test runs", - "parameters": [ - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" - } - }, - { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", - "schema": { - "type": "string" - } - } - ], + "summary": "Update multiple test runs", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestRunFilterApiModel" + "$ref": "#/components/schemas/UpdateMultipleTestRunsApiModel" } ] } @@ -22686,44 +26614,8 @@ } }, "responses": { - "200": { - "description": "OK", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestRunShortApiResult" - } - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -22746,7 +26638,7 @@ } }, "403": { - "description": "Read permission for autotests library is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -22788,40 +26680,44 @@ } } }, - "/api/v2/testRuns": { - "post": { + "/api/v2/testRuns/{id}": { + "patch": { "tags": [ "TestRuns" ], - "summary": "Create empty TestRun", - "description": "\nUse case\n\nUser sets test run model (listed in the request example)\n\nUser runs method execution\n\nSystem creates test run\n\nSystem returns test run model", - "operationId": "CreateEmpty", + "summary": "Patch test run", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], "requestBody": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateEmptyTestRunApiModel" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } } } } }, "responses": { - "201": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestRunV2ApiResult" - } - } - } + "204": { + "description": "No Content" }, "400": { - "description": "\nField is required\n\nTestRun must be automated\n\nProjectId is not a valid!", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -22831,7 +26727,7 @@ } }, "401": { - "description": "TestRunTesterRequirement permission required", + "description": "Unauthorized", "content": { "application/json": { "schema": { @@ -22841,7 +26737,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Update permission for test library required", "content": { "application/json": { "schema": { @@ -22851,7 +26747,7 @@ } }, "404": { - "description": "Can't find a TestRun with id = testRunId", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -22882,32 +26778,39 @@ } } }, - "put": { + "get": { "tags": [ "TestRuns" ], - "summary": "Update empty TestRun", - "description": "\nUse case\n\nUser sets test run properties (listed in the request example)\n\nUser runs method execution\n\nSystem updates test run\n\nSystem returns returns no content response", - "operationId": "UpdateEmpty", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateEmptyTestRunApiModel" - } - ] - } - } + "summary": "Get TestRun by Id", + "description": "\r\nUse case\r\n\r\nUser sets test run identifier\r\n\r\nUser runs method execution\r\n\r\nSystem finds test run\r\n\r\nSystem returns test run", + "operationId": "GetTestRunById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { - "204": { - "description": "Successful operation" + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestRunV2ApiResult" + } + } + } }, "400": { - "description": "\nField is required\n\nName is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -22927,7 +26830,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Read permission for test result required", "content": { "application/json": { "schema": { @@ -22937,7 +26840,7 @@ } }, "404": { - "description": "\nCan't find a TestRun with id!", + "description": "\r\nTestRun with ID '{id}' does not exist.", "content": { "application/json": { "schema": { @@ -22972,36 +26875,26 @@ "tags": [ "TestRuns" ], - "summary": "Delete multiple test runs", - "description": "\nUse case\n\nUser sets selection parameters of test runs\n\nSystem search and delete collection of test runs\n\nSystem returns the number of deleted test runs", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestRunSelectApiModel" - } - ], - "description": "Model containing options to filter test runs" - } + "summary": "Delete test run", + "description": "\r\nUse case\r\n\r\nUser sets test run internal (guid format) identifier\r\n\r\nSystem search and delete test run", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test run internal (UUID) identifier", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int32" - } - } - } + "204": { + "description": "No Content" }, "400": { - "description": "\n- ID is not valid\n\n- Project was archived and cannot be edited anymore", + "description": "\r\n- ID is not valid\r\n\r\n- Project was archived and cannot be edited anymore", "content": { "application/json": { "schema": { @@ -23031,7 +26924,7 @@ } }, "404": { - "description": "Not Found", + "description": "Test run with provided ID cannot be found", "content": { "application/json": { "schema": { @@ -23063,40 +26956,33 @@ } } }, - "/api/v2/testRuns/byWorkItems": { + "/api/v2/testRuns/{id}/start": { "post": { "tags": [ "TestRuns" ], - "summary": "Create test run based on configurations and work items", - "description": "This method creates a test run based on a combination of configuration and work item (test case or checklist).\nBefore you create a test run using this method, make sure to create a test plan.\nWork items must be automated.", - "operationId": "CreateAndFillByWorkItems", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestRunAndFillByWorkItemsApiModel" - } - ] - } - } + "summary": "Start TestRun", + "description": "\r\nUse case\r\n\r\nUser sets test run identifier\r\n\r\nUser runs method execution\r\n\r\nSystem starts test run\r\n\r\nSystem returns no content response", + "operationId": "StartTestRun", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestRunV2ApiResult" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\n- Field is required\n\n- Test run cannot be created with deleted test points\n\n- Test suites with IDs [ids] is archived\n\n- Configurations with IDs [ids] is archived\n\n- Test run cannot be created with non-automated test point\n\n- Some work items do not exist\n\n- Project ID is invalid", + "description": "\r\nField is required\r\n\r\nthe StateName is already InProgress\r\n\r\nthe StateName is already Stopped\r\n\r\nthe StateName is already Completed", "content": { "application/json": { "schema": { @@ -23116,7 +27002,7 @@ } }, "403": { - "description": "Update permission for test results is required", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -23126,7 +27012,7 @@ } }, "404": { - "description": "Some test points, work items or configurations do not exist", + "description": "\r\nCan't find a TestRun with id!", "content": { "application/json": { "schema": { @@ -23158,40 +27044,33 @@ } } }, - "/api/v2/testRuns/byConfigurations": { + "/api/v2/testRuns/{id}/stop": { "post": { "tags": [ "TestRuns" ], - "summary": "Create test runs picking the needed test points", - "description": "This method creates a test run based on a combination of a configuration and a work item(test case or checklist).\nBefore you create a test run using this method, make sure to create a test plan. Work items must be automated.\nThis method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a\njagged array within the \"testPointSelectors\" parameter.", - "operationId": "CreateAndFillByConfigurations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestRunAndFillByConfigurationsApiModel" - } - ] - } - } + "summary": "Stop TestRun", + "description": "\r\nUse case\r\n\r\nUser sets test run identifier\r\n\r\nUser runs method execution\r\n\r\nSystem stops test run\r\n\r\nSystem returns no content response", + "operationId": "StopTestRun", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestRunV2ApiResult" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\n- Field is required\n\n- Test run cannot be created with deleted test points\n\n- Test suites with IDs [ids] is archived\n\n- Configurations with IDs [ids] is archived\n\n- Test run cannot be created with non-automated test point\n\n- Test run must be automated\n\n- Some work items do not exist\n\n- Project ID is invalid\n\n- Test point selectors are required\n\n- Some work item IDs are invalid\n\n- Some configuration IDs are invalid", + "description": "\r\nField is required\r\n\r\nthe StateName is already Stopped\r\n\r\nthe StateName is already Completed", "content": { "application/json": { "schema": { @@ -23211,7 +27090,7 @@ } }, "403": { - "description": "Update permission for test results is required", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -23221,7 +27100,7 @@ } }, "404": { - "description": "Some test points do not exists", + "description": "\r\nCan't find a TestRun with id!", "content": { "application/json": { "schema": { @@ -23253,40 +27132,33 @@ } } }, - "/api/v2/testRuns/byAutoTests": { + "/api/v2/testRuns/{id}/complete": { "post": { "tags": [ "TestRuns" ], - "summary": "Create test runs based on autotests and configurations", - "description": "This method creates a test run based on an autotest and a configuration.\nThe difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is\nthat in this method there is no need to create a test plan and work items (test cases and checklists).", - "operationId": "CreateAndFillByAutoTests", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestRunAndFillByAutoTestsApiModel" - } - ] - } - } + "summary": "Complete TestRun", + "description": "\r\nUse case\r\n\r\nUser sets test run identifier\r\n\r\nUser runs method execution\r\n\r\nSystem completes test run\r\n\r\nSystem returns no content response", + "operationId": "CompleteTestRun", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } - }, + ], "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestRunV2ApiResult" - } - } - } + "204": { + "description": "Successful operation" }, "400": { - "description": "\n- Field is required\n\n- Configuration does not exist in the project\n\n- Autotest does not exist in the project\n\n- Test run must be automated\n\n- Project ID is invalid\n\n- Autotest external IDs are required\n\n- Configuration IDs are required", + "description": "\r\nField is required\r\n\r\nthe StateName is already Stopped\r\n\r\nthe StateName is already Completed", "content": { "application/json": { "schema": { @@ -23306,7 +27178,7 @@ } }, "403": { - "description": "Update permission for test results is required", + "description": "Update permission for test result required", "content": { "application/json": { "schema": { @@ -23316,7 +27188,7 @@ } }, "404": { - "description": "Some autotests do not exist", + "description": "\r\nCan't find a TestRun with id!", "content": { "application/json": { "schema": { @@ -23348,31 +27220,55 @@ } } }, - "/api/v2/testRuns/updateMultiple": { + "/api/v2/testRuns/{id}/testResults": { "post": { "tags": [ "TestRuns" ], - "summary": "Update multiple test runs", + "summary": "Send test results to the test runs in the system", + "description": "This method sends test results to the test management system.", + "operationId": "SetAutoTestResultsForTestRun", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Test Run internal identifier (GUID format)", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateMultipleTestRunsApiModel" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AutoTestResultsForTestRunModel" + } } } } }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } }, "400": { - "description": "Bad Request", + "description": "\r\n- Field is required\r\n\r\n- Body is invalid\r\n\r\n- Test points are required\r\n\r\n- Duration must be a positive number\r\n\r\n- Outcome is not defined\r\n\r\n- Test run is stopped", "content": { "application/json": { "schema": { @@ -23392,7 +27288,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test results is required", "content": { "application/json": { "schema": { @@ -23402,7 +27298,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\n- Test run with provided ID was not found\r\n\r\n- Test point was not found\r\n\r\n- Autotest with provided external ID was not found", "content": { "application/json": { "schema": { @@ -23422,7 +27318,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "\r\n- Configuration with provided ID was not found\r\n\r\n- Test points relevant to provided filters were not found", "content": { "application/json": { "schema": { @@ -23434,41 +27330,37 @@ } } }, - "/api/v2/testRuns/{id}": { - "patch": { + "/api/v2/testRuns/{id}/testPoints/results": { + "get": { "tags": [ "TestRuns" ], - "summary": "Patch test run", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "summary": "Get test results from the test run grouped by test points", "parameters": [ { "name": "id", "in": "path", - "description": "Test Run internal identifier (GUID format)", + "description": "Test run unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPointResultApiResult" + } } } } - } - }, - "responses": { - "204": { - "description": "No Content" }, "400": { "description": "Bad Request", @@ -23491,7 +27383,7 @@ } }, "403": { - "description": "Update permission for test library required", + "description": "Read permission for test runs is required", "content": { "application/json": { "schema": { @@ -23531,34 +27423,35 @@ } } } - }, + } + }, + "/api/v2/testRuns/{id}/testResults/lastModified/modificationDate": { "get": { "tags": [ "TestRuns" ], - "summary": "Get TestRun by Id", - "description": "\nUse case\n\nUser sets test run identifier\n\nUser runs method execution\n\nSystem finds test run\n\nSystem returns test run", - "operationId": "GetTestRunById", + "summary": "Get modification date of last test result of the test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test Run internal identifier (GUID format)", + "description": "Test run unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "responses": { "200": { - "description": "Successful operation", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestRunV2ApiResult" + "type": "string", + "format": "date-time", + "nullable": true } } } @@ -23584,7 +27477,7 @@ } }, "403": { - "description": "Read permission for test result required", + "description": "Read permission for test runs is required", "content": { "application/json": { "schema": { @@ -23594,7 +27487,7 @@ } }, "404": { - "description": "\nTestRun with ID '{id}' does not exist.", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -23624,18 +27517,19 @@ } } } - }, - "delete": { + } + }, + "/api/v2/testRuns/{id}/statistics/filter": { + "post": { "tags": [ "TestRuns" ], - "summary": "Delete test run", - "description": "\nUse case\n\nUser sets test run internal (guid format) identifier\n\nSystem search and delete test run", + "summary": "Search for the test run test results and build statistics", "parameters": [ { "name": "id", "in": "path", - "description": "Test run internal (UUID) identifier", + "description": "Test run unique ID", "required": true, "schema": { "type": "string", @@ -23643,100 +27537,32 @@ } } ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "\n- ID is not valid\n\n- Project was archived and cannot be edited anymore", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Test run with provided ID cannot be found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestRunStatisticsFilterApiModel" + } + ] } } - }, - "422": { - "description": "Unprocessable Entity", + } + }, + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/TestResultsStatisticsApiResult" } } } - } - } - } - }, - "/api/v2/testRuns/{id}/start": { - "post": { - "tags": [ - "TestRuns" - ], - "summary": "Start TestRun", - "description": "\nUse case\n\nUser sets test run identifier\n\nUser runs method execution\n\nSystem starts test run\n\nSystem returns no content response", - "operationId": "StartTestRun", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test Run internal identifier (GUID format)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - ], - "responses": { - "204": { - "description": "Successful operation" }, "400": { - "description": "\nField is required\n\nthe StateName is already InProgress\n\nthe StateName is already Stopped\n\nthe StateName is already Completed", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -23756,7 +27582,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Read permission for test runs is required", "content": { "application/json": { "schema": { @@ -23766,7 +27592,7 @@ } }, "404": { - "description": "\nCan't find a TestRun with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -23798,33 +27624,43 @@ } } }, - "/api/v2/testRuns/{id}/stop": { - "post": { + "/api/v2/testRuns/{id}/testResults/bulk": { + "put": { "tags": [ "TestRuns" ], - "summary": "Stop TestRun", - "description": "\nUse case\n\nUser sets test run identifier\n\nUser runs method execution\n\nSystem stops test run\n\nSystem returns no content response", - "operationId": "StopTestRun", + "summary": "Partial edit of multiple test results in the test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test Run internal identifier (GUID format)", + "description": "Test run unique ID", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestRunTestResultsPartialBulkSetModel" + } + ] + } + } + } + }, "responses": { "204": { - "description": "Successful operation" + "description": "No Content" }, "400": { - "description": "\nField is required\n\nthe StateName is already Stopped\n\nthe StateName is already Completed", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -23844,7 +27680,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Update permission for test runs is required", "content": { "application/json": { "schema": { @@ -23854,7 +27690,7 @@ } }, "404": { - "description": "\nCan't find a TestRun with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -23886,33 +27722,31 @@ } } }, - "/api/v2/testRuns/{id}/complete": { + "/api/v2/testRuns/{id}/purge": { "post": { "tags": [ "TestRuns" ], - "summary": "Complete TestRun", - "description": "\nUse case\n\nUser sets test run identifier\n\nUser runs method execution\n\nSystem completes test run\n\nSystem returns no content response", - "operationId": "CompleteTestRun", + "summary": "Permanently delete test run from archive", + "description": "\r\nUse case\r\n\r\nUser sets archived test run internal (guid format) identifier\r\n\r\nSystem search and purge archived test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test Run internal identifier (GUID format)", + "description": "Test run internal (UUID) identifier", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "responses": { "204": { - "description": "Successful operation" + "description": "No Content" }, "400": { - "description": "\nField is required\n\nthe StateName is already Stopped\n\nthe StateName is already Completed", + "description": "\r\n- ID is not valid", "content": { "application/json": { "schema": { @@ -23932,7 +27766,7 @@ } }, "403": { - "description": "Update permission for test result required", + "description": "Delete permission for archived test runs is required", "content": { "application/json": { "schema": { @@ -23942,7 +27776,7 @@ } }, "404": { - "description": "\nCan't find a TestRun with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -23974,55 +27808,41 @@ } } }, - "/api/v2/testRuns/{id}/testResults": { + "/api/v2/testRuns/purge/bulk": { "post": { "tags": [ "TestRuns" ], - "summary": "Send test results to the test runs in the system", - "description": "This method sends test results to the test management system.", - "operationId": "SetAutoTestResultsForTestRun", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test Run internal identifier (GUID format)", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], + "summary": "Permanently delete multiple test runs from archive", + "description": "\r\nUse case\r\n\r\nUser sets selection parameters of archived test runs\r\n\r\nSystem search and delete collection of archived test runs\r\n\r\nSystem returns the number of deleted archived test runs", "requestBody": { "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AutoTestResultsForTestRunModel" - } + "allOf": [ + { + "$ref": "#/components/schemas/TestRunSelectApiModel" + } + ], + "description": "Model containing options to filter test runs" } } } }, "responses": { "200": { - "description": "Successful operation", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "type": "integer", + "format": "int32" } } } }, "400": { - "description": "\n- Field is required\n\n- Body is invalid\n\n- Test points are required\n\n- Duration must be a positive number\n\n- Outcome is not defined\n\n- Test run is stopped", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -24042,7 +27862,7 @@ } }, "403": { - "description": "Update permission for test results is required", + "description": "Delete permission for archived test runs is required", "content": { "application/json": { "schema": { @@ -24052,7 +27872,7 @@ } }, "404": { - "description": "\n- Test run with provided ID was not found\n\n- Test point was not found\n\n- Autotest with provided external ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -24072,7 +27892,7 @@ } }, "422": { - "description": "\n- Configuration with provided ID was not found\n\n- Test points relevant to provided filters were not found", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -24084,17 +27904,18 @@ } } }, - "/api/v2/testRuns/{id}/testPoints/results": { - "get": { + "/api/v2/testRuns/{id}/restore": { + "post": { "tags": [ "TestRuns" ], - "summary": "Get test results from the test run grouped by test points", + "summary": "Restore test run from the archive", + "description": "\r\nUse case\r\n\r\nUser sets archived test run internal (guid format) identifier\r\n\r\nSystem search and restore test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test run unique ID", + "description": "Unique ID of the test run", "required": true, "schema": { "type": "string", @@ -24103,21 +27924,11 @@ } ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestPointResultApiResult" - } - } - } - } + "204": { + "description": "No Content" }, "400": { - "description": "Bad Request", + "description": "\r\n- ID is not valid\r\n\r\n- Project was archived and cannot be edited anymore", "content": { "application/json": { "schema": { @@ -24137,7 +27948,7 @@ } }, "403": { - "description": "Read permission for test runs is required", + "description": "Read permission for archive is required", "content": { "application/json": { "schema": { @@ -24179,33 +27990,35 @@ } } }, - "/api/v2/testRuns/{id}/testResults/lastModified/modificationDate": { - "get": { + "/api/v2/testRuns/restore/bulk": { + "post": { "tags": [ "TestRuns" ], - "summary": "Get modification date of last test result of the test run", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test run unique ID", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "summary": "Restore multiple test runs from the archive", + "description": "\r\nUse case\r\n\r\nUser sets selection parameters of archived test runs\r\n\r\nSystem search and restore collection of archived test runs\r\n\r\nSystem returns the number of restored test runs", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestRunSelectApiModel" + } + ], + "description": "Model containing options to filter test runs" + } } } - ], + }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "string", - "format": "date-time", - "nullable": true + "type": "integer", + "format": "int32" } } } @@ -24231,7 +28044,7 @@ } }, "403": { - "description": "Read permission for test runs is required", + "description": "Read permission for archive is required", "content": { "application/json": { "schema": { @@ -24273,17 +28086,16 @@ } } }, - "/api/v2/testRuns/{id}/statistics/filter": { + "/api/v2/testRuns/{id}/reruns": { "post": { "tags": [ "TestRuns" ], - "summary": "Search for the test run test results and build statistics", + "summary": "Manual autotests rerun in test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test run unique ID", "required": true, "schema": { "type": "string", @@ -24297,7 +28109,7 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestRunStatisticsFilterApiModel" + "$ref": "#/components/schemas/ManualRerunSelectTestResultsApiModel" } ] } @@ -24310,7 +28122,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestResultsStatisticsApiResult" + "$ref": "#/components/schemas/ManualRerunApiResult" } } } @@ -24336,7 +28148,7 @@ } }, "403": { - "description": "Read permission for test runs is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24378,17 +28190,16 @@ } } }, - "/api/v2/testRuns/{id}/testResults/bulk": { - "put": { + "/api/v2/testRuns/{id}/autoTestsNamespaces": { + "get": { "tags": [ "TestRuns" ], - "summary": "Partial edit of multiple test results in the test run", + "summary": "Get autotest classes and namespaces in test run", "parameters": [ { "name": "id", "in": "path", - "description": "Test run unique ID", "required": true, "schema": { "type": "string", @@ -24396,22 +28207,16 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestRunTestResultsPartialBulkSetModel" - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutoTestNamespacesCountResponse" + } } } - } - }, - "responses": { - "204": { - "description": "No Content" }, "400": { "description": "Bad Request", @@ -24434,7 +28239,7 @@ } }, "403": { - "description": "Update permission for test runs is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24476,31 +28281,74 @@ } } }, - "/api/v2/testRuns/{id}/purge": { + "/api/v2/testStatuses/search": { "post": { "tags": [ - "TestRuns" + "TestStatuses" ], - "summary": "Permanently delete test run from archive", - "description": "\nUse case\n\nUser sets archived test run internal (guid format) identifier\n\nSystem search and purge archived test run", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test run internal (UUID) identifier", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchTestStatusesApiModel" + } + ] + } + }, + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchTestStatusesApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchTestStatusesApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchTestStatusesApiModel" + } + ] + } } } - ], + }, "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResultIReply" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResultIReply" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResultIReply" + } + } + } }, "400": { - "description": "\n- ID is not valid", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -24520,7 +28368,7 @@ } }, "403": { - "description": "Delete permission for archived test runs is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24562,35 +28410,39 @@ } } }, - "/api/v2/testRuns/purge/bulk": { - "post": { + "/api/v2/testStatuses/{id}": { + "get": { "tags": [ - "TestRuns" + "TestStatuses" ], - "summary": "Permanently delete multiple test runs from archive", - "description": "\nUse case\n\nUser sets selection parameters of archived test runs\n\nSystem search and delete collection of archived test runs\n\nSystem returns the number of deleted archived test runs", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestRunSelectApiModel" - } - ], - "description": "Model containing options to filter test runs" - } + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResult" + } + }, "application/json": { "schema": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/TestStatusApiResult" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResult" } } } @@ -24616,7 +28468,7 @@ } }, "403": { - "description": "Delete permission for archived test runs is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24656,20 +28508,15 @@ } } } - } - }, - "/api/v2/testRuns/{id}/restore": { - "post": { + }, + "put": { "tags": [ - "TestRuns" + "TestStatuses" ], - "summary": "Restore test run from the archive", - "description": "\nUse case\n\nUser sets archived test run internal (guid format) identifier\n\nSystem search and restore test run", "parameters": [ { "name": "id", "in": "path", - "description": "Unique ID of the test run", "required": true, "schema": { "type": "string", @@ -24677,12 +28524,52 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTestStatusApiModel" + } + ] + } + }, + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTestStatusApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTestStatusApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTestStatusApiModel" + } + ] + } + } + } + }, "responses": { "204": { "description": "No Content" }, "400": { - "description": "\n- ID is not valid\n\n- Project was archived and cannot be edited anymore", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -24702,7 +28589,7 @@ } }, "403": { - "description": "Read permission for archive is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24742,40 +28629,25 @@ } } } - } - }, - "/api/v2/testRuns/restore/bulk": { - "post": { + }, + "delete": { "tags": [ - "TestRuns" + "TestStatuses" ], - "summary": "Restore multiple test runs from the archive", - "description": "\nUse case\n\nUser sets selection parameters of archived test runs\n\nSystem search and restore collection of archived test runs\n\nSystem returns the number of restored test runs", - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestRunSelectApiModel" - } - ], - "description": "Model containing options to filter test runs" - } + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int32" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -24798,7 +28670,7 @@ } }, "403": { - "description": "Read permission for archive is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -24840,30 +28712,45 @@ } } }, - "/api/v2/testRuns/{id}/reruns": { + "/api/v2/testStatuses": { "post": { "tags": [ - "TestRuns" - ], - "summary": "Manual autotests rerun in test run", - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } + "TestStatuses" ], "requestBody": { "content": { + "application/json-patch+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTestStatusApiModel" + } + ] + } + }, "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ManualRerunSelectTestResultsApiModel" + "$ref": "#/components/schemas/CreateTestStatusApiModel" + } + ] + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTestStatusApiModel" + } + ] + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTestStatusApiModel" } ] } @@ -24871,12 +28758,22 @@ } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResult" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/ManualRerunApiResult" + "$ref": "#/components/schemas/TestStatusApiResult" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TestStatusApiResult" } } } @@ -24944,20 +28841,18 @@ } } }, - "/api/v2/testRuns/{id}/autoTestsNamespaces": { + "/api/v2/testStatuses/name/{name}/exists": { "get": { "tags": [ - "TestRuns" + "TestStatuses" ], - "summary": "Get autotest classes and namespaces in test run", "parameters": [ { - "name": "id", + "name": "name", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -24965,9 +28860,19 @@ "200": { "description": "OK", "content": { + "text/plain": { + "schema": { + "type": "boolean" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/AutoTestNamespacesCountResponse" + "type": "boolean" + } + }, + "text/json": { + "schema": { + "type": "boolean" } } } @@ -25035,68 +28940,38 @@ } } }, - "/api/v2/testStatuses/search": { - "post": { + "/api/v2/testStatuses/code/{code}/exists": { + "get": { "tags": [ "TestStatuses" ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SearchTestStatusesApiModel" - } - ] - } - }, - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SearchTestStatusesApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SearchTestStatusesApiModel" - } - ] - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SearchTestStatusesApiModel" - } - ] - } + "parameters": [ + { + "name": "code", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/TestStatusApiResultIReply" + "type": "boolean" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TestStatusApiResultIReply" + "type": "boolean" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TestStatusApiResultIReply" + "type": "boolean" } } } @@ -25164,39 +29039,34 @@ } } }, - "/api/v2/testStatuses/{id}": { + "/api/v2/testSuites/{id}": { "get": { "tags": [ - "TestStatuses" + "TestSuites" ], + "summary": "Get TestSuite by Id", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem returns test suite", + "operationId": "GetTestSuiteById", "parameters": [ { "name": "id", "in": "path", + "description": "Test suite internal (guid format) identifier\"", "required": true, "schema": { "type": "string", "format": "uuid" - } + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { - "description": "OK", + "description": "Successful operation", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" + "$ref": "#/components/schemas/TestSuiteApiResult" } } } @@ -25222,7 +29092,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -25232,7 +29102,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nCan't find a TestSuite with id!", "content": { "application/json": { "schema": { @@ -25263,14 +29133,17 @@ } } }, - "put": { + "patch": { "tags": [ - "TestStatuses" + "TestSuites" ], + "summary": "Patch test suite", + "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", "parameters": [ { "name": "id", "in": "path", + "description": "Test Suite internal (UUID) identifier", "required": true, "schema": { "type": "string", @@ -25280,40 +29153,12 @@ ], "requestBody": { "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTestStatusApiModel" - } - ] - } - }, "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTestStatusApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTestStatusApiModel" - } - ] - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateTestStatusApiModel" - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Operation" + } } } } @@ -25343,7 +29188,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test suite is required", "content": { "application/json": { "schema": { @@ -25386,22 +29231,27 @@ }, "delete": { "tags": [ - "TestStatuses" + "TestSuites" ], + "summary": "Delete TestSuite", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem deletes test suite\r\n\r\nSystem returns no content response", + "operationId": "DeleteTestSuite", "parameters": [ { "name": "id", "in": "path", + "description": "Test suite internal (guid format) identifier\"", "required": true, "schema": { "type": "string", "format": "uuid" - } + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "204": { - "description": "No Content" + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -25424,7 +29274,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Delete permission for test plan required", "content": { "application/json": { "schema": { @@ -25434,7 +29284,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nCan't find a TestSuite with id", "content": { "application/json": { "schema": { @@ -25466,45 +29316,19 @@ } } }, - "/api/v2/testStatuses": { + "/api/v2/testSuites": { "post": { "tags": [ - "TestStatuses" + "TestSuites" ], + "summary": "Create test suite", "requestBody": { "content": { - "application/json-patch+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestStatusApiModel" - } - ] - } - }, "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateTestStatusApiModel" - } - ] - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestStatusApiModel" - } - ] - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateTestStatusApiModel" + "$ref": "#/components/schemas/TestSuiteV2PostModel" } ] } @@ -25515,19 +29339,9 @@ "201": { "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TestStatusApiResult" + "$ref": "#/components/schemas/TestSuiteV2GetModel" } } } @@ -25553,7 +29367,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -25593,43 +29407,28 @@ } } } - } - }, - "/api/v2/testStatuses/name/{name}/exists": { - "get": { + }, + "put": { "tags": [ - "TestStatuses" + "TestSuites" ], - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" + "summary": "Edit test suite", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/TestSuiteV2PutModel" + } + ] + } } } - ], + }, "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "boolean" - } - }, - "application/json": { - "schema": { - "type": "boolean" - } - }, - "text/json": { - "schema": { - "type": "boolean" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -25652,7 +29451,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -25694,41 +29493,27 @@ } } }, - "/api/v2/testStatuses/code/{code}/exists": { - "get": { + "/api/v2/testSuites/{id}/refresh": { + "post": { "tags": [ - "TestStatuses" + "TestSuites" ], + "summary": "Refresh test suite. Only dynamic test suites are supported by this method", "parameters": [ { - "name": "code", + "name": "id", "in": "path", + "description": "Test Suite internal (UUID) identifier", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "boolean" - } - }, - "application/json": { - "schema": { - "type": "boolean" - } - }, - "text/json": { - "schema": { - "type": "boolean" - } - } - } + "204": { + "description": "No Content" }, "400": { "description": "Bad Request", @@ -25751,7 +29536,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Update permission for test suite is required", "content": { "application/json": { "schema": { @@ -25793,14 +29578,14 @@ } } }, - "/api/v2/testSuites/{id}": { + "/api/v2/testSuites/{id}/testPoints": { "get": { "tags": [ "TestSuites" ], - "summary": "Get TestSuite by Id", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem returns test suite", - "operationId": "GetTestSuiteById", + "summary": "Get TestPoints By Id", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem search test points related to the test suite\r\n\r\nSystem returns test points array", + "operationId": "GetTestPointsById", "parameters": [ { "name": "id", @@ -25820,7 +29605,10 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestSuiteApiResult" + "type": "array", + "items": { + "$ref": "#/components/schemas/TestPointByTestSuiteModel" + } } } } @@ -25856,7 +29644,7 @@ } }, "404": { - "description": "\nCan't find a TestSuite with id!", + "description": "\r\nCan't find a TestSuite with id!", "content": { "application/json": { "schema": { @@ -25886,40 +29674,42 @@ } } } - }, - "patch": { + } + }, + "/api/v2/testSuites/{id}/testResults": { + "get": { "tags": [ "TestSuites" ], - "summary": "Patch test suite", - "description": "See RFC 6902: JavaScript Object Notation (JSON) Patch for details", + "summary": "Get TestResults By Id", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem search test points related to the test suite\r\n\r\nSystem search test results related to the test points\r\n\r\nSystem returns test results array", + "operationId": "GetTestResultsById", "parameters": [ { "name": "id", "in": "path", - "description": "Test Suite internal (UUID) identifier", + "description": "Test suite internal (guid format) identifier\"", "required": true, "schema": { "type": "string", "format": "uuid" - } + }, + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation" + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestResultV2ShortModel" + } } } } - } - }, - "responses": { - "204": { - "description": "No Content" }, "400": { "description": "Bad Request", @@ -25942,7 +29732,7 @@ } }, "403": { - "description": "Update permission for test suite is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -25952,7 +29742,7 @@ } }, "404": { - "description": "Not Found", + "description": "\r\nCan't find a TestSuite with id!", "content": { "application/json": { "schema": { @@ -25982,14 +29772,16 @@ } } } - }, - "delete": { + } + }, + "/api/v2/testSuites/{id}/workItems/search": { + "post": { "tags": [ "TestSuites" ], - "summary": "Delete TestSuite", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem deletes test suite\n\nSystem returns no content response", - "operationId": "DeleteTestSuite", + "summary": "Search WorkItems", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\n[Optional] User sets filter\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem search test points related to the test suite\r\n\r\nSystem search work items related to the test points\r\n\r\n[Optional] User sets filter, system applies filter\r\n\r\nSystem returns work items array", + "operationId": "SearchWorkItems", "parameters": [ { "name": "id", @@ -26001,88 +29793,55 @@ "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - ], - "responses": { - "204": { - "description": "Successful operation" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "Skip", + "in": "query", + "description": "Amount of items to be skipped (offset)", + "schema": { + "type": "integer" } }, - "403": { - "description": "Delete permission for test plan required", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "Take", + "in": "query", + "description": "Amount of items to be taken (limit)", + "schema": { + "type": "integer" } }, - "404": { - "description": "\nCan't find a TestSuite with id", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "OrderBy", + "in": "query", + "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", + "schema": { + "type": "string" } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "SearchField", + "in": "query", + "description": "Property name for searching", + "schema": { + "type": "string" } }, - "422": { - "description": "Unprocessable Entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + { + "name": "SearchValue", + "in": "query", + "description": "Value for searching", + "schema": { + "type": "string" } } - } - } - }, - "/api/v2/testSuites": { - "post": { - "tags": [ - "TestSuites" ], - "summary": "Create test suite", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/TestSuiteV2PostModel" + "$ref": "#/components/schemas/TestSuiteWorkItemsSearchModel" } ] } @@ -26090,12 +29849,41 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Successful operation", + "headers": { + "Pagination-Skip": { + "description": "Skipped amount of items", + "schema": { + "type": "integer" + } + }, + "Pagination-Take": { + "description": "Taken items", + "schema": { + "type": "integer" + } + }, + "Pagination-Pages": { + "description": "Expected number of pages", + "schema": { + "type": "integer" + } + }, + "Pagination-Total-Items": { + "description": "Total count of items", + "schema": { + "type": "integer" + } + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestSuiteV2GetModel" + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkItemShortModel" + } } } } @@ -26121,7 +29909,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Read permission for test plan required", "content": { "application/json": { "schema": { @@ -26131,7 +29919,7 @@ } }, "404": { - "description": "Not Found", + "description": "Can't find a TestSuite with id!", "content": { "application/json": { "schema": { @@ -26160,22 +29948,38 @@ } } } - } - }, - "put": { + }, + "deprecated": true + } + }, + "/api/v2/testSuites/{id}/workItems": { + "post": { "tags": [ "TestSuites" ], - "summary": "Edit test suite", + "summary": "Set work items for test suite", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Unique ID of the test suite", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestSuiteV2PutModel" - } - ] + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } } } } @@ -26247,27 +30051,44 @@ } } }, - "/api/v2/testSuites/{id}/refresh": { + "/api/v2/testSuites/{id}/test-points": { "post": { "tags": [ "TestSuites" ], - "summary": "Refresh test suite. Only dynamic test suites are supported by this method", + "summary": "Add test-points to test suite", + "operationId": "AddTestPointsToTestSuite", "parameters": [ { "name": "id", "in": "path", - "description": "Test Suite internal (UUID) identifier", + "description": "Test suite internal identifier", "required": true, "schema": { "type": "string", "format": "uuid" - } + }, + "example": "1ed608bf-8ac9-4ffd-b91e-ebdbbdce6132" } ], + "requestBody": { + "description": "Filter object to retrieve work items for test-suite's project", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/WorkItemSelectModel" + } + ], + "description": "Model containing options to filter work items" + } + } + } + }, "responses": { "204": { - "description": "No Content" + "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -26290,7 +30111,7 @@ } }, "403": { - "description": "Update permission for test suite is required", + "description": "Update permission for test plan is required", "content": { "application/json": { "schema": { @@ -26300,7 +30121,7 @@ } }, "404": { - "description": "Not Found", + "description": "Test suite with provided ID was not found", "content": { "application/json": { "schema": { @@ -26320,7 +30141,7 @@ } }, "422": { - "description": "Unprocessable Entity", + "description": "Shared steps cannot be added to test suite", "content": { "application/json": { "schema": { @@ -26332,14 +30153,14 @@ } } }, - "/api/v2/testSuites/{id}/testPoints": { + "/api/v2/testSuites/{id}/configurations": { "get": { "tags": [ "TestSuites" ], - "summary": "Get TestPoints By Id", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem search test points related to the test suite\n\nSystem returns test points array", - "operationId": "GetTestPointsById", + "summary": "Get Configurations By Id", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem search test points related to the test suite\r\n\r\nSystem search configurations related to the test points\r\n\r\nSystem returns configurations array", + "operationId": "GetConfigurationsByTestSuiteId", "parameters": [ { "name": "id", @@ -26361,7 +30182,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/TestPointByTestSuiteModel" + "$ref": "#/components/schemas/ConfigurationModel" } } } @@ -26398,7 +30219,7 @@ } }, "404": { - "description": "\nCan't find a TestSuite with id!", + "description": "\r\nCan't find a TestSuite with id!", "content": { "application/json": { "schema": { @@ -26428,16 +30249,14 @@ } } } - } - }, - "/api/v2/testSuites/{id}/testResults": { - "get": { + }, + "post": { "tags": [ "TestSuites" ], - "summary": "Get TestResults By Id", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem search test points related to the test suite\n\nSystem search test results related to the test points\n\nSystem returns test results array", - "operationId": "GetTestResultsById", + "summary": "Set Configurations By TestSuite Id", + "description": "\r\nUse case\r\n\r\nUser sets test suite identifier\r\n\r\nUser sets collection of configuration identifiers\r\n\r\nUser runs method execution\r\n\r\nSystem search test suite by identifier\r\n\r\nSystem search test points related to the test suite\r\n\r\nSystem search configuration\r\n\r\nSystem restores(if exist) or creates test points with listed configuration\r\n\r\nSystem returns no content response", + "operationId": "SetConfigurationsByTestSuiteId", "parameters": [ { "name": "id", @@ -26451,22 +30270,27 @@ "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestResultV2ShortModel" - } + "requestBody": { + "description": "Collection of configuration identifiers\"", + "content": { + "application/json": { + "schema": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid" } } } + } + }, + "responses": { + "204": { + "description": "Successful operation" }, "400": { - "description": "Bad Request", + "description": "\r\nSome of Configurations do not exist in the project, or they are not active", "content": { "application/json": { "schema": { @@ -26486,7 +30310,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Update permission for test plan required", "content": { "application/json": { "schema": { @@ -26496,7 +30320,7 @@ } }, "404": { - "description": "\nCan't find a TestSuite with id!", + "description": "\r\nCan't find a TestSuite with id", "content": { "application/json": { "schema": { @@ -26528,119 +30352,34 @@ } } }, - "/api/v2/testSuites/{id}/workItems/search": { + "/api/v2/users/{userId}/roles/{roleId}": { "post": { "tags": [ - "TestSuites" + "UserRoleAssignments" ], - "summary": "Search WorkItems", - "description": "\nUse case\n\nUser sets test suite identifier\n\n[Optional] User sets filter\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem search test points related to the test suite\n\nSystem search work items related to the test points\n\n[Optional] User sets filter, system applies filter\n\nSystem returns work items array", - "operationId": "SearchWorkItems", "parameters": [ { - "name": "id", + "name": "userId", "in": "path", - "description": "Test suite internal (guid format) identifier\"", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "name": "Skip", - "in": "query", - "description": "Amount of items to be skipped (offset)", - "schema": { - "type": "integer" - } - }, - { - "name": "Take", - "in": "query", - "description": "Amount of items to be taken (limit)", - "schema": { - "type": "integer" - } - }, - { - "name": "OrderBy", - "in": "query", - "description": "SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)", - "schema": { - "type": "string" - } - }, - { - "name": "SearchField", - "in": "query", - "description": "Property name for searching", - "schema": { - "type": "string" } }, { - "name": "SearchValue", - "in": "query", - "description": "Value for searching", + "name": "roleId", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/TestSuiteWorkItemsSearchModel" - } - ] - } - } - } - }, "responses": { "200": { - "description": "Successful operation", - "headers": { - "Pagination-Skip": { - "description": "Skipped amount of items", - "schema": { - "type": "integer" - } - }, - "Pagination-Take": { - "description": "Taken items", - "schema": { - "type": "integer" - } - }, - "Pagination-Pages": { - "description": "Expected number of pages", - "schema": { - "type": "integer" - } - }, - "Pagination-Total-Items": { - "description": "Total count of items", - "schema": { - "type": "integer" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkItemShortModel" - } - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -26663,7 +30402,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -26673,7 +30412,7 @@ } }, "404": { - "description": "Can't find a TestSuite with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -26702,45 +30441,35 @@ } } } - }, - "deprecated": true - } - }, - "/api/v2/testSuites/{id}/workItems": { - "post": { + } + }, + "delete": { "tags": [ - "TestSuites" + "UserRoleAssignments" ], - "summary": "Set work items for test suite", "parameters": [ { - "name": "id", + "name": "userId", "in": "path", - "description": "Unique ID of the test suite", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } + }, + { + "name": "roleId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK" }, "400": { "description": "Bad Request", @@ -26763,7 +30492,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -26805,44 +30534,32 @@ } } }, - "/api/v2/testSuites/{id}/test-points": { - "post": { + "/api/v2/users/{userId}": { + "get": { "tags": [ - "TestSuites" + "Users" ], - "summary": "Add test-points to test suite", - "operationId": "AddTestPointsToTestSuite", "parameters": [ { - "name": "id", + "name": "userId", "in": "path", - "description": "Test suite internal identifier", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "1ed608bf-8ac9-4ffd-b91e-ebdbbdce6132" + } } ], - "requestBody": { - "description": "Filter object to retrieve work items for test-suite's project", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkItemSelectModel" - } - ], - "description": "Model containing options to filter work items" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserApiModel" + } } } - } - }, - "responses": { - "204": { - "description": "Successful operation" }, "400": { "description": "Bad Request", @@ -26865,7 +30582,7 @@ } }, "403": { - "description": "Update permission for test plan is required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -26875,7 +30592,7 @@ } }, "404": { - "description": "Test suite with provided ID was not found", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -26895,7 +30612,7 @@ } }, "422": { - "description": "Shared steps cannot be added to test suite", + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -26905,42 +30622,25 @@ } } } - } - }, - "/api/v2/testSuites/{id}/configurations": { - "get": { + }, + "delete": { "tags": [ - "TestSuites" + "Users" ], - "summary": "Get Configurations By Id", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem search test points related to the test suite\n\nSystem search configurations related to the test points\n\nSystem returns configurations array", - "operationId": "GetConfigurationsByTestSuiteId", "parameters": [ { - "name": "id", + "name": "userId", "in": "path", - "description": "Test suite internal (guid format) identifier\"", "required": true, "schema": { "type": "string", "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } ], "responses": { "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConfigurationModel" - } - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -26963,7 +30663,7 @@ } }, "403": { - "description": "Read permission for test plan required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -26973,7 +30673,7 @@ } }, "404": { - "description": "\nCan't find a TestSuite with id!", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -27003,48 +30703,39 @@ } } } - }, + } + }, + "/api/v2/users": { "post": { "tags": [ - "TestSuites" - ], - "summary": "Set Configurations By TestSuite Id", - "description": "\nUse case\n\nUser sets test suite identifier\n\nUser sets collection of configuration identifiers\n\nUser runs method execution\n\nSystem search test suite by identifier\n\nSystem search test points related to the test suite\n\nSystem search configuration\n\nSystem restores(if exist) or creates test points with listed configuration\n\nSystem returns no content response", - "operationId": "SetConfigurationsByTestSuiteId", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Test suite internal (guid format) identifier\"", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - }, - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } + "Users" ], "requestBody": { - "description": "Collection of configuration identifiers\"", "content": { "application/json": { "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserApiModel" + } + ] } } } }, "responses": { - "204": { - "description": "Successful operation" + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserApiModel" + } + } + } }, "400": { - "description": "\nSome of Configurations do not exist in the project, or they are not active", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -27064,7 +30755,7 @@ } }, "403": { - "description": "Update permission for test plan required", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -27074,7 +30765,7 @@ } }, "404": { - "description": "\nCan't find a TestSuite with id", + "description": "Not Found", "content": { "application/json": { "schema": { @@ -27194,6 +30885,170 @@ } } }, + "/api/v2/user-storages/{resource}": { + "get": { + "tags": [ + "UserStorages" + ], + "parameters": [ + { + "name": "resource", + "in": "path", + "required": true, + "schema": { + "maxLength": 128, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "UserStorages" + ], + "parameters": [ + { + "name": "resource", + "in": "path", + "required": true, + "schema": { + "maxLength": 128, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, "/api/v2/webhooks/search": { "post": { "tags": [ @@ -29272,13 +33127,13 @@ "WorkItems" ], "summary": "Get Test Case, Checklist or Shared Step by Id or GlobalId", - "description": "\nUse case\n\nUser sets work item identifier\n\n[Optional] User sets work item version identifier\n\n[Optional] User sets work item version number\n\nUser runs method execution\n\nSystem search work item by identifier\n\n[Optional] if User sets work item version identifier, system search work item version by identifier.\n\n[Optional] if user sets work item version number, system search work item version by number\n\nOtherwise, system search last work item version\n\nSystem returns work item", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\n[Optional] User sets work item version identifier\r\n\r\n[Optional] User sets work item version number\r\n\r\nUser runs method execution\r\n\r\nSystem search work item by identifier\r\n\r\n[Optional] if User sets work item version identifier, system search work item version by identifier.\r\n\r\n[Optional] if user sets work item version number, system search work item version by number\r\n\r\nOtherwise, system search last work item version\r\n\r\nSystem returns work item", "operationId": "GetWorkItemById", "parameters": [ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -29390,7 +33245,7 @@ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -29482,13 +33337,13 @@ "WorkItems" ], "summary": "Delete Test Case, Checklist or Shared Step by Id or GlobalId", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem deletes work item\n\nSystem returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem deletes work item\r\n\r\nSystem returns no content response", "operationId": "DeleteWorkItem", "parameters": [ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -29575,7 +33430,7 @@ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -29778,7 +33633,7 @@ "WorkItems" ], "summary": "Update Test Case, Checklist or Shared Step", - "description": "\nUse case\n\nUser sets work item properties (listed in request parameters)\n\nUser runs method execution\n\nSystem updates work item by identifier\n\nSystem returns updated work item model (listed in response parameters)", + "description": "\r\nUse case\r\n\r\nUser sets work item properties (listed in request parameters)\r\n\r\nUser runs method execution\r\n\r\nSystem updates work item by identifier\r\n\r\nSystem returns updated work item model (listed in response parameters)", "requestBody": { "content": { "application/json": { @@ -29797,7 +33652,7 @@ "description": "Successful operation" }, "400": { - "description": "\nField is required\n\nPriority is not a valid\n\nduration should be a positive number\n\nshould be empty for CheckList\n\nThere is no option in ProjectAttributesScheme with such Id\n\nAttribute value must be a valid guid for options scheme", + "description": "\r\nField is required\r\n\r\nPriority is not a valid\r\n\r\nduration should be a positive number\r\n\r\nshould be empty for CheckList\r\n\r\nThere is no option in ProjectAttributesScheme with such Id\r\n\r\nAttribute value must be a valid guid for options scheme", "content": { "application/json": { "schema": { @@ -29827,7 +33682,7 @@ } }, "404": { - "description": "\nWorkItem not found\n\nCan't find section\n\nCan't attributesScheme\n\nCan't attribute\n\nAutoTestIds not exist in project", + "description": "\r\nWorkItem not found\r\n\r\nCan't find section\r\n\r\nCan't attributesScheme\r\n\r\nCan't attribute\r\n\r\nAutoTestIds not exist in project", "content": { "application/json": { "schema": { @@ -30037,13 +33892,13 @@ "WorkItems" ], "summary": "Get all AutoTests linked to WorkItem by Id or GlobalId", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem search work item by identifier\n\nSystem search all autotests, related to found work item\n\nSystem returns list of found autotests", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search work item by identifier\r\n\r\nSystem search all autotests, related to found work item\r\n\r\nSystem returns list of found autotests", "operationId": "GetAutoTestsForWorkItem", "parameters": [ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -30133,13 +33988,13 @@ "WorkItems" ], "summary": "Delete all links AutoTests from WorkItem by Id or GlobalId", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem search work item by identifier\n\nSystem search and delete all autotests, related to found work item\n\nSystem returns no content response", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search work item by identifier\r\n\r\nSystem search and delete all autotests, related to found work item\r\n\r\nSystem returns no content response", "operationId": "DeleteAllWorkItemsFromAutoTest", "parameters": [ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -30224,7 +34079,7 @@ "WorkItems" ], "summary": "Get WorkItem chronology by Id or GlobalId", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem search work item by identifier\n\nSystem search test results of all autotests, related to found work item\n\nSystem sort results by CompletedOn ascending, then by CreatedDate ascending\n\nSystem returns sorted collection of test results", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search work item by identifier\r\n\r\nSystem search test results of all autotests, related to found work item\r\n\r\nSystem sort results by CompletedOn ascending, then by CreatedDate ascending\r\n\r\nSystem returns sorted collection of test results", "operationId": "GetWorkItemChronology", "parameters": [ { @@ -30322,13 +34177,13 @@ "WorkItems" ], "summary": "Get WorkItem versions", - "description": "\nUse case\n\nUser sets work item identifier\n\n[Optional] User sets work item version identifier\n\nUser runs method execution\n\nSystem search work item by identifier\n\n[Optional] If User set work item version identifier, System search work item version by version identifier\n Otherwise, system search all version of work item\n\nSystem returns array of work item version models (listed in response example)", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\n[Optional] User sets work item version identifier\r\n\r\nUser runs method execution\r\n\r\nSystem search work item by identifier\r\n\r\n[Optional] If User set work item version identifier, System search work item version by version identifier\r\n Otherwise, system search all version of work item\r\n\r\nSystem returns array of work item version models (listed in response example)", "operationId": "GetWorkItemVersions", "parameters": [ { "name": "id", "in": "path", - "description": "WorkItem internal (guid format) or\nglobal(integer format) identifier\"", + "description": "WorkItem internal (guid format) or\r\nglobal(integer format) identifier\"", "required": true, "schema": { "type": "string", @@ -30339,7 +34194,7 @@ { "name": "workItemVersionId", "in": "query", - "description": "WorkItem version (guid format)\nidentifier\"", + "description": "WorkItem version (guid format)\r\nidentifier\"", "schema": { "type": "string", "format": "uuid" @@ -30349,7 +34204,7 @@ { "name": "versionNumber", "in": "query", - "description": "WorkItem version (integer format)\nnumber\"", + "description": "WorkItem version (integer format)\r\nnumber\"", "schema": { "type": "integer", "format": "int32" @@ -30764,7 +34619,7 @@ "WorkItems" ], "summary": "Get SharedStep references", - "description": "\nUse case\n\nUser sets SharedStep identifier\n\nUser runs method execution\n\nSystem return SharedStep references", + "description": "\r\nUse case\r\n\r\nUser sets SharedStep identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return SharedStep references", "parameters": [ { "name": "sharedStepId", @@ -30860,7 +34715,7 @@ "WorkItems" ], "summary": "Upload and link attachment to WorkItem", - "description": "\nUse case\n\nUser sets workItemId\n\nUser attaches a file\n\nSystem creates attachment and links it to the work item\n\nSystem returns attachment identifier", + "description": "\r\nUse case\r\n\r\nUser sets workItemId\r\n\r\nUser attaches a file\r\n\r\nSystem creates attachment and links it to the work item\r\n\r\nSystem returns attachment identifier", "parameters": [ { "name": "id", @@ -30973,7 +34828,7 @@ "WorkItems" ], "summary": "Get change history of WorkItem", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem return change history of WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return change history of WorkItem", "parameters": [ { "name": "id", @@ -31134,7 +34989,7 @@ "WorkItems" ], "summary": "Move WorkItem to another section", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem move WorkItem to another section", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem move WorkItem to another section", "requestBody": { "content": { "application/json": { @@ -31228,7 +35083,7 @@ "WorkItems" ], "summary": "Set like to WorkItem", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem set like to WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem set like to WorkItem", "parameters": [ { "name": "id", @@ -31311,7 +35166,7 @@ "WorkItems" ], "summary": "Delete like from WorkItem", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem delete like from WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem delete like from WorkItem", "parameters": [ { "name": "id", @@ -31396,7 +35251,7 @@ "WorkItems" ], "summary": "Get likes of WorkItem", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem return likes of WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return likes of WorkItem", "parameters": [ { "name": "id", @@ -31491,7 +35346,7 @@ "WorkItems" ], "summary": "Get likes count of WorkItem", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem return likes count of WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return likes count of WorkItem", "parameters": [ { "name": "id", @@ -31584,7 +35439,7 @@ "WorkItems" ], "summary": "Get test results history of WorkItem", - "description": "\nUse case\n\nUser sets WorkItem identifier\n\nUser runs method execution\n\nSystem return test results history of WorkItem", + "description": "\r\nUse case\r\n\r\nUser sets WorkItem identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return test results history of WorkItem", "parameters": [ { "name": "id", @@ -31851,7 +35706,7 @@ "WorkItems" ], "summary": "Set WorkItem as actual", - "description": "\nUse case\n\nUser sets work item identifier\n\nUser runs method execution\n\nSystem set WorkItem as actual", + "description": "\r\nUse case\r\n\r\nUser sets work item identifier\r\n\r\nUser runs method execution\r\n\r\nSystem set WorkItem as actual", "parameters": [ { "name": "id", @@ -31952,7 +35807,7 @@ "WorkItems" ], "summary": "Transform CheckList to TestCase", - "description": "\nUse case\n\nUser sets checklist identifier\n\nUser runs method execution\n\nSystem transform CheckList to TestCase", + "description": "\r\nUse case\r\n\r\nUser sets checklist identifier\r\n\r\nUser runs method execution\r\n\r\nSystem transform CheckList to TestCase", "parameters": [ { "name": "id", @@ -32044,7 +35899,7 @@ "WorkItems" ], "summary": "Get SharedStep references in work items", - "description": "\nUse case\n\nUser sets SharedStep identifier\n\nUser runs method execution\n\nSystem return SharedStep references", + "description": "\r\nUse case\r\n\r\nUser sets SharedStep identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return SharedStep references", "parameters": [ { "name": "sharedStepId", @@ -32218,7 +36073,7 @@ "WorkItems" ], "summary": "Get SharedStep references in sections", - "description": "\nUse case\n\nUser sets SharedStep identifier\n\nUser runs method execution\n\nSystem return SharedStep references", + "description": "\r\nUse case\r\n\r\nUser sets SharedStep identifier\r\n\r\nUser runs method execution\r\n\r\nSystem return SharedStep references", "parameters": [ { "name": "sharedStepId", @@ -32580,7 +36435,7 @@ "WorkItemsComments" ], "summary": "Create WorkItem comment", - "description": "\nUse case\n\nUser sets comment properties (listed in request parameters)\n\nUser runs method execution\n\nSystem creates comment\n\nSystem returns comment model (listed in response parameters)", + "description": "\r\nUse case\r\n\r\nUser sets comment properties (listed in request parameters)\r\n\r\nUser runs method execution\r\n\r\nSystem creates comment\r\n\r\nSystem returns comment model (listed in response parameters)", "requestBody": { "content": { "application/json": { @@ -32758,7 +36613,7 @@ "WorkItemsComments" ], "summary": "Delete WorkItem comment", - "description": "\nUse case\n\nUser sets comment identifier\n\nUser runs method execution\n\nSystem delete comment\n\nSystem returns success status code", + "description": "\r\nUse case\r\n\r\nUser sets comment identifier\r\n\r\nUser runs method execution\r\n\r\nSystem delete comment\r\n\r\nSystem returns success status code", "parameters": [ { "name": "commentId", @@ -33253,7 +37108,7 @@ "items": { "$ref": "#/components/schemas/AttachmentPutModel" }, - "description": "/// \nSpecifies an attachment GUID. Multiple values can be sent.\n", + "description": "/// \r\nSpecifies an attachment GUID. Multiple values can be sent.\r\n", "nullable": true }, "parameters": { @@ -34566,14 +38421,14 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last autotest modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created autotest", @@ -34749,7 +38604,7 @@ "maximum": 1000, "minimum": 0, "type": "integer", - "description": " The retention period in days for test runs. After this period,\noutdated test runs may be archived based on project settings", + "description": " The retention period in days for test runs. After this period,\r\noutdated test runs may be archived based on project settings", "format": "int32", "default": 180 }, @@ -34757,7 +38612,7 @@ "maximum": 10000, "minimum": 0, "type": "integer", - "description": "Maximum number of active test runs to keep. When this limit is exceeded,\nolder test runs are automatically archived", + "description": "Maximum number of active test runs to keep. When this limit is exceeded,\r\nolder test runs are automatically archived", "format": "int32", "default": 500 } @@ -34831,12 +38686,12 @@ }, "testRunsRetentionPeriodDays": { "type": "integer", - "description": " The retention period in days for test runs. After this period,\noutdated test runs may be archived based on project settings", + "description": " The retention period in days for test runs. After this period,\r\noutdated test runs may be archived based on project settings", "format": "int32" }, "maxActiveTestRunsCount": { "type": "integer", - "description": "Maximum number of active test runs to keep. When this limit is exceeded,\nolder test runs are automatically archived", + "description": "Maximum number of active test runs to keep. When this limit is exceeded,\r\nolder test runs are automatically archived", "format": "int32" } }, @@ -35324,7 +39179,7 @@ }, "description": "Includes a nested step inside another step. The maximum nesting level is 15.", "nullable": true, - "example": "\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\n " + "example": "\r\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\r\n " } }, "additionalProperties": false @@ -35352,7 +39207,7 @@ }, "description": "Includes a nested step inside another step. The maximum nesting level is 15.", "nullable": true, - "example": "\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\n " + "example": "\r\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\r\n " } }, "additionalProperties": false @@ -35379,7 +39234,7 @@ }, "description": "Includes a nested step inside another step. The maximum nesting level is 15.", "nullable": true, - "example": "\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\n " + "example": "\r\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\r\n " } }, "additionalProperties": false @@ -35407,7 +39262,7 @@ }, "description": "Includes a nested step inside another step. The maximum nesting level is 15.", "nullable": true, - "example": "\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\n " + "example": "\r\n [{ \"title\": \"string\", \"description\": \"string\", \"steps\": [{ \"title\": \"string\", \"description\": \"string\", }], }]\r\n " } }, "additionalProperties": false @@ -35472,7 +39327,7 @@ "items": { "$ref": "#/components/schemas/AttachmentApiResult" }, - "description": "/// \nSpecifies an attachment GUID. Multiple values can be sent.\n", + "description": "/// \r\nSpecifies an attachment GUID. Multiple values can be sent.\r\n", "nullable": true }, "parameters": { @@ -35546,7 +39401,7 @@ "items": { "$ref": "#/components/schemas/AttachmentUpdateRequest" }, - "description": "/// \nSpecifies an attachment GUID. Multiple values can be sent.\n", + "description": "/// \r\nSpecifies an attachment GUID. Multiple values can be sent.\r\n", "nullable": true }, "parameters": { @@ -36368,14 +40223,14 @@ "title": "Date and time of configuration creation", "type": "string", "format": "date-time", - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last configuration modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created configuration", @@ -36636,7 +40491,7 @@ "properties": { "projectId": { "type": "string", - "description": "Project unique identifier\n \nThis property is to link test run with a project", + "description": "Project unique identifier\r\n \r\nThis property is to link test run with a project", "format": "uuid" }, "name": { @@ -37254,6 +41109,49 @@ }, "additionalProperties": false }, + "CreateUserApiModel": { + "required": [ + "displayName", + "email", + "firstName", + "lastName", + "userName" + ], + "type": "object", + "properties": { + "userName": { + "minLength": 1, + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "password": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "format": "email" + }, + "providerId": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "externalId": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "CreateWorkItemApiModel": { "required": [ "duration", @@ -37513,7 +41411,7 @@ "items": { "$ref": "#/components/schemas/CustomAttributeOptionApiResult" }, - "description": "Collection of the attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only" + "description": "Collection of the attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only" }, "type": { "allOf": [ @@ -37552,7 +41450,7 @@ "items": { "type": "string" }, - "description": "Collection of the attribute targets\n\n\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" + "description": "Collection of the attribute targets\r\n\r\n\r\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" } }, "additionalProperties": false @@ -37662,14 +41560,14 @@ "items": { "type": "string" }, - "description": "Collection of the attribute targets\n\n\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" + "description": "Collection of the attribute targets\r\n\r\n\r\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeOptionModel" }, - "description": "Collection of the attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only" + "description": "Collection of the attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only" }, "type": { "allOf": [ @@ -37803,7 +41701,7 @@ "items": { "$ref": "#/components/schemas/CustomAttributeOptionPostModel" }, - "description": "Collection of attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only", + "description": "Collection of attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only", "nullable": true }, "type": { @@ -37858,7 +41756,7 @@ "items": { "$ref": "#/components/schemas/CustomAttributeOptionModel" }, - "description": "Collection of the attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only", + "description": "Collection of the attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only", "nullable": true }, "type": { @@ -37986,14 +41884,14 @@ "items": { "type": "string" }, - "description": "Collection of the attribute targets\n\n\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" + "description": "Collection of the attribute targets\r\n\r\n\r\nDefines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeOptionModel" }, - "description": "Collection of the attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only" + "description": "Collection of the attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only" }, "type": { "allOf": [ @@ -38254,20 +42152,6 @@ ], "type": "string" }, - "DemoProjectApiResult": { - "required": [ - "jobId" - ], - "type": "object", - "properties": { - "jobId": { - "type": "string", - "description": "Job ID", - "format": "uuid" - } - }, - "additionalProperties": false - }, "DetailedProjectApiResult": { "required": [ "createdById", @@ -39733,7 +43617,7 @@ "items": { "$ref": "#/components/schemas/CustomAttributeOptionPostModel" }, - "description": "Collection of attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only", + "description": "Collection of attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only", "nullable": true }, "type": { @@ -39765,7 +43649,7 @@ "items": { "$ref": "#/components/schemas/CustomAttributeOptionModel" }, - "description": "Collection of attribute options\n\n\nAvailable for attributes of type `options` and `multiple options` only", + "description": "Collection of attribute options\r\n\r\n\r\nAvailable for attributes of type `options` and `multiple options` only", "nullable": true }, "isEnabled": { @@ -42186,6 +46070,49 @@ }, "additionalProperties": false }, + "RoleApiModel": { + "required": [ + "id", + "isSystem", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "isSystem": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "RoleApiModelApiCollection": { + "required": [ + "data", + "totalCount" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoleApiModel" + }, + "description": "Items" + }, + "totalCount": { + "type": "integer", + "description": "Total count", + "format": "int64" + } + }, + "additionalProperties": false + }, "SearchCustomAttributeTemplateGetModel": { "required": [ "customAttributeModels", @@ -42456,14 +46383,14 @@ "title": "Date and time of section creation", "type": "string", "format": "date-time", - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last section modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created section", @@ -42715,14 +46642,14 @@ "title": "Date and time of section creation", "type": "string", "format": "date-time", - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last section modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created section", @@ -42917,14 +46844,14 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last workitem modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "state": { "title": "WorkItem state", @@ -43029,14 +46956,14 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last section modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "isDeleted": { "title": "Flag that defines if section is archived", @@ -43167,7 +47094,7 @@ "items": { "$ref": "#/components/schemas/WorkItemTypeModel" }, - "description": "Collection of types of work item\n\nAllowed values: `TestCases`, `CheckLists`, `SharedSteps`", + "description": "Collection of types of work item\r\n\r\nAllowed values: `TestCases`, `CheckLists`, `SharedSteps`", "nullable": true }, "createdDate": { @@ -44144,7 +48071,7 @@ "description": "Set when test plan is starter (status changed to: In Progress)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "completedOn": { "title": "Date and time of test plan end", @@ -44152,21 +48079,21 @@ "description": "set when test plan status is completed (status changed to: Completed)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdDate": { "title": "Date and time of test plan creation", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last test plan modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created test plan ", @@ -44198,7 +48125,7 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "id": { "title": "Test plan unique internal identifier", @@ -44233,7 +48160,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "endDate": { "title": "Date and time of test plan end", @@ -44241,7 +48168,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "description": { "title": "Test plan description", @@ -45402,7 +49329,7 @@ "description": "Set when test plan is starter (status changed to: In Progress)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "completedOn": { "title": "Date and time of test plan end", @@ -45410,21 +49337,21 @@ "description": "set when test plan status is completed (status changed to: Completed)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdDate": { "title": "Date and time of test plan creation", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last test plan modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created test plan ", @@ -45456,7 +49383,7 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "id": { "title": "Test plan unique internal identifier", @@ -45491,7 +49418,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "endDate": { "title": "Date and time of test plan end", @@ -45499,7 +49426,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "description": { "title": "Test plan description", @@ -45581,7 +49508,7 @@ "description": "Set when test plan is starter (status changed to: In Progress)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "completedOn": { "title": "Date and time of test plan end", @@ -45589,21 +49516,21 @@ "description": "set when test plan status is completed (status changed to: Completed)", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdDate": { "title": "Date and time of test plan creation", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last test plan modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created test plan ", @@ -45635,7 +49562,7 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "id": { "title": "Test plan unique internal identifier", @@ -45670,7 +49597,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "endDate": { "title": "Date and time of test plan end", @@ -45678,7 +49605,7 @@ "description": "Used for analytics", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "description": { "title": "Test plan description", @@ -45879,7 +49806,7 @@ }, "status": { "type": "string", - "description": "Test point status\n\nApplies one of these values: Blocked, NoResults, Failed, Passed", + "description": "Test point status\r\n\r\nApplies one of these values: Blocked, NoResults, Failed, Passed", "nullable": true, "example": "NoResult" }, @@ -46521,7 +50448,7 @@ }, "status": { "type": "string", - "description": "Test point status\n\nApplies one of these values: Blocked, NoResults, Failed, Passed", + "description": "Test point status\r\n\r\nApplies one of these values: Blocked, NoResults, Failed, Passed", "nullable": true, "example": "NoResult", "deprecated": true @@ -46598,7 +50525,7 @@ }, "status": { "type": "string", - "description": "Test point status\n\nApplies one of these values: Blocked, NoResults, Failed, Passed", + "description": "Test point status\r\n\r\nApplies one of these values: Blocked, NoResults, Failed, Passed", "nullable": true, "example": "NoResult" }, @@ -47337,7 +51264,7 @@ }, "userId": { "type": "string", - "description": "Internal identifier of user who stopped test run related to the test result or user who created the test result\n \nIf test run was stopped, this property equals identifier of user who stopped it.\nOtherwise, the property equals identifier of user who created the test result", + "description": "Internal identifier of user who stopped test run related to the test result or user who created the test result\r\n \r\nIf test run was stopped, this property equals identifier of user who stopped it.\r\nOtherwise, the property equals identifier of user who created the test result", "format": "uuid" }, "testRunId": { @@ -47375,7 +51302,7 @@ }, "configurationName": { "type": "string", - "description": "Configuration name of test point related to the test result or from test result itself\n \nIf test point related to the test result has configuration, this property will be equal to the test point configuration name.\nOtherwise, this property will be equal to the test result configuration name", + "description": "Configuration name of test point related to the test result or from test result itself\r\n \r\nIf test point related to the test result has configuration, this property will be equal to the test point configuration name.\r\nOtherwise, this property will be equal to the test result configuration name", "nullable": true }, "isAutomated": { @@ -47384,7 +51311,7 @@ }, "outcome": { "type": "string", - "description": "Outcome from test result with max modified date or from first created test result\n \nProperty can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped.\n \nIf any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the\nworst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the\ntest run.", + "description": "Outcome from test result with max modified date or from first created test result\r\n \r\nProperty can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped.\r\n \r\nIf any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the\r\nworst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the\r\ntest run.", "nullable": true }, "status": { @@ -47397,7 +51324,7 @@ }, "comment": { "type": "string", - "description": "Test result comment\n \nIf any test result related to the test run is linked with autotest, comment will have default value.\nOtherwise, the comment equals to the comment of first created test result in the test run", + "description": "Test result comment\r\n \r\nIf any test result related to the test run is linked with autotest, comment will have default value.\r\nOtherwise, the comment equals to the comment of first created test result in the test run", "nullable": true }, "links": { @@ -47405,7 +51332,7 @@ "items": { "$ref": "#/components/schemas/LinkApiResult" }, - "description": "Test result links\n \nIf any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result.\nOtherwise, the links equals to the links of first created test result in the test run.", + "description": "Test result links\r\n \r\nIf any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result.\r\nOtherwise, the links equals to the links of first created test result in the test run.", "nullable": true }, "startedOn": { @@ -47442,7 +51369,7 @@ "items": { "$ref": "#/components/schemas/AttachmentApiResult" }, - "description": "Attachments related to the test result\n \nIf any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified\ntest result. Otherwise, the attachments equals to the attachments of first created test result in the test run.", + "description": "Attachments related to the test result\r\n \r\nIf any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified\r\ntest result. Otherwise, the attachments equals to the attachments of first created test result in the test run.", "nullable": true }, "workItemVersionId": { @@ -48163,14 +52090,14 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "completedOn": { "title": "End date time from test result or from test run (if test run new state is In progress, Stopped or Completed)", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "runByUserId": { "title": "Unique identifier of user which run test result", @@ -48307,14 +52234,14 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "completedOn": { "title": "End date time from test result or from test run (if test run new state is In progress, Stopped or Completed)", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "runByUserId": { "title": "Unique identifier of user which run test result", @@ -49535,7 +53462,7 @@ }, "launchSource": { "type": "string", - "description": "Test run launch source\n \nOnce launch source is specified it cannot be updated.", + "description": "Test run launch source\r\n \r\nOnce launch source is specified it cannot be updated.", "nullable": true }, "startedOn": { @@ -49569,12 +53496,12 @@ }, "projectId": { "type": "string", - "description": "Project unique identifier\n \nThis property is used to link test run with project.", + "description": "Project unique identifier\r\n \r\nThis property is used to link test run with project.", "format": "uuid" }, "testPlanId": { "type": "string", - "description": "Test plan unique identifier\n \nThis property is used to link test run with test plan.", + "description": "Test plan unique identifier\r\n \r\nThis property is used to link test run with test plan.", "format": "uuid", "nullable": true }, @@ -50319,7 +54246,7 @@ "items": { "$ref": "#/components/schemas/WorkItemTypeModel" }, - "description": "Collection of types of work item\n\nAllowed values: `TestCases`, `CheckLists`, `SharedSteps`", + "description": "Collection of types of work item\r\n\r\nAllowed values: `TestCases`, `CheckLists`, `SharedSteps`", "nullable": true }, "nameOrId": { @@ -50591,7 +54518,7 @@ }, "launchSource": { "type": "string", - "description": "Test run launch source\n \nOnce launch source is specified it cannot be updated", + "description": "Test run launch source\r\n \r\nOnce launch source is specified it cannot be updated", "nullable": true }, "attachments": { @@ -51319,6 +55246,46 @@ }, "additionalProperties": false }, + "UserApiModel": { + "required": [ + "displayName", + "email", + "firstName", + "id", + "lastName", + "userName" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "userName": { + "minLength": 1, + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "providerId": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "additionalProperties": false + }, "UserCustomNameValidationResponse": { "required": [ "exists" @@ -53968,14 +57935,14 @@ "title": "Date and time of workitem creation", "type": "string", "format": "date-time", - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedDate": { "title": "Date and time of last workitem modification", "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "createdById": { "title": "Unique identifier of user who created workitem", @@ -55078,7 +59045,7 @@ "type": "string", "format": "date-time", "nullable": true, - "example": "2026-01-27T05:43:09.5774479+00:00" + "example": "2026-01-27T08:43:09.5774479+03:00" }, "modifiedById": { "title": "Unique identifier of user who applied workitem version modification", @@ -55499,10 +59466,10 @@ "name": "Authorization", "in": "header" }, - "Identity.Application": { + "Cookies": { "type": "apiKey", "description": "Session-based authorization via Web UI. If you are already logged in, the browser will attach the cookie automatically — no need to fill in the Value field.", - "name": "backoffice", + "name": "session", "in": "cookie" } } @@ -55510,7 +59477,7 @@ "security": [ { "PrivateToken": [ ], - "Identity.Application": [ ] + "Cookies": [ ] } ], "tags": [ @@ -55589,6 +59556,9 @@ { "name": "Projects" }, + { + "name": "Roles" + }, { "name": "Sections" }, @@ -55613,6 +59583,9 @@ { "name": "TestSuites" }, + { + "name": "UserRoleAssignments" + }, { "name": "Users" }, diff --git a/README.md b/README.md index 9077a4d9..bb8159c9 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ | 5.5.0 | 7.2.0.post550 | | 5.6.0 | 7.4.0.post560 | | 5.7.0 | 7.5.5.post570 | +| 5.8.0 | 7.6.0.post580 | | Cloud | 7.5.5 + | 1. For current versions, see the releases tab. @@ -83,6 +84,7 @@ All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- +*AIServicesAPIApi* | [**api_v2_external_services_id_ai_models_post**](docs/AIServicesAPIApi.md#api_v2_external_services_id_ai_models_post) | **POST** /api/v2/external-services/{id}/ai/models | Ask for models with inquiry filter, cached *AttachmentsApi* | [**api_v2_attachments_id_delete**](docs/AttachmentsApi.md#api_v2_attachments_id_delete) | **DELETE** /api/v2/attachments/{id} | Delete attachment file *AttachmentsApi* | [**api_v2_attachments_id_get**](docs/AttachmentsApi.md#api_v2_attachments_id_get) | **GET** /api/v2/attachments/{id} | Download attachment file *AttachmentsApi* | [**api_v2_attachments_id_metadata_get**](docs/AttachmentsApi.md#api_v2_attachments_id_metadata_get) | **GET** /api/v2/attachments/{id}/metadata | Get attachment metadata @@ -142,6 +144,21 @@ Class | Method | HTTP request | Description *CustomAttributesApi* | [**api_v2_custom_attributes_id_get**](docs/CustomAttributesApi.md#api_v2_custom_attributes_id_get) | **GET** /api/v2/customAttributes/{id} | Get attribute *CustomAttributesApi* | [**api_v2_custom_attributes_search_post**](docs/CustomAttributesApi.md#api_v2_custom_attributes_search_post) | **POST** /api/v2/customAttributes/search | Search for attributes *ExternalIssuesApi* | [**api_v2_external_issues_suggestions_post**](docs/ExternalIssuesApi.md#api_v2_external_issues_suggestions_post) | **POST** /api/v2/external-issues/suggestions | Returns list of suggestions from available external issues +*ExternalServicesApi* | [**api_v2_external_services_metadata_get**](docs/ExternalServicesApi.md#api_v2_external_services_metadata_get) | **GET** /api/v2/external-services/metadata | Retrieves the metadata for all available external services +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_grouping_search_post**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_grouping_search_post) | **POST** /api/v2/autotests/failure-categories/grouping-search | Get failure categories with support for filtering, sorting and grouping +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_id_delete**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_id_delete) | **DELETE** /api/v2/autotests/failure-categories/{id} | Delete failure category +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_id_get**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_id_get) | **GET** /api/v2/autotests/failure-categories/{id} | Get failure category by ID +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_name_name_exists_get**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_name_name_exists_get) | **GET** /api/v2/autotests/failure-categories/name/{name}/exists | Check failure category with the specified name already exists +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_post**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_post) | **POST** /api/v2/autotests/failure-categories | Create failure category +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_put**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_put) | **PUT** /api/v2/autotests/failure-categories | Update failure category +*FailureCategoriesApi* | [**api_v2_autotests_failure_categories_search_post**](docs/FailureCategoriesApi.md#api_v2_autotests_failure_categories_search_post) | **POST** /api/v2/autotests/failure-categories/search | +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_grouping_search_post**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_grouping_search_post) | **POST** /api/v2/autotests/resultReasons/grouping-search | Get failure categories with support for filtering, sorting and grouping +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_id_delete**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_id_delete) | **DELETE** /api/v2/autotests/resultReasons/{id} | Delete failure category +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_id_get**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_id_get) | **GET** /api/v2/autotests/resultReasons/{id} | Get failure category by ID +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_name_name_exists_get**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_name_name_exists_get) | **GET** /api/v2/autotests/resultReasons/name/{name}/exists | Check failure category with the specified name already exists +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_post**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_post) | **POST** /api/v2/autotests/resultReasons | Create failure category +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_put**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_put) | **PUT** /api/v2/autotests/resultReasons | Update failure category +*FailureCategoriesApi* | [**api_v2_autotests_result_reasons_search_post**](docs/FailureCategoriesApi.md#api_v2_autotests_result_reasons_search_post) | **POST** /api/v2/autotests/resultReasons/search | *NotificationsApi* | [**api_v2_notifications_count_get**](docs/NotificationsApi.md#api_v2_notifications_count_get) | **GET** /api/v2/notifications/count | Get unread Notifications total in last 7 days *NotificationsApi* | [**api_v2_notifications_get**](docs/NotificationsApi.md#api_v2_notifications_get) | **GET** /api/v2/notifications | Get all Notifications for current User *NotificationsApi* | [**api_v2_notifications_id_read_post**](docs/NotificationsApi.md#api_v2_notifications_id_read_post) | **POST** /api/v2/notifications/{id}/read | Set Notification as read @@ -173,6 +190,17 @@ Class | Method | HTTP request | Description *ProjectAttributesApi* | [**search_attributes_in_project**](docs/ProjectAttributesApi.md#search_attributes_in_project) | **POST** /api/v2/projects/{projectId}/attributes/search | Search for attributes used in the project *ProjectAttributesApi* | [**update_projects_attribute**](docs/ProjectAttributesApi.md#update_projects_attribute) | **PUT** /api/v2/projects/{projectId}/attributes | Edit attribute of the project *ProjectConfigurationsApi* | [**get_configurations_by_project_id**](docs/ProjectConfigurationsApi.md#get_configurations_by_project_id) | **GET** /api/v2/projects/{projectId}/configurations | Get project configurations +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_external_service_id_delete**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_delete) | **DELETE** /api/v2/projects/{id}/external-services/{externalServiceId} | Disable an external service +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_external_service_id_get**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_get) | **GET** /api/v2/projects/{id}/external-services/{externalServiceId} | Retrieves settings of an external service +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_external_service_id_patch**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_patch) | **PATCH** /api/v2/projects/{id}/external-services/{externalServiceId} | Replaces one active external service with another +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_external_service_id_put**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_put) | **PUT** /api/v2/projects/{id}/external-services/{externalServiceId} | Enable an external service +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_get**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_get) | **GET** /api/v2/projects/{id}/external-services | Retrieves information about external services, including their integration status (enabled or not) +*ProjectExternalServicesApi* | [**api_v2_projects_id_external_services_issues_search_post**](docs/ProjectExternalServicesApi.md#api_v2_projects_id_external_services_issues_search_post) | **POST** /api/v2/projects/{id}/external-services/issues/search | Searches for external issues using enabled external services in project +*ProjectFailureCategoriesApi* | [**api_v2_projects_project_id_autotests_failure_categories_grouping_search_post**](docs/ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_grouping_search_post) | **POST** /api/v2/projects/{projectId}/autotests/failure-categories/grouping-search | Get failure categories with support for filtering, sorting and grouping +*ProjectFailureCategoriesApi* | [**api_v2_projects_project_id_autotests_failure_categories_id_delete**](docs/ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_id_delete) | **DELETE** /api/v2/projects/{projectId}/autotests/failure-categories/{id} | Delete failure category +*ProjectFailureCategoriesApi* | [**api_v2_projects_project_id_autotests_failure_categories_id_get**](docs/ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_id_get) | **GET** /api/v2/projects/{projectId}/autotests/failure-categories/{id} | Get failure category by ID +*ProjectFailureCategoriesApi* | [**api_v2_projects_project_id_autotests_failure_categories_post**](docs/ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_post) | **POST** /api/v2/projects/{projectId}/autotests/failure-categories | Create failure category +*ProjectFailureCategoriesApi* | [**api_v2_projects_project_id_autotests_failure_categories_put**](docs/ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_put) | **PUT** /api/v2/projects/{projectId}/autotests/failure-categories | Update failure category *ProjectSectionsApi* | [**get_sections_by_project_id**](docs/ProjectSectionsApi.md#get_sections_by_project_id) | **GET** /api/v2/projects/{projectId}/sections | Get project sections *ProjectSettingsApi* | [**api_v2_projects_project_id_settings_autotests_post**](docs/ProjectSettingsApi.md#api_v2_projects_project_id_settings_autotests_post) | **POST** /api/v2/projects/{projectId}/settings/autotests | Set autotest project settings. *ProjectSettingsApi* | [**get_autotest_project_settings**](docs/ProjectSettingsApi.md#get_autotest_project_settings) | **GET** /api/v2/projects/{projectId}/settings/autotests | Get autotest project settings. @@ -181,14 +209,19 @@ Class | Method | HTTP request | Description *ProjectTestPlanAttributesApi* | [**get_custom_attribute_test_plan_project_relations**](docs/ProjectTestPlanAttributesApi.md#get_custom_attribute_test_plan_project_relations) | **GET** /api/v2/projects/{projectId}/testPlans/attributes | Get project's test plan attributes *ProjectTestPlanAttributesApi* | [**search_test_plan_attributes_in_project**](docs/ProjectTestPlanAttributesApi.md#search_test_plan_attributes_in_project) | **POST** /api/v2/projects/{projectId}/testPlans/attributes/search | Search for attributes used in the project test plans *ProjectTestPlanAttributesApi* | [**update_custom_attribute_test_plan_project_relations**](docs/ProjectTestPlanAttributesApi.md#update_custom_attribute_test_plan_project_relations) | **PUT** /api/v2/projects/{projectId}/testPlans/attributes | Update attribute of project's test plans +*ProjectTestPlanTestPointsApi* | [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post**](docs/ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/analytics | Get test points analytics. *ProjectTestPlanTestPointsApi* | [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post**](docs/ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun | Rerun autotests. *ProjectTestPlanTestPointsApi* | [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post**](docs/ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run | Run autotests. +*ProjectTestPlanTestPointsApi* | [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post**](docs/ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/grouping-search | Search test points in test plan. +*ProjectTestPlanTestPointsApi* | [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post**](docs/ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/testers | Distribute test points between the users. *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_analytics_get**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_analytics_get) | **GET** /api/v2/projects/{projectId}/testPlans/analytics | Get TestPlans analytics *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_delete_bulk_post**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_delete_bulk_post) | **POST** /api/v2/projects/{projectId}/testPlans/delete/bulk | Delete multiple test plans *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_name_exists_get**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_name_exists_get) | **GET** /api/v2/projects/{projectId}/testPlans/{name}/exists | Checks if TestPlan exists with the specified name exists for the project *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_purge_bulk_post**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_purge_bulk_post) | **POST** /api/v2/projects/{projectId}/testPlans/purge/bulk | Permanently delete multiple archived test plans *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_restore_bulk_post**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_restore_bulk_post) | **POST** /api/v2/projects/{projectId}/testPlans/restore/bulk | Restore multiple test plans *ProjectTestPlansApi* | [**api_v2_projects_project_id_test_plans_search_post**](docs/ProjectTestPlansApi.md#api_v2_projects_project_id_test_plans_search_post) | **POST** /api/v2/projects/{projectId}/testPlans/search | Get Project TestPlans with analytics +*ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_previews_bulk_post**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_previews_bulk_post) | **POST** /api/v2/projects/{projectId}/work-items/previews/bulk | +*ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_previews_post**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_previews_post) | **POST** /api/v2/projects/{projectId}/work-items/previews | *ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_search_grouped_post**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_grouped_post) | **POST** /api/v2/projects/{projectId}/workItems/search/grouped | Search for work items and group results by attribute *ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_search_id_post**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_id_post) | **POST** /api/v2/projects/{projectId}/workItems/search/id | Search for work items and extract IDs only *ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_search_post**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_post) | **POST** /api/v2/projects/{projectId}/workItems/search | Search for work items @@ -196,7 +229,6 @@ Class | Method | HTTP request | Description *ProjectWorkItemsApi* | [**api_v2_projects_project_id_work_items_tags_get**](docs/ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_tags_get) | **GET** /api/v2/projects/{projectId}/workItems/tags | Get WorkItems Tags *ProjectWorkItemsApi* | [**get_work_items_by_project_id**](docs/ProjectWorkItemsApi.md#get_work_items_by_project_id) | **GET** /api/v2/projects/{projectId}/workItems | Get project work items *ProjectsApi* | [**add_global_attributes_to_project**](docs/ProjectsApi.md#add_global_attributes_to_project) | **POST** /api/v2/projects/{id}/globalAttributes | Add global attributes to project -*ProjectsApi* | [**api_v2_projects_demo_post**](docs/ProjectsApi.md#api_v2_projects_demo_post) | **POST** /api/v2/projects/demo | *ProjectsApi* | [**api_v2_projects_id_delete**](docs/ProjectsApi.md#api_v2_projects_id_delete) | **DELETE** /api/v2/projects/{id} | Archive project *ProjectsApi* | [**api_v2_projects_id_failure_classes_get**](docs/ProjectsApi.md#api_v2_projects_id_failure_classes_get) | **GET** /api/v2/projects/{id}/failureClasses | Get failure classes *ProjectsApi* | [**api_v2_projects_id_favorite_put**](docs/ProjectsApi.md#api_v2_projects_id_favorite_put) | **PUT** /api/v2/projects/{id}/favorite | Mark Project as favorite @@ -220,6 +252,7 @@ Class | Method | HTTP request | Description *ProjectsApi* | [**get_test_plans_by_project_id**](docs/ProjectsApi.md#get_test_plans_by_project_id) | **GET** /api/v2/projects/{id}/testPlans | Get project test plans *ProjectsApi* | [**get_test_runs_by_project_id**](docs/ProjectsApi.md#get_test_runs_by_project_id) | **GET** /api/v2/projects/{id}/testRuns | Get project test runs *ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /api/v2/projects | Update project +*RolesApi* | [**api_v2_roles_get**](docs/RolesApi.md#api_v2_roles_get) | **GET** /api/v2/roles | *SectionsApi* | [**api_v2_sections_id_patch**](docs/SectionsApi.md#api_v2_sections_id_patch) | **PATCH** /api/v2/sections/{id} | Patch section *SectionsApi* | [**create_section**](docs/SectionsApi.md#create_section) | **POST** /api/v2/sections | Create section *SectionsApi* | [**delete_section**](docs/SectionsApi.md#delete_section) | **DELETE** /api/v2/sections/{id} | Delete section @@ -330,7 +363,14 @@ Class | Method | HTTP request | Description *TestSuitesApi* | [**get_test_suite_by_id**](docs/TestSuitesApi.md#get_test_suite_by_id) | **GET** /api/v2/testSuites/{id} | Get TestSuite by Id *TestSuitesApi* | [**search_work_items**](docs/TestSuitesApi.md#search_work_items) | **POST** /api/v2/testSuites/{id}/workItems/search | Search WorkItems *TestSuitesApi* | [**set_configurations_by_test_suite_id**](docs/TestSuitesApi.md#set_configurations_by_test_suite_id) | **POST** /api/v2/testSuites/{id}/configurations | Set Configurations By TestSuite Id +*UserRoleAssignmentsApi* | [**api_v2_users_user_id_roles_role_id_delete**](docs/UserRoleAssignmentsApi.md#api_v2_users_user_id_roles_role_id_delete) | **DELETE** /api/v2/users/{userId}/roles/{roleId} | +*UserRoleAssignmentsApi* | [**api_v2_users_user_id_roles_role_id_post**](docs/UserRoleAssignmentsApi.md#api_v2_users_user_id_roles_role_id_post) | **POST** /api/v2/users/{userId}/roles/{roleId} | +*UserStoragesApi* | [**api_v2_user_storages_resource_get**](docs/UserStoragesApi.md#api_v2_user_storages_resource_get) | **GET** /api/v2/user-storages/{resource} | +*UserStoragesApi* | [**api_v2_user_storages_resource_post**](docs/UserStoragesApi.md#api_v2_user_storages_resource_post) | **POST** /api/v2/user-storages/{resource} | *UsersApi* | [**api_v2_users_exists_get**](docs/UsersApi.md#api_v2_users_exists_get) | **GET** /api/v2/users/exists | +*UsersApi* | [**api_v2_users_post**](docs/UsersApi.md#api_v2_users_post) | **POST** /api/v2/users | +*UsersApi* | [**api_v2_users_user_id_delete**](docs/UsersApi.md#api_v2_users_user_id_delete) | **DELETE** /api/v2/users/{userId} | +*UsersApi* | [**api_v2_users_user_id_get**](docs/UsersApi.md#api_v2_users_user_id_get) | **GET** /api/v2/users/{userId} | *WebhooksApi* | [**api_v2_webhooks_delete**](docs/WebhooksApi.md#api_v2_webhooks_delete) | **DELETE** /api/v2/webhooks | *WebhooksApi* | [**api_v2_webhooks_get**](docs/WebhooksApi.md#api_v2_webhooks_get) | **GET** /api/v2/webhooks | Get all webhooks *WebhooksApi* | [**api_v2_webhooks_id_delete**](docs/WebhooksApi.md#api_v2_webhooks_id_delete) | **DELETE** /api/v2/webhooks/{id} | Delete webhook by ID @@ -400,6 +440,10 @@ Class | Method | HTTP request | Description - [ApiV2AutoTestsFlakyBulkPostRequest](docs/ApiV2AutoTestsFlakyBulkPostRequest.md) - [ApiV2AutoTestsIdTestResultsSearchPostRequest](docs/ApiV2AutoTestsIdTestResultsSearchPostRequest.md) - [ApiV2AutoTestsSearchPostRequest](docs/ApiV2AutoTestsSearchPostRequest.md) + - [ApiV2AutotestsResultReasonsGroupingSearchPostRequest](docs/ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md) + - [ApiV2AutotestsResultReasonsPostRequest](docs/ApiV2AutotestsResultReasonsPostRequest.md) + - [ApiV2AutotestsResultReasonsPutRequest](docs/ApiV2AutotestsResultReasonsPutRequest.md) + - [ApiV2AutotestsResultReasonsSearchPostRequest](docs/ApiV2AutotestsResultReasonsSearchPostRequest.md) - [ApiV2BackgroundJobsSearchPostRequest](docs/ApiV2BackgroundJobsSearchPostRequest.md) - [ApiV2ConfigurationsCreateByParametersPostRequest](docs/ApiV2ConfigurationsCreateByParametersPostRequest.md) - [ApiV2ConfigurationsDeleteBulkPostRequest](docs/ApiV2ConfigurationsDeleteBulkPostRequest.md) @@ -413,15 +457,26 @@ Class | Method | HTTP request | Description - [ApiV2CustomAttributesTemplatesPutRequest](docs/ApiV2CustomAttributesTemplatesPutRequest.md) - [ApiV2CustomAttributesTemplatesSearchPostRequest](docs/ApiV2CustomAttributesTemplatesSearchPostRequest.md) - [ApiV2ExternalIssuesSuggestionsPostRequest](docs/ApiV2ExternalIssuesSuggestionsPostRequest.md) + - [ApiV2ExternalServicesIdAiModelsPostRequest](docs/ApiV2ExternalServicesIdAiModelsPostRequest.md) - [ApiV2NotificationsSearchPostRequest](docs/ApiV2NotificationsSearchPostRequest.md) - [ApiV2ParametersSearchGroupsPostRequest](docs/ApiV2ParametersSearchGroupsPostRequest.md) - [ApiV2ParametersSearchPostRequest](docs/ApiV2ParametersSearchPostRequest.md) + - [ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest](docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md) + - [ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest](docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md) + - [ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest](docs/ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md) - [ApiV2ProjectsProjectIdAttributesTemplatesSearchPostRequest](docs/ApiV2ProjectsProjectIdAttributesTemplatesSearchPostRequest.md) + - [ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest](docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md) + - [ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest](docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md) - [ApiV2ProjectsProjectIdSettingsAutotestsPostRequest](docs/ApiV2ProjectsProjectIdSettingsAutotestsPostRequest.md) - [ApiV2ProjectsProjectIdTestPlansDeleteBulkPostRequest](docs/ApiV2ProjectsProjectIdTestPlansDeleteBulkPostRequest.md) - [ApiV2ProjectsProjectIdTestPlansSearchPostRequest](docs/ApiV2ProjectsProjectIdTestPlansSearchPostRequest.md) + - [ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest](docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md) - [ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRerunPostRequest](docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRerunPostRequest.md) - [ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRunPostRequest](docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRunPostRequest.md) + - [ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest](docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md) + - [ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest](docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md) + - [ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest](docs/ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md) + - [ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest](docs/ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md) - [ApiV2ProjectsProjectIdWorkItemsSearchGroupedPostRequest](docs/ApiV2ProjectsProjectIdWorkItemsSearchGroupedPostRequest.md) - [ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest](docs/ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest.md) - [ApiV2ProjectsProjectIdWorkItemsSearchPostRequest](docs/ApiV2ProjectsProjectIdWorkItemsSearchPostRequest.md) @@ -450,6 +505,7 @@ Class | Method | HTTP request | Description - [ApiV2TestStatusesSearchPostRequest](docs/ApiV2TestStatusesSearchPostRequest.md) - [ApiV2TestSuitesPostRequest](docs/ApiV2TestSuitesPostRequest.md) - [ApiV2TestSuitesPutRequest](docs/ApiV2TestSuitesPutRequest.md) + - [ApiV2UsersPostRequest](docs/ApiV2UsersPostRequest.md) - [ApiV2WebhooksDeleteRequest](docs/ApiV2WebhooksDeleteRequest.md) - [ApiV2WebhooksPostRequest](docs/ApiV2WebhooksPostRequest.md) - [ApiV2WebhooksPutRequest](docs/ApiV2WebhooksPutRequest.md) @@ -599,6 +655,7 @@ Class | Method | HTTP request | Description - [CreateTestRunAndFillByConfigurationsApiModel](docs/CreateTestRunAndFillByConfigurationsApiModel.md) - [CreateTestRunAndFillByWorkItemsApiModel](docs/CreateTestRunAndFillByWorkItemsApiModel.md) - [CreateTestStatusApiModel](docs/CreateTestStatusApiModel.md) + - [CreateUserApiModel](docs/CreateUserApiModel.md) - [CreateWorkItemApiModel](docs/CreateWorkItemApiModel.md) - [CreateWorkItemCommentApiModel](docs/CreateWorkItemCommentApiModel.md) - [CreateWorkItemPreviewsApiModel](docs/CreateWorkItemPreviewsApiModel.md) @@ -626,7 +683,6 @@ Class | Method | HTTP request | Description - [DateTimeRangeSelectorModel](docs/DateTimeRangeSelectorModel.md) - [DefectApiModel](docs/DefectApiModel.md) - [DeletionState](docs/DeletionState.md) - - [DemoProjectApiResult](docs/DemoProjectApiResult.md) - [DetailedProjectApiResult](docs/DetailedProjectApiResult.md) - [EnableProjectExternalServiceApiModel](docs/EnableProjectExternalServiceApiModel.md) - [ExternalFormAllowedValueModel](docs/ExternalFormAllowedValueModel.md) @@ -782,6 +838,8 @@ Class | Method | HTTP request | Description - [RerunTestResultApiResult](docs/RerunTestResultApiResult.md) - [RerunTestResultApiResultStatus](docs/RerunTestResultApiResultStatus.md) - [RerunsApiResult](docs/RerunsApiResult.md) + - [RoleApiModel](docs/RoleApiModel.md) + - [RoleApiModelApiCollection](docs/RoleApiModelApiCollection.md) - [SearchAttributesInProjectRequest](docs/SearchAttributesInProjectRequest.md) - [SearchCustomAttributeTemplateGetModel](docs/SearchCustomAttributeTemplateGetModel.md) - [SearchExternalIssuesApiModel](docs/SearchExternalIssuesApiModel.md) @@ -1028,6 +1086,7 @@ Class | Method | HTTP request | Description - [UpdateWorkItemApiModel](docs/UpdateWorkItemApiModel.md) - [UpdateWorkItemCommentApiModel](docs/UpdateWorkItemCommentApiModel.md) - [UpdateWorkflowApiModel](docs/UpdateWorkflowApiModel.md) + - [UserApiModel](docs/UserApiModel.md) - [UserCustomNameValidationResponse](docs/UserCustomNameValidationResponse.md) - [UserNameApiResult](docs/UserNameApiResult.md) - [ValidationProblemDetails](docs/ValidationProblemDetails.md) @@ -1162,11 +1221,11 @@ Authentication schemes defined for the API: - **API key parameter name**: Authorization - **Location**: HTTP header - -### Identity.Application + +### Cookies - **Type**: API key -- **API key parameter name**: backoffice +- **API key parameter name**: session - **Location**: diff --git a/docs/AIServicesAPIApi.md b/docs/AIServicesAPIApi.md new file mode 100644 index 00000000..466e5f21 --- /dev/null +++ b/docs/AIServicesAPIApi.md @@ -0,0 +1,112 @@ +# testit_api_client.AIServicesAPIApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_external_services_id_ai_models_post**](AIServicesAPIApi.md#api_v2_external_services_id_ai_models_post) | **POST** /api/v2/external-services/{id}/ai/models | Ask for models with inquiry filter, cached + + +# **api_v2_external_services_id_ai_models_post** +> AIServiceModelApiResultIReply api_v2_external_services_id_ai_models_post(id) + +Ask for models with inquiry filter, cached + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import ai_services_api_api +from testit_api_client.model.ai_service_model_api_result_i_reply import AIServiceModelApiResultIReply +from testit_api_client.model.api_v2_external_services_id_ai_models_post_request import ApiV2ExternalServicesIdAiModelsPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_services_api_api.AIServicesAPIApi(api_client) + id = "id_example" # str | + api_v2_external_services_id_ai_models_post_request = ApiV2ExternalServicesIdAiModelsPostRequest(None) # ApiV2ExternalServicesIdAiModelsPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Ask for models with inquiry filter, cached + api_response = api_instance.api_v2_external_services_id_ai_models_post(id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling AIServicesAPIApi->api_v2_external_services_id_ai_models_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Ask for models with inquiry filter, cached + api_response = api_instance.api_v2_external_services_id_ai_models_post(id, api_v2_external_services_id_ai_models_post_request=api_v2_external_services_id_ai_models_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling AIServicesAPIApi->api_v2_external_services_id_ai_models_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **api_v2_external_services_id_ai_models_post_request** | [**ApiV2ExternalServicesIdAiModelsPostRequest**](ApiV2ExternalServicesIdAiModelsPostRequest.md)| | [optional] + +### Return type + +[**AIServiceModelApiResultIReply**](AIServiceModelApiResultIReply.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful operation | - | +**400** | Not valid data or models request errors | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md b/docs/ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md new file mode 100644 index 00000000..4f0141c4 --- /dev/null +++ b/docs/ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md @@ -0,0 +1,13 @@ +# ApiV2AutotestsResultReasonsGroupingSearchPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inquiry** | [**FailureCategoryGroupSearchApiModelInquiry**](FailureCategoryGroupSearchApiModelInquiry.md) | | +**group** | [**FailureCategoryGroupSearchApiModelGroup**](FailureCategoryGroupSearchApiModelGroup.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2AutotestsResultReasonsPostRequest.md b/docs/ApiV2AutotestsResultReasonsPostRequest.md new file mode 100644 index 00000000..50454543 --- /dev/null +++ b/docs/ApiV2AutotestsResultReasonsPostRequest.md @@ -0,0 +1,15 @@ +# ApiV2AutotestsResultReasonsPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Failure category name | +**failure_category** | [**FailureCategory**](FailureCategory.md) | | +**failure_class_regexes** | [**[CreateFailureClassRegexApiModel], none_type**](CreateFailureClassRegexApiModel.md) | Failure category regexes | [optional] +**project_ids** | **[str], none_type** | Projects identifiers | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2AutotestsResultReasonsPutRequest.md b/docs/ApiV2AutotestsResultReasonsPutRequest.md new file mode 100644 index 00000000..fd720135 --- /dev/null +++ b/docs/ApiV2AutotestsResultReasonsPutRequest.md @@ -0,0 +1,16 @@ +# ApiV2AutotestsResultReasonsPutRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Failure category identifier | +**name** | **str** | Failure category name | +**failure_category** | [**FailureCategory**](FailureCategory.md) | | +**failure_class_regexes** | [**[UpdateFailureClassRegexApiModel], none_type**](UpdateFailureClassRegexApiModel.md) | Failure category regexes | [optional] +**project_ids** | **[str], none_type** | Projects identifiers | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2AutotestsResultReasonsSearchPostRequest.md b/docs/ApiV2AutotestsResultReasonsSearchPostRequest.md new file mode 100644 index 00000000..cbb1efd6 --- /dev/null +++ b/docs/ApiV2AutotestsResultReasonsSearchPostRequest.md @@ -0,0 +1,15 @@ +# ApiV2AutotestsResultReasonsSearchPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failure_categories** | [**[AvailableFailureCategory], none_type**](AvailableFailureCategory.md) | | [optional] +**name** | **str, none_type** | | [optional] +**regex_count** | [**Int32RangeSelectorModel**](Int32RangeSelectorModel.md) | | [optional] +**is_deleted** | **bool, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2CustomAttributesGlobalIdPutRequest.md b/docs/ApiV2CustomAttributesGlobalIdPutRequest.md index b23b3025..ce778df4 100644 --- a/docs/ApiV2CustomAttributesGlobalIdPutRequest.md +++ b/docs/ApiV2CustomAttributesGlobalIdPutRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name of attribute | -**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] **is_enabled** | **bool, none_type** | Indicates whether the attribute is available | [optional] **is_required** | **bool, none_type** | Indicates whether the attribute value is mandatory to specify | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/ApiV2CustomAttributesGlobalPostRequest.md b/docs/ApiV2CustomAttributesGlobalPostRequest.md index 3d17433a..9a38a5c3 100644 --- a/docs/ApiV2CustomAttributesGlobalPostRequest.md +++ b/docs/ApiV2CustomAttributesGlobalPostRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **type** | [**CustomAttributeTypesEnum**](CustomAttributeTypesEnum.md) | | **is_enabled** | **bool, none_type** | Indicates whether the attribute is available | [optional] **is_required** | **bool, none_type** | Indicates whether the attribute value is mandatory to specify | [optional] -**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ApiV2ExternalServicesIdAiModelsPostRequest.md b/docs/ApiV2ExternalServicesIdAiModelsPostRequest.md new file mode 100644 index 00000000..7e98df27 --- /dev/null +++ b/docs/ApiV2ExternalServicesIdAiModelsPostRequest.md @@ -0,0 +1,12 @@ +# ApiV2ExternalServicesIdAiModelsPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inquiry** | [**Inquiry**](Inquiry.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md b/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md new file mode 100644 index 00000000..f42a7a11 --- /dev/null +++ b/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md @@ -0,0 +1,13 @@ +# ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_external_service_id** | **str** | The unique ID of the new external service that will replace the current one | +**settings** | **bool, date, datetime, dict, float, int, list, str, none_type** | External service settings | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md b/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md new file mode 100644 index 00000000..93220450 --- /dev/null +++ b/docs/ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md @@ -0,0 +1,12 @@ +# ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**settings** | **bool, date, datetime, dict, float, int, list, str, none_type** | External service settings | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md b/docs/ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md new file mode 100644 index 00000000..f8bc7646 --- /dev/null +++ b/docs/ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md @@ -0,0 +1,12 @@ +# ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | Url of external issue | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md b/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md new file mode 100644 index 00000000..9cd9ad89 --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md @@ -0,0 +1,14 @@ +# ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Failure category name | +**failure_category** | [**FailureCategory**](FailureCategory.md) | | +**failure_class_regexes** | [**[CreateFailureClassRegexApiModel], none_type**](CreateFailureClassRegexApiModel.md) | Failure category regexes | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md b/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md new file mode 100644 index 00000000..e2e3d6e6 --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md @@ -0,0 +1,15 @@ +# ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Failure category identifier | +**name** | **str** | Failure category name | +**failure_category** | [**FailureCategory**](FailureCategory.md) | | +**failure_class_regexes** | [**[UpdateFailureClassRegexApiModel], none_type**](UpdateFailureClassRegexApiModel.md) | Failure category regexes | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdSettingsAutotestsPostRequest.md b/docs/ApiV2ProjectsProjectIdSettingsAutotestsPostRequest.md index 94771dde..86f7419e 100644 --- a/docs/ApiV2ProjectsProjectIdSettingsAutotestsPostRequest.md +++ b/docs/ApiV2ProjectsProjectIdSettingsAutotestsPostRequest.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **flaky_stability_percentage** | **int** | Stability percentage for autotest flaky computing | [optional] if omitted the server will use the default value of 100 **flaky_test_run_count** | **int** | Last test run count for autotest flaky computing | [optional] if omitted the server will use the default value of 100 **work_item_updating_enabled** | **bool** | Autotest to work item updating enabled | [optional] if omitted the server will use the default value of False -**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | [optional] if omitted the server will use the default value of 180 -**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | [optional] if omitted the server will use the default value of 500 +**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | [optional] if omitted the server will use the default value of 180 +**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | [optional] if omitted the server will use the default value of 500 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md new file mode 100644 index 00000000..b5f9954d --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md @@ -0,0 +1,13 @@ +# ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | [**TestPlanTestPointsSearchApiModel**](TestPlanTestPointsSearchApiModel.md) | | [optional] +**extraction_model** | [**TestPlanTestPointsExtractionApiModel**](TestPlanTestPointsExtractionApiModel.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md new file mode 100644 index 00000000..70405296 --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md @@ -0,0 +1,14 @@ +# ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | [**TestPlanTestPointsSearchApiModel**](TestPlanTestPointsSearchApiModel.md) | | [optional] +**group** | [**TestPlanTestPointsGroupApiModel**](TestPlanTestPointsGroupApiModel.md) | | [optional] +**inquiry** | [**TestPlanTestPointsInquiryApiModel**](TestPlanTestPointsInquiryApiModel.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md new file mode 100644 index 00000000..c1a680f2 --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md @@ -0,0 +1,14 @@ +# ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tester_ids** | **[str]** | | +**filter** | [**TestPlanTestPointsSearchApiModel**](TestPlanTestPointsSearchApiModel.md) | | [optional] +**extraction_model** | [**TestPlanTestPointsExtractionApiModel**](TestPlanTestPointsExtractionApiModel.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md b/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md new file mode 100644 index 00000000..bd589fce --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md @@ -0,0 +1,15 @@ +# ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**section_id** | **str** | | +**previews** | [**[WorkItemPreviewApiModel]**](WorkItemPreviewApiModel.md) | | +**attributes** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional] +**link** | [**PreviewsIssueLinkApiModel**](PreviewsIssueLinkApiModel.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md b/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md new file mode 100644 index 00000000..f068750c --- /dev/null +++ b/docs/ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md @@ -0,0 +1,16 @@ +# ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_service_id** | **str** | The ID of the external AI service to be used for generation. | +**temperature** | **float** | Controls randomness of the AI model output. | +**preview_limit** | **int** | Number of work item previews to generate. | +**issue_key** | **str, none_type** | The key of the issue in an issue tracker (e.g., JIRA-123). | [optional] +**user_context** | **str, none_type** | Additional user context or description of the issue if no issue key is provided. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2UsersPostRequest.md b/docs/ApiV2UsersPostRequest.md new file mode 100644 index 00000000..13db440a --- /dev/null +++ b/docs/ApiV2UsersPostRequest.md @@ -0,0 +1,19 @@ +# ApiV2UsersPostRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | | +**first_name** | **str** | | +**last_name** | **str** | | +**display_name** | **str** | | +**email** | **str** | | +**password** | **str, none_type** | | [optional] +**provider_id** | **str, none_type** | | [optional] +**external_id** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiV2WorkItemsSharedStepIdReferencesWorkItemsPostRequest.md b/docs/ApiV2WorkItemsSharedStepIdReferencesWorkItemsPostRequest.md index 7850b070..636d7f85 100644 --- a/docs/ApiV2WorkItemsSharedStepIdReferencesWorkItemsPostRequest.md +++ b/docs/ApiV2WorkItemsSharedStepIdReferencesWorkItemsPostRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **modified_by_ids** | **[str], none_type** | Collection of identifiers of users who applied last modification to work item | [optional] **states** | [**[WorkItemStates], none_type**](WorkItemStates.md) | Collection of states of work item | [optional] **priorities** | [**[WorkItemPriorityModel], none_type**](WorkItemPriorityModel.md) | Collection of priorities of work item | [optional] -**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] +**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] **created_date** | [**SharedStepReferenceSectionsQueryFilterModelCreatedDate**](SharedStepReferenceSectionsQueryFilterModelCreatedDate.md) | | [optional] **modified_date** | [**SharedStepReferenceSectionsQueryFilterModelModifiedDate**](SharedStepReferenceSectionsQueryFilterModelModifiedDate.md) | | [optional] **is_automated** | **bool, none_type** | Is result must consist of only manual/automated work items | [optional] diff --git a/docs/AttachmentPutModelAutoTestStepResultsModel.md b/docs/AttachmentPutModelAutoTestStepResultsModel.md index 9406f3ba..89c5dd66 100644 --- a/docs/AttachmentPutModelAutoTestStepResultsModel.md +++ b/docs/AttachmentPutModelAutoTestStepResultsModel.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **duration** | **int, none_type** | Expected or actual duration of the test run execution in milliseconds. | [optional] **outcome** | [**AvailableTestResultOutcome**](AvailableTestResultOutcome.md) | | [optional] **step_results** | [**[AttachmentPutModelAutoTestStepResultsModel], none_type**](AttachmentPutModelAutoTestStepResultsModel.md) | Nested step results. The maximum nesting level is 15. | [optional] -**attachments** | [**[AttachmentPutModel], none_type**](AttachmentPutModel.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] +**attachments** | [**[AttachmentPutModel], none_type**](AttachmentPutModel.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] **parameters** | **{str: (str,)}, none_type** | \"<b>parameter</b>\": \"<b>value</b>\" pair with arbitrary custom parameters. Multiple parameters can be sent. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AttachmentsApi.md b/docs/AttachmentsApi.md index 1464ef4b..f5c28daf 100644 --- a/docs/AttachmentsApi.md +++ b/docs/AttachmentsApi.md @@ -19,7 +19,7 @@ Delete attachment file ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -45,11 +45,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -78,7 +78,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -108,7 +108,7 @@ Download attachment file ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -135,11 +135,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -186,7 +186,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -216,7 +216,7 @@ Get attachment metadata ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -243,11 +243,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -277,7 +277,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -307,7 +307,7 @@ Get size of attachments storage in bytes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -333,11 +333,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -363,7 +363,7 @@ This endpoint does not need any parameter. ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -390,12 +390,12 @@ This endpoint does not need any parameter. Upload new attachment file -File size is restricted to 50 MB (52 428 800 bytes) +File size is restricted to 1 GB (1 073 741 824 bytes) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -422,11 +422,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -457,7 +457,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -470,7 +470,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Invalid file contents - Invalid HTTP headers | - | +**400** | - Invalid file contents - Invalid HTTP headers | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | diff --git a/docs/AutoTestProjectSettingsApiModel.md b/docs/AutoTestProjectSettingsApiModel.md index fb78bc35..f17455f7 100644 --- a/docs/AutoTestProjectSettingsApiModel.md +++ b/docs/AutoTestProjectSettingsApiModel.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **flaky_stability_percentage** | **int** | Stability percentage for autotest flaky computing | [optional] if omitted the server will use the default value of 100 **flaky_test_run_count** | **int** | Last test run count for autotest flaky computing | [optional] if omitted the server will use the default value of 100 **work_item_updating_enabled** | **bool** | Autotest to work item updating enabled | [optional] if omitted the server will use the default value of False -**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | [optional] if omitted the server will use the default value of 180 -**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | [optional] if omitted the server will use the default value of 500 +**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | [optional] if omitted the server will use the default value of 180 +**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | [optional] if omitted the server will use the default value of 500 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AutoTestProjectSettingsApiResult.md b/docs/AutoTestProjectSettingsApiResult.md index 3f2b7c1a..31deda88 100644 --- a/docs/AutoTestProjectSettingsApiResult.md +++ b/docs/AutoTestProjectSettingsApiResult.md @@ -14,8 +14,8 @@ Name | Type | Description | Notes **work_item_updating_fields** | [**AutoTestProjectSettingsApiResultWorkItemUpdatingFields**](AutoTestProjectSettingsApiResultWorkItemUpdatingFields.md) | | **archive_outdated_test_runs_enabled** | **bool** | Indicates whether archiving of outdated test runs is enabled for the project. | **test_runs_archive_limit_enabled** | **bool** | Indicates whether a limit is enforced on the number of archived test runs. | -**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | -**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | +**test_runs_retention_period_days** | **int** | The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings | +**max_active_test_runs_count** | **int** | Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AutoTestStepResult.md b/docs/AutoTestStepResult.md index c521cd43..687844e0 100644 --- a/docs/AutoTestStepResult.md +++ b/docs/AutoTestStepResult.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **duration** | **int, none_type** | Expected or actual duration of the test run execution in milliseconds. | [optional] **outcome** | [**AvailableTestResultOutcome**](AvailableTestResultOutcome.md) | | [optional] **step_results** | [**[AutoTestStepResult], none_type**](AutoTestStepResult.md) | Nested step results. The maximum nesting level is 15. | [optional] -**attachments** | [**[AttachmentApiResult], none_type**](AttachmentApiResult.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] +**attachments** | [**[AttachmentApiResult], none_type**](AttachmentApiResult.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] **parameters** | **{str: (str,)}, none_type** | \"<b>parameter</b>\": \"<b>value</b>\" pair with arbitrary custom parameters. Multiple parameters can be sent. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AutoTestStepResultUpdateRequest.md b/docs/AutoTestStepResultUpdateRequest.md index 5c585c93..da06456c 100644 --- a/docs/AutoTestStepResultUpdateRequest.md +++ b/docs/AutoTestStepResultUpdateRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **duration** | **int, none_type** | Expected or actual duration of the test run execution in milliseconds. | [optional] **outcome** | [**AvailableTestResultOutcome**](AvailableTestResultOutcome.md) | | [optional] **step_results** | [**[AutoTestStepResultUpdateRequest], none_type**](AutoTestStepResultUpdateRequest.md) | Nested step results. The maximum nesting level is 15. | [optional] -**attachments** | [**[AttachmentUpdateRequest], none_type**](AttachmentUpdateRequest.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] +**attachments** | [**[AttachmentUpdateRequest], none_type**](AttachmentUpdateRequest.md) | /// <summary> Specifies an attachment GUID. Multiple values can be sent. </summary> | [optional] **parameters** | **{str: (str,)}, none_type** | \"<b>parameter</b>\": \"<b>value</b>\" pair with arbitrary custom parameters. Multiple parameters can be sent. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AutoTestsApi.md b/docs/AutoTestsApi.md index 90825cb9..1b6f64c6 100644 --- a/docs/AutoTestsApi.md +++ b/docs/AutoTestsApi.md @@ -34,7 +34,7 @@ Delete autotests ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -62,11 +62,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -97,7 +97,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -124,12 +124,12 @@ Name | Type | Description | Notes Set \"Flaky\" status for multiple autotests -User permissions for project: - Read only - Execute - Write - Full control +User permissions for project: - Read only - Execute - Write - Full control ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -156,11 +156,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -200,7 +200,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -232,7 +232,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -259,11 +259,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -309,7 +309,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -336,12 +336,12 @@ void (empty response body) Get test results history for autotest - Use case User sets autotest internal (guid format) or global (integer format) identifier User sets getTestResultHistoryReportQuery (listed in the example) User runs method execution System search for test results using filters set by user in getTestResultHistoryReportQuery and id System returns the enumeration of test results + Use case User sets autotest internal (guid format) or global (integer format) identifier User sets getTestResultHistoryReportQuery (listed in the example) User runs method execution System search for test results using filters set by user in getTestResultHistoryReportQuery and id System returns the enumeration of test results ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -369,11 +369,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -424,7 +424,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -451,12 +451,12 @@ Name | Type | Description | Notes Get identifiers of changed linked work items -User permissions for project: - Read only - Execute - Write - Full control +User permissions for project: - Read only - Execute - Write - Full control ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -482,11 +482,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -516,7 +516,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -543,12 +543,12 @@ Name | Type | Description | Notes Approve changes to work items linked to autotest -User permissions for project: - Read only - Execute - Write - Full control +User permissions for project: - Read only - Execute - Write - Full control ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -574,11 +574,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -609,7 +609,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -639,7 +639,7 @@ Search for autotests ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -667,11 +667,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -712,7 +712,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -739,12 +739,12 @@ Name | Type | Description | Notes Create autotest - This method creates a new autotest. To add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method. Use the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan. + This method creates a new autotest. To add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method. Use the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -772,11 +772,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -807,7 +807,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -820,12 +820,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | +**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | **404** | Project with provided ID cannot be found | - | **409** | Autotest with the same external ID already exists is the project | - | -**422** | - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | +**422** | - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -834,12 +834,12 @@ Name | Type | Description | Notes Create multiple autotests - Use case User sets autotest parameters (listed in the example) and runs method execution System creates autotest [Optional] If steps enumeration is set, system creates step items and relates them to autotest [Optional] If setup enumeration is set, system creates setup items and relates them to autotest [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest [Optional] If label enumeration is set, system creates labels and relates them to autotest [Optional] If link enumeration is set, system creates links and relates them to autotest System returns autotest model (example listed in response parameters) + Use case User sets autotest parameters (listed in the example) and runs method execution System creates autotest [Optional] If steps enumeration is set, system creates step items and relates them to autotest [Optional] If setup enumeration is set, system creates setup items and relates them to autotest [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest [Optional] If label enumeration is set, system creates labels and relates them to autotest [Optional] If link enumeration is set, system creates links and relates them to autotest System returns autotest model (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -867,11 +867,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -968,7 +968,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -981,12 +981,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | +**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | **404** | Project with provided ID cannot be found | - | **409** | Autotest with the same external ID already exists is the project | - | -**422** | - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | +**422** | - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -995,12 +995,12 @@ Name | Type | Description | Notes Delete autotest - Use case User sets autotest internal (guid format) or global (integer format) identifier and runs method execution System finds the autotest by the identifier System deletes autotest and returns no content response + Use case User sets autotest internal (guid format) or global (integer format) identifier and runs method execution System finds the autotest by the identifier System deletes autotest and returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1026,11 +1026,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1059,7 +1059,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1086,12 +1086,12 @@ void (empty response body) Unlink autotest from work item - Use case User sets autotest internal (guid format) or global (integer format) identifier [Optional] User sets workitem internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier [Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it from autotest. [Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest. System returns no content response + Use case User sets autotest internal (guid format) or global (integer format) identifier [Optional] User sets workitem internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier [Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it from autotest. [Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest. System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1117,11 +1117,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1160,7 +1160,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1176,7 +1176,7 @@ void (empty response body) **400** | Work item ID is invalid | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | -**404** | - Autotest with provided ID cannot be found - Work item with provided ID cannot be found | - | +**404** | - Autotest with provided ID cannot be found - Work item with provided ID cannot be found | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1190,7 +1190,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1217,11 +1217,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1303,7 +1303,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1330,12 +1330,12 @@ Name | Type | Description | Notes Get average autotest duration - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System calculates pass average duration and fail average duration of autotest from all related test results System returns pass average duration and fail average duration for autotest + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System calculates pass average duration and fail average duration of autotest from all related test results System returns pass average duration and fail average duration for autotest ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1362,11 +1362,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1396,7 +1396,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1423,12 +1423,12 @@ Name | Type | Description | Notes Get autotest by internal or global ID - Use case User sets autotest internal or global identifier and runs method execution System returns autotest, which internal or global identifier equals the identifier value set in the previous action + Use case User sets autotest internal or global identifier and runs method execution System returns autotest, which internal or global identifier equals the identifier value set in the previous action ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1455,11 +1455,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1489,7 +1489,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1516,12 +1516,12 @@ Name | Type | Description | Notes Get autotest chronology - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search all test results related to autotest (with default limit equal 100) System orders the test results by CompletedOn property descending and then orders by CreatedDate property descending System returns test result chronology for autotest + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search all test results related to autotest (with default limit equal 100) System orders the test results by CompletedOn property descending and then orders by CreatedDate property descending System returns test result chronology for autotest ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1548,11 +1548,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1582,7 +1582,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1609,12 +1609,12 @@ Name | Type | Description | Notes Get completed tests runs for autotests - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search for all test runs related to the autotest System returns the enumeration of test runs + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search for all test runs related to the autotest System returns the enumeration of test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1641,11 +1641,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1675,7 +1675,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1702,12 +1702,12 @@ Name | Type | Description | Notes Get work items linked to autotest - This method links an autotest to a test case or a checklist. A manual test case with a linked automated work item is marked in the test management system as an autotest. You can run it from graphical user interface (GUI). To do that: 1. Open the project in GUI. 2. Go to Test plans section and switch to the Execution tab. 3. Select the autotest(s) you want to run using checkboxes. 4. In the toolbar above the test list, click Run autotests. + This method links an autotest to a test case or a checklist. A manual test case with a linked automated work item is marked in the test management system as an autotest. You can run it from graphical user interface (GUI). To do that: 1. Open the project in GUI. 2. Go to Test plans section and switch to the Execution tab. 3. Select the autotest(s) you want to run using checkboxes. 4. In the toolbar above the test list, click Run autotests. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1734,17 +1734,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = auto_tests_api.AutoTestsApi(api_client) - id = "id_example" # str | Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. + id = "id_example" # str | Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. is_deleted = True # bool | Specifies that a test is deleted or still relevant. (optional) is_work_item_deleted = False # bool | OBSOLETE: Use `isDeleted` instead (optional) if omitted the server will use the default value of False @@ -1771,7 +1771,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. | + **id** | **str**| Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. | **is_deleted** | **bool**| Specifies that a test is deleted or still relevant. | [optional] **is_work_item_deleted** | **bool**| OBSOLETE: Use `isDeleted` instead | [optional] if omitted the server will use the default value of False @@ -1781,7 +1781,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1808,12 +1808,12 @@ Name | Type | Description | Notes Link autotest with work items - Use case User sets autotest internal (guid format) or global (integer format) identifier User sets work item internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier System finds the work item by the work item identifier System relates the work item with the autotest and returns no content response + Use case User sets autotest internal (guid format) or global (integer format) identifier User sets work item internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier System finds the work item by the work item identifier System relates the work item with the autotest and returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1840,11 +1840,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1883,7 +1883,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1896,10 +1896,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - Autotest cannot be linked to shared steps - Autotest cannot be linked to work item from other project - Work item ID is invalid | - | +**400** | - Autotest cannot be linked to shared steps - Autotest cannot be linked to work item from other project - Work item ID is invalid | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | -**404** | - Autotest with provided ID cannot be found - Work item with provided ID cannot be found | - | +**404** | - Autotest with provided ID cannot be found - Work item with provided ID cannot be found | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1910,12 +1910,12 @@ void (empty response body) Update autotest - Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response + Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1942,11 +1942,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1976,7 +1976,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1989,12 +1989,12 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | +**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | -**404** | - Autotests with provided ID cannot be found - Project with provided ID cannot be found - Link with provided ID cannot be found - Label with provided ID cannot be found | - | +**404** | - Autotests with provided ID cannot be found - Project with provided ID cannot be found - Link with provided ID cannot be found - Label with provided ID cannot be found | - | **409** | Autotest with the same external ID already exists is the project | - | -**422** | - Project ID cannot be changed - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | +**422** | - Project ID cannot be changed - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | **204** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -2004,12 +2004,12 @@ void (empty response body) Update multiple autotests - Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response + Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2036,11 +2036,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2134,7 +2134,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2147,12 +2147,12 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | +**400** | - Name cannot be empty or contain only white space characters - External ID cannot be empty or contain only white space characters - Namespace cannot be empty or contain only white space characters - Classname cannot be empty or contain only white space characters - Steps cannot be `null` - Steps nesting level is more than 15 - Invalid URI | - | **401** | Unauthorized | - | **403** | Update permission for autotests is required | - | -**404** | - Autotests with provided ID cannot be found - Project with provided ID cannot be found - Link with provided ID cannot be found - Label with provided ID cannot be found | - | +**404** | - Autotests with provided ID cannot be found - Project with provided ID cannot be found - Link with provided ID cannot be found - Label with provided ID cannot be found | - | **409** | Autotest with the same external ID already exists is the project | - | -**422** | - Project ID cannot be changed - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | +**422** | - Project ID cannot be changed - Labels have duplicates - Labels begin with `::` - Labels with the same base have different values | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/BackgroundJobsApi.md b/docs/BackgroundJobsApi.md index f49f9326..8e5e8dcf 100644 --- a/docs/BackgroundJobsApi.md +++ b/docs/BackgroundJobsApi.md @@ -20,7 +20,7 @@ Delete all completed background jobs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -46,11 +46,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -75,7 +75,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -105,7 +105,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -132,11 +132,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -174,7 +174,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -204,7 +204,7 @@ Cancel current user background job ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -230,11 +230,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -263,7 +263,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -293,7 +293,7 @@ Get background job by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -320,11 +320,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -354,7 +354,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -384,7 +384,7 @@ Get background job status by job ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -411,11 +411,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -445,7 +445,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -475,7 +475,7 @@ Search for user background jobs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -503,11 +503,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -548,7 +548,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ConfigurationsApi.md b/docs/ConfigurationsApi.md index 07a24c07..584e8927 100644 --- a/docs/ConfigurationsApi.md +++ b/docs/ConfigurationsApi.md @@ -26,7 +26,7 @@ Create configurations by parameters ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -53,11 +53,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -88,7 +88,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -118,7 +118,7 @@ Delete multiple configurations ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -145,11 +145,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -180,7 +180,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -210,7 +210,7 @@ Delete configuration ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -236,11 +236,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -269,7 +269,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -301,7 +301,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -328,11 +328,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -378,7 +378,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -408,7 +408,7 @@ Permanently delete configuration from archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -434,11 +434,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -467,7 +467,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -497,7 +497,7 @@ Restore configuration from the archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -523,11 +523,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -556,7 +556,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -586,7 +586,7 @@ Permanently delete multiple archived configurations ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -613,11 +613,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -648,7 +648,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -678,7 +678,7 @@ Edit configuration ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -705,11 +705,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -739,7 +739,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -769,7 +769,7 @@ Restore multiple configurations from the archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -796,11 +796,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -831,7 +831,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -861,7 +861,7 @@ Search for configurations ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -889,11 +889,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -934,7 +934,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -961,12 +961,12 @@ Name | Type | Description | Notes Create Configuration - Use case User sets configuration model (listed in the request example) User runs method execution System creates configuration System returns created configuration (listed in the response example) + Use case User sets configuration model (listed in the request example) User runs method execution System creates configuration System returns created configuration (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -994,11 +994,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1029,7 +1029,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1056,12 +1056,12 @@ Name | Type | Description | Notes Get configuration by internal or global ID - Use case User sets configuration internal (guid format) or global (integer format) identifier User runs method execution System search configuration using the identifier System returns configuration + Use case User sets configuration internal (guid format) or global (integer format) identifier User runs method execution System search configuration using the identifier System returns configuration ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1088,11 +1088,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1122,7 +1122,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/CreateEmptyRequest.md b/docs/CreateEmptyRequest.md index 54bbb93b..466401e0 100644 --- a/docs/CreateEmptyRequest.md +++ b/docs/CreateEmptyRequest.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**project_id** | **str** | Project unique identifier This property is to link test run with a project | +**project_id** | **str** | Project unique identifier This property is to link test run with a project | **name** | **str, none_type** | Test run name | [optional] **description** | **str, none_type** | Test run description | [optional] **launch_source** | **str, none_type** | Test run launch source | [optional] diff --git a/docs/CreateEmptyTestRunApiModel.md b/docs/CreateEmptyTestRunApiModel.md index 399eeb55..71f25180 100644 --- a/docs/CreateEmptyTestRunApiModel.md +++ b/docs/CreateEmptyTestRunApiModel.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**project_id** | **str** | Project unique identifier This property is to link test run with a project | +**project_id** | **str** | Project unique identifier This property is to link test run with a project | **name** | **str, none_type** | Test run name | [optional] **description** | **str, none_type** | Test run description | [optional] **launch_source** | **str, none_type** | Test run launch source | [optional] diff --git a/docs/CreateProjectsAttributeRequest.md b/docs/CreateProjectsAttributeRequest.md index 43f69f52..a374ffc5 100644 --- a/docs/CreateProjectsAttributeRequest.md +++ b/docs/CreateProjectsAttributeRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **is_enabled** | **bool** | Indicates if the attribute is enabled | **is_required** | **bool** | Indicates if the attribute value is mandatory to specify | **is_global** | **bool** | Indicates if the attribute is available across all projects | -**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateUserApiModel.md b/docs/CreateUserApiModel.md new file mode 100644 index 00000000..ff14e62a --- /dev/null +++ b/docs/CreateUserApiModel.md @@ -0,0 +1,18 @@ +# CreateUserApiModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | | +**first_name** | **str** | | +**last_name** | **str** | | +**display_name** | **str** | | +**email** | **str** | | +**password** | **str, none_type** | | [optional] +**provider_id** | **str, none_type** | | [optional] +**external_id** | **str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomAttributeApiResult.md b/docs/CustomAttributeApiResult.md index f6cc5a7c..2dff53e7 100644 --- a/docs/CustomAttributeApiResult.md +++ b/docs/CustomAttributeApiResult.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Unique ID of the attribute | -**options** | [**[CustomAttributeOptionApiResult]**](CustomAttributeOptionApiResult.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | +**options** | [**[CustomAttributeOptionApiResult]**](CustomAttributeOptionApiResult.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | **type** | [**CustomAttributeType**](CustomAttributeType.md) | | **is_deleted** | **bool** | Indicates if the attribute is deleted | **name** | **str** | Name of the attribute | @@ -13,7 +13,7 @@ Name | Type | Description | Notes **is_required** | **bool** | Indicates if the attribute value is mandatory to specify | **is_global** | **bool** | Indicates if the attribute is available across all projects | **is_system** | **bool** | Indicates if the attribute is system | -**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | +**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomAttributeModel.md b/docs/CustomAttributeModel.md index 2e4a22e5..732c4d2c 100644 --- a/docs/CustomAttributeModel.md +++ b/docs/CustomAttributeModel.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Unique ID of the attribute | -**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | -**options** | [**[CustomAttributeOptionModel]**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | +**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | +**options** | [**[CustomAttributeOptionModel]**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | **type** | [**CustomAttributeTypesEnum**](CustomAttributeTypesEnum.md) | | **is_deleted** | **bool** | Indicates if the attribute is deleted | **is_system** | **bool** | Indicates if the attribute is system | diff --git a/docs/CustomAttributePostModel.md b/docs/CustomAttributePostModel.md index fdca995c..6406c3ce 100644 --- a/docs/CustomAttributePostModel.md +++ b/docs/CustomAttributePostModel.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **is_enabled** | **bool** | Indicates if the attribute is enabled | **is_required** | **bool** | Indicates if the attribute value is mandatory to specify | **is_global** | **bool** | Indicates if the attribute is available across all projects | -**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomAttributePutModel.md b/docs/CustomAttributePutModel.md index 4331e612..1fc936e6 100644 --- a/docs/CustomAttributePutModel.md +++ b/docs/CustomAttributePutModel.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **is_enabled** | **bool** | Indicates if the attribute is enabled | **is_required** | **bool** | Indicates if the attribute value is mandatory to specify | **is_global** | **bool** | Indicates if the attribute is available across all projects | -**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomAttributeSearchResponseModel.md b/docs/CustomAttributeSearchResponseModel.md index 26a2f0f0..1323ac7d 100644 --- a/docs/CustomAttributeSearchResponseModel.md +++ b/docs/CustomAttributeSearchResponseModel.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **work_item_usage** | [**[ProjectShortestModel]**](ProjectShortestModel.md) | | **test_plan_usage** | [**[ProjectShortestModel]**](ProjectShortestModel.md) | | **id** | **str** | Unique ID of the attribute | -**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | -**options** | [**[CustomAttributeOptionModel]**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | +**targets** | **[str]** | Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) | +**options** | [**[CustomAttributeOptionModel]**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | **type** | [**CustomAttributeTypesEnum**](CustomAttributeTypesEnum.md) | | **is_deleted** | **bool** | Indicates if the attribute is deleted | **is_system** | **bool** | Indicates if the attribute is system | diff --git a/docs/CustomAttributeTemplatesApi.md b/docs/CustomAttributeTemplatesApi.md index 29685fc1..60a426de 100644 --- a/docs/CustomAttributeTemplatesApi.md +++ b/docs/CustomAttributeTemplatesApi.md @@ -23,7 +23,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -50,11 +50,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -84,7 +84,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -111,12 +111,12 @@ Name | Type | Description | Notes Exclude CustomAttributes from CustomAttributeTemplate - Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System delete attributes from attributes tempalte + Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System delete attributes from attributes tempalte ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -142,11 +142,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -187,7 +187,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -214,12 +214,12 @@ void (empty response body) Include CustomAttributes to CustomAttributeTemplate - Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System add attributes to attributes tempalte + Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System add attributes to attributes tempalte ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -245,11 +245,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -290,7 +290,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -317,12 +317,12 @@ void (empty response body) Delete CustomAttributeTemplate - Use case User sets attribute template internal identifier User runs method execution System search and delete attribute template System returns no content response + Use case User sets attribute template internal identifier User runs method execution System search and delete attribute template System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -348,11 +348,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -381,7 +381,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -408,12 +408,12 @@ void (empty response body) Get CustomAttributeTemplate by ID - Use case User sets attribute template internal identifier User runs method execution System return attribute template (listed in response example) + Use case User sets attribute template internal identifier User runs method execution System return attribute template (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -440,11 +440,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -474,7 +474,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -501,12 +501,12 @@ Name | Type | Description | Notes Get CustomAttributeTemplate by name - Use case User sets attribute template name User runs method execution System search and return list of attribute templates (listed in response example) + Use case User sets attribute template name User runs method execution System search and return list of attribute templates (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -533,11 +533,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -567,7 +567,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -594,12 +594,12 @@ Name | Type | Description | Notes Create CustomAttributeTemplate - Use case User sets attribute template parameters (listed in request example) User runs method execution System creates attribute template System returns attribute template model (example listed in response parameters) + Use case User sets attribute template parameters (listed in request example) User runs method execution System creates attribute template System returns attribute template model (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -627,11 +627,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -662,7 +662,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -692,7 +692,7 @@ Update custom attributes template ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -719,11 +719,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -753,7 +753,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -780,12 +780,12 @@ void (empty response body) Search CustomAttributeTemplates - Use case User sets search params model (listed in request example) User runs method execution System return attribute templates (listed in response example) + Use case User sets search params model (listed in request example) User runs method execution System return attribute templates (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -813,11 +813,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -858,7 +858,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/CustomAttributesApi.md b/docs/CustomAttributesApi.md index c66145de..69cfe552 100644 --- a/docs/CustomAttributesApi.md +++ b/docs/CustomAttributesApi.md @@ -20,7 +20,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -47,11 +47,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -83,7 +83,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -113,7 +113,7 @@ Delete global attribute ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -139,11 +139,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -172,7 +172,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -202,7 +202,7 @@ Edit global attribute ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -230,11 +230,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -275,7 +275,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -305,7 +305,7 @@ Create global attribute ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -333,11 +333,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -368,7 +368,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -398,7 +398,7 @@ Get attribute ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -425,11 +425,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -459,7 +459,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -489,7 +489,7 @@ Search for attributes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -517,11 +517,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -562,7 +562,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ExternalIssuesApi.md b/docs/ExternalIssuesApi.md index ce91a2a3..d8051189 100644 --- a/docs/ExternalIssuesApi.md +++ b/docs/ExternalIssuesApi.md @@ -15,7 +15,7 @@ Returns list of suggestions from available external issues ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -43,11 +43,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -78,7 +78,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ExternalServicesApi.md b/docs/ExternalServicesApi.md new file mode 100644 index 00000000..d0024eb1 --- /dev/null +++ b/docs/ExternalServicesApi.md @@ -0,0 +1,96 @@ +# testit_api_client.ExternalServicesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_external_services_metadata_get**](ExternalServicesApi.md#api_v2_external_services_metadata_get) | **GET** /api/v2/external-services/metadata | Retrieves the metadata for all available external services + + +# **api_v2_external_services_metadata_get** +> ExternalServicesMetadataApiResult api_v2_external_services_metadata_get() + +Retrieves the metadata for all available external services + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.external_services_metadata_api_result import ExternalServicesMetadataApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = external_services_api.ExternalServicesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Retrieves the metadata for all available external services + api_response = api_instance.api_v2_external_services_metadata_get() + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ExternalServicesApi->api_v2_external_services_metadata_get: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ExternalServicesMetadataApiResult**](ExternalServicesMetadataApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/FailureCategoriesApi.md b/docs/FailureCategoriesApi.md new file mode 100644 index 00000000..b391be42 --- /dev/null +++ b/docs/FailureCategoriesApi.md @@ -0,0 +1,1342 @@ +# testit_api_client.FailureCategoriesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_autotests_failure_categories_grouping_search_post**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_grouping_search_post) | **POST** /api/v2/autotests/failure-categories/grouping-search | Get failure categories with support for filtering, sorting and grouping +[**api_v2_autotests_failure_categories_id_delete**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_id_delete) | **DELETE** /api/v2/autotests/failure-categories/{id} | Delete failure category +[**api_v2_autotests_failure_categories_id_get**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_id_get) | **GET** /api/v2/autotests/failure-categories/{id} | Get failure category by ID +[**api_v2_autotests_failure_categories_name_name_exists_get**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_name_name_exists_get) | **GET** /api/v2/autotests/failure-categories/name/{name}/exists | Check failure category with the specified name already exists +[**api_v2_autotests_failure_categories_post**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_post) | **POST** /api/v2/autotests/failure-categories | Create failure category +[**api_v2_autotests_failure_categories_put**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_put) | **PUT** /api/v2/autotests/failure-categories | Update failure category +[**api_v2_autotests_failure_categories_search_post**](FailureCategoriesApi.md#api_v2_autotests_failure_categories_search_post) | **POST** /api/v2/autotests/failure-categories/search | +[**api_v2_autotests_result_reasons_grouping_search_post**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_grouping_search_post) | **POST** /api/v2/autotests/resultReasons/grouping-search | Get failure categories with support for filtering, sorting and grouping +[**api_v2_autotests_result_reasons_id_delete**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_id_delete) | **DELETE** /api/v2/autotests/resultReasons/{id} | Delete failure category +[**api_v2_autotests_result_reasons_id_get**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_id_get) | **GET** /api/v2/autotests/resultReasons/{id} | Get failure category by ID +[**api_v2_autotests_result_reasons_name_name_exists_get**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_name_name_exists_get) | **GET** /api/v2/autotests/resultReasons/name/{name}/exists | Check failure category with the specified name already exists +[**api_v2_autotests_result_reasons_post**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_post) | **POST** /api/v2/autotests/resultReasons | Create failure category +[**api_v2_autotests_result_reasons_put**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_put) | **PUT** /api/v2/autotests/resultReasons | Update failure category +[**api_v2_autotests_result_reasons_search_post**](FailureCategoriesApi.md#api_v2_autotests_result_reasons_search_post) | **POST** /api/v2/autotests/resultReasons/search | + + +# **api_v2_autotests_failure_categories_grouping_search_post** +> FailureCategoryGroupItemApiResultReply api_v2_autotests_failure_categories_grouping_search_post() + +Get failure categories with support for filtering, sorting and grouping + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_group_item_api_result_reply import FailureCategoryGroupItemApiResultReply +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_grouping_search_post_request = ApiV2AutotestsResultReasonsGroupingSearchPostRequest(None) # ApiV2AutotestsResultReasonsGroupingSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get failure categories with support for filtering, sorting and grouping + api_response = api_instance.api_v2_autotests_failure_categories_grouping_search_post(api_v2_autotests_result_reasons_grouping_search_post_request=api_v2_autotests_result_reasons_grouping_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_grouping_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_grouping_search_post_request** | [**ApiV2AutotestsResultReasonsGroupingSearchPostRequest**](ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md)| | [optional] + +### Return type + +[**FailureCategoryGroupItemApiResultReply**](FailureCategoryGroupItemApiResultReply.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_id_delete** +> api_v2_autotests_failure_categories_id_delete(id) + +Delete failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete failure category + api_instance.api_v2_autotests_failure_categories_id_delete(id) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_id_get** +> FailureCategoryApiResult api_v2_autotests_failure_categories_id_get(id) + +Get failure category by ID + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + id = "id_example" # str | + is_deleted = True # bool | (optional) + + # example passing only required values which don't have defaults set + try: + # Get failure category by ID + api_response = api_instance.api_v2_autotests_failure_categories_id_get(id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_id_get: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get failure category by ID + api_response = api_instance.api_v2_autotests_failure_categories_id_get(id, is_deleted=is_deleted) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **is_deleted** | **bool**| | [optional] + +### Return type + +[**FailureCategoryApiResult**](FailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_name_name_exists_get** +> bool api_v2_autotests_failure_categories_name_name_exists_get(name) + +Check failure category with the specified name already exists + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + name = "name_example" # str | + + # example passing only required values which don't have defaults set + try: + # Check failure category with the specified name already exists + api_response = api_instance.api_v2_autotests_failure_categories_name_name_exists_get(name) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_name_name_exists_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| | + +### Return type + +**bool** + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_post** +> FailureCategoryApiResult api_v2_autotests_failure_categories_post() + +Create failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult +from testit_api_client.model.api_v2_autotests_result_reasons_post_request import ApiV2AutotestsResultReasonsPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_post_request = ApiV2AutotestsResultReasonsPostRequest(None) # ApiV2AutotestsResultReasonsPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create failure category + api_response = api_instance.api_v2_autotests_failure_categories_post(api_v2_autotests_result_reasons_post_request=api_v2_autotests_result_reasons_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_post_request** | [**ApiV2AutotestsResultReasonsPostRequest**](ApiV2AutotestsResultReasonsPostRequest.md)| | [optional] + +### Return type + +[**FailureCategoryApiResult**](FailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_put** +> api_v2_autotests_failure_categories_put() + +Update failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_autotests_result_reasons_put_request import ApiV2AutotestsResultReasonsPutRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_put_request = ApiV2AutotestsResultReasonsPutRequest(None) # ApiV2AutotestsResultReasonsPutRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update failure category + api_instance.api_v2_autotests_failure_categories_put(api_v2_autotests_result_reasons_put_request=api_v2_autotests_result_reasons_put_request) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_put_request** | [**ApiV2AutotestsResultReasonsPutRequest**](ApiV2AutotestsResultReasonsPutRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_failure_categories_search_post** +> [AutotestResultReasonShortGetModel] api_v2_autotests_failure_categories_search_post() + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.autotest_result_reason_short_get_model import AutotestResultReasonShortGetModel +from testit_api_client.model.api_v2_autotests_result_reasons_search_post_request import ApiV2AutotestsResultReasonsSearchPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + skip = 1 # int | Amount of items to be skipped (offset) (optional) + take = 1 # int | Amount of items to be taken (limit) (optional) + order_by = "OrderBy_example" # str | SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) (optional) + search_field = "SearchField_example" # str | Property name for searching (optional) + search_value = "SearchValue_example" # str | Value for searching (optional) + api_v2_autotests_result_reasons_search_post_request = ApiV2AutotestsResultReasonsSearchPostRequest(None) # ApiV2AutotestsResultReasonsSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.api_v2_autotests_failure_categories_search_post(skip=skip, take=take, order_by=order_by, search_field=search_field, search_value=search_value, api_v2_autotests_result_reasons_search_post_request=api_v2_autotests_result_reasons_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_failure_categories_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **skip** | **int**| Amount of items to be skipped (offset) | [optional] + **take** | **int**| Amount of items to be taken (limit) | [optional] + **order_by** | **str**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] + **search_field** | **str**| Property name for searching | [optional] + **search_value** | **str**| Value for searching | [optional] + **api_v2_autotests_result_reasons_search_post_request** | [**ApiV2AutotestsResultReasonsSearchPostRequest**](ApiV2AutotestsResultReasonsSearchPostRequest.md)| | [optional] + +### Return type + +[**[AutotestResultReasonShortGetModel]**](AutotestResultReasonShortGetModel.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_grouping_search_post** +> FailureCategoryGroupItemApiResultReply api_v2_autotests_result_reasons_grouping_search_post() + +Get failure categories with support for filtering, sorting and grouping + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_group_item_api_result_reply import FailureCategoryGroupItemApiResultReply +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_grouping_search_post_request = ApiV2AutotestsResultReasonsGroupingSearchPostRequest(None) # ApiV2AutotestsResultReasonsGroupingSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get failure categories with support for filtering, sorting and grouping + api_response = api_instance.api_v2_autotests_result_reasons_grouping_search_post(api_v2_autotests_result_reasons_grouping_search_post_request=api_v2_autotests_result_reasons_grouping_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_grouping_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_grouping_search_post_request** | [**ApiV2AutotestsResultReasonsGroupingSearchPostRequest**](ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md)| | [optional] + +### Return type + +[**FailureCategoryGroupItemApiResultReply**](FailureCategoryGroupItemApiResultReply.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_id_delete** +> api_v2_autotests_result_reasons_id_delete(id) + +Delete failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete failure category + api_instance.api_v2_autotests_result_reasons_id_delete(id) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_id_get** +> FailureCategoryApiResult api_v2_autotests_result_reasons_id_get(id) + +Get failure category by ID + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + id = "id_example" # str | + is_deleted = True # bool | (optional) + + # example passing only required values which don't have defaults set + try: + # Get failure category by ID + api_response = api_instance.api_v2_autotests_result_reasons_id_get(id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_id_get: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get failure category by ID + api_response = api_instance.api_v2_autotests_result_reasons_id_get(id, is_deleted=is_deleted) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **is_deleted** | **bool**| | [optional] + +### Return type + +[**FailureCategoryApiResult**](FailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_name_name_exists_get** +> bool api_v2_autotests_result_reasons_name_name_exists_get(name) + +Check failure category with the specified name already exists + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + name = "name_example" # str | + + # example passing only required values which don't have defaults set + try: + # Check failure category with the specified name already exists + api_response = api_instance.api_v2_autotests_result_reasons_name_name_exists_get(name) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_name_name_exists_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| | + +### Return type + +**bool** + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_post** +> FailureCategoryApiResult api_v2_autotests_result_reasons_post() + +Create failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult +from testit_api_client.model.api_v2_autotests_result_reasons_post_request import ApiV2AutotestsResultReasonsPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_post_request = ApiV2AutotestsResultReasonsPostRequest(None) # ApiV2AutotestsResultReasonsPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create failure category + api_response = api_instance.api_v2_autotests_result_reasons_post(api_v2_autotests_result_reasons_post_request=api_v2_autotests_result_reasons_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_post_request** | [**ApiV2AutotestsResultReasonsPostRequest**](ApiV2AutotestsResultReasonsPostRequest.md)| | [optional] + +### Return type + +[**FailureCategoryApiResult**](FailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_put** +> api_v2_autotests_result_reasons_put() + +Update failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_autotests_result_reasons_put_request import ApiV2AutotestsResultReasonsPutRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + api_v2_autotests_result_reasons_put_request = ApiV2AutotestsResultReasonsPutRequest(None) # ApiV2AutotestsResultReasonsPutRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update failure category + api_instance.api_v2_autotests_result_reasons_put(api_v2_autotests_result_reasons_put_request=api_v2_autotests_result_reasons_put_request) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_autotests_result_reasons_put_request** | [**ApiV2AutotestsResultReasonsPutRequest**](ApiV2AutotestsResultReasonsPutRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_autotests_result_reasons_search_post** +> [AutotestResultReasonShortGetModel] api_v2_autotests_result_reasons_search_post() + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import failure_categories_api +from testit_api_client.model.autotest_result_reason_short_get_model import AutotestResultReasonShortGetModel +from testit_api_client.model.api_v2_autotests_result_reasons_search_post_request import ApiV2AutotestsResultReasonsSearchPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = failure_categories_api.FailureCategoriesApi(api_client) + skip = 1 # int | Amount of items to be skipped (offset) (optional) + take = 1 # int | Amount of items to be taken (limit) (optional) + order_by = "OrderBy_example" # str | SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) (optional) + search_field = "SearchField_example" # str | Property name for searching (optional) + search_value = "SearchValue_example" # str | Value for searching (optional) + api_v2_autotests_result_reasons_search_post_request = ApiV2AutotestsResultReasonsSearchPostRequest(None) # ApiV2AutotestsResultReasonsSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.api_v2_autotests_result_reasons_search_post(skip=skip, take=take, order_by=order_by, search_field=search_field, search_value=search_value, api_v2_autotests_result_reasons_search_post_request=api_v2_autotests_result_reasons_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling FailureCategoriesApi->api_v2_autotests_result_reasons_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **skip** | **int**| Amount of items to be skipped (offset) | [optional] + **take** | **int**| Amount of items to be taken (limit) | [optional] + **order_by** | **str**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] + **search_field** | **str**| Property name for searching | [optional] + **search_value** | **str**| Value for searching | [optional] + **api_v2_autotests_result_reasons_search_post_request** | [**ApiV2AutotestsResultReasonsSearchPostRequest**](ApiV2AutotestsResultReasonsSearchPostRequest.md)| | [optional] + +### Return type + +[**[AutotestResultReasonShortGetModel]**](AutotestResultReasonShortGetModel.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/GlobalCustomAttributePostModel.md b/docs/GlobalCustomAttributePostModel.md index c134bfda..fb81eb89 100644 --- a/docs/GlobalCustomAttributePostModel.md +++ b/docs/GlobalCustomAttributePostModel.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **type** | [**CustomAttributeTypesEnum**](CustomAttributeTypesEnum.md) | | **is_enabled** | **bool, none_type** | Indicates whether the attribute is available | [optional] **is_required** | **bool, none_type** | Indicates whether the attribute value is mandatory to specify | [optional] -**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionPostModel], none_type**](CustomAttributeOptionPostModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GlobalCustomAttributeUpdateModel.md b/docs/GlobalCustomAttributeUpdateModel.md index c1838e24..83ddd640 100644 --- a/docs/GlobalCustomAttributeUpdateModel.md +++ b/docs/GlobalCustomAttributeUpdateModel.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Name of attribute | -**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of attribute options Available for attributes of type `options` and `multiple options` only | [optional] **is_enabled** | **bool, none_type** | Indicates whether the attribute is available | [optional] **is_required** | **bool, none_type** | Indicates whether the attribute value is mandatory to specify | [optional] diff --git a/docs/NotificationsApi.md b/docs/NotificationsApi.md index ef85dfa0..8108748f 100644 --- a/docs/NotificationsApi.md +++ b/docs/NotificationsApi.md @@ -16,12 +16,12 @@ Method | HTTP request | Description Get unread Notifications total in last 7 days - Use case User runs method execution System returns unread notifications total (listed in the response example) + Use case User runs method execution System returns unread notifications total (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -47,11 +47,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -82,7 +82,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -109,12 +109,12 @@ Name | Type | Description | Notes Get all Notifications for current User - Use case User runs method execution System returns notifications (listed in the response example) + Use case User runs method execution System returns notifications (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -142,11 +142,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -187,7 +187,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -200,7 +200,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| -**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | +**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -214,12 +214,12 @@ Name | Type | Description | Notes Set Notification as read - Use case User sets notification internal (guid format) identifier User runs method execution System set notification as read + Use case User sets notification internal (guid format) identifier User runs method execution System set notification as read ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -245,11 +245,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -278,7 +278,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -306,12 +306,12 @@ void (empty response body) Set all Notifications as read - Use case User runs method execution System set all notifications as read + Use case User runs method execution System set all notifications as read ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -337,11 +337,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -366,7 +366,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -394,12 +394,12 @@ void (empty response body) Search Notifications for current User - Use case User set filter and runs method execution System returns notifications (listed in the response example) + Use case User set filter and runs method execution System returns notifications (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -427,11 +427,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -472,7 +472,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/OpenIdConnectionsApi.md b/docs/OpenIdConnectionsApi.md index fb2a799b..2295e935 100644 --- a/docs/OpenIdConnectionsApi.md +++ b/docs/OpenIdConnectionsApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -42,11 +42,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -71,7 +71,7 @@ This endpoint does not need any parameter. ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ParametersApi.md b/docs/ParametersApi.md index 8bc53031..e26f73d9 100644 --- a/docs/ParametersApi.md +++ b/docs/ParametersApi.md @@ -26,12 +26,12 @@ Method | HTTP request | Description Create multiple parameters - Use case User sets list of parameter model (listed in the request example) User runs method execution System creates parameters System returns list of parameter model (listed in the response example) + Use case User sets list of parameter model (listed in the request example) User runs method execution System creates parameters System returns list of parameter model (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -59,11 +59,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -102,7 +102,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -115,7 +115,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Parameter model is not valid | - | +**400** | - Parameter model is not valid | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -129,12 +129,12 @@ Name | Type | Description | Notes Update multiple parameters - Use case User sets list of parameter model (listed in the request example) User runs method execution System updates parameters + Use case User sets list of parameter model (listed in the request example) User runs method execution System updates parameters ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -161,11 +161,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -204,7 +204,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -217,7 +217,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - Parameter model is not valid | - | +**400** | - Parameter model is not valid | - | **401** | Unauthorized | - | **403** | Invalid user permissions | - | **404** | Not Found | - | @@ -231,12 +231,12 @@ void (empty response body) Get parameters as group - Use case User runs method execution System search parameters System returns parameters models as groups (listed in the response example) + Use case User runs method execution System search parameters System returns parameters models as groups (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -263,11 +263,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -318,7 +318,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -345,12 +345,12 @@ Name | Type | Description | Notes Check existence parameter key in system - Use case User sets name of parameter key User runs method execution System search parameter key System returns the flag for the existence of the parameter key in the system + Use case User sets name of parameter key User runs method execution System search parameter key System returns the flag for the existence of the parameter key in the system ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -376,11 +376,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -410,7 +410,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -437,12 +437,12 @@ Name | Type | Description | Notes Get all parameter key values - Use case User sets parameter key (string format) User runs method execution System search parameter values using the key System returns parameter + Use case User sets parameter key (string format) User runs method execution System search parameter values using the key System returns parameter ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -468,11 +468,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -502,7 +502,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -529,12 +529,12 @@ Name | Type | Description | Notes Get all parameter keys - Use case User runs method execution System search all parameter keys System returns parameter keys + Use case User runs method execution System search all parameter keys System returns parameter keys ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -560,11 +560,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -607,7 +607,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -637,7 +637,7 @@ Search for parameters as group ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -665,11 +665,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -710,7 +710,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -740,7 +740,7 @@ Search for parameters ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -768,11 +768,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -813,7 +813,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -840,12 +840,12 @@ Name | Type | Description | Notes Create parameter - Use case User sets parameter model (listed in the request example) User runs method execution System creates parameter System returns parameter model + Use case User sets parameter model (listed in the request example) User runs method execution System creates parameter System returns parameter model ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -873,11 +873,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -908,7 +908,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -940,7 +940,7 @@ Deletes parameter and all it's values ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -966,11 +966,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -999,7 +999,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1031,7 +1031,7 @@ Deletes parameter and all it's values by parameter key identifier ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1057,11 +1057,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1090,7 +1090,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1117,12 +1117,12 @@ void (empty response body) Delete parameter - Use case User sets parameter internal (guid format) identifier System search and delete parameter System returns deleted parameter + Use case User sets parameter internal (guid format) identifier System search and delete parameter System returns deleted parameter ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1148,11 +1148,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1181,7 +1181,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1194,7 +1194,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | - ID is not valid - DTO is not valid | - | +**400** | - ID is not valid - DTO is not valid | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -1208,12 +1208,12 @@ void (empty response body) Get all parameters - Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted parameters [Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted If User did not set isDeleted field value, System search all parameters System returns array of all found parameters(listed in response model) + Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted parameters [Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted If User did not set isDeleted field value, System search all parameters System returns array of all found parameters(listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1240,11 +1240,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1285,7 +1285,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1312,12 +1312,12 @@ Name | Type | Description | Notes Get parameter by ID - Use case User sets parameter internal (guid format) identifier User runs method execution System search parameter using the identifier System returns parameter + Use case User sets parameter internal (guid format) identifier User runs method execution System search parameter using the identifier System returns parameter ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1344,11 +1344,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1378,7 +1378,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1405,12 +1405,12 @@ Name | Type | Description | Notes Update parameter - Use case User sets parameter updated properties(listed in the request example) User runs method execution System updated parameter using updated properties System returns no content response + Use case User sets parameter updated properties(listed in the request example) User runs method execution System updated parameter using updated properties System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1437,11 +1437,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1471,7 +1471,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1484,7 +1484,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid - DTO is not valid | - | +**400** | - ID is not valid - DTO is not valid | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Parameter with provided ID was not found | - | diff --git a/docs/ProjectAttributeTemplatesApi.md b/docs/ProjectAttributeTemplatesApi.md index 150b5206..e87e5d34 100644 --- a/docs/ProjectAttributeTemplatesApi.md +++ b/docs/ProjectAttributeTemplatesApi.md @@ -17,7 +17,7 @@ Search for custom attributes templates ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -45,11 +45,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -100,7 +100,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -127,12 +127,12 @@ Name | Type | Description | Notes Delete CustomAttributeTemplate from Project - Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System delete attribute template from project + Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System delete attribute template from project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -158,11 +158,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -193,7 +193,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -220,12 +220,12 @@ void (empty response body) Add CustomAttributeTemplate to Project - Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System add attribute template to project + Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System add attribute template to project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -251,11 +251,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -286,7 +286,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectAttributesApi.md b/docs/ProjectAttributesApi.md index 54291e4c..14fdafac 100644 --- a/docs/ProjectAttributesApi.md +++ b/docs/ProjectAttributesApi.md @@ -17,12 +17,12 @@ Method | HTTP request | Description Create project attribute - Use case User sets attribute parameters (listed in request example) and runs method execution System search project System creates attribute and relates it to the project System returns project attribute properties (example listed in response parameters) + Use case User sets attribute parameters (listed in request example) and runs method execution System search project System creates attribute and relates it to the project System returns project attribute properties (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -50,11 +50,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -95,7 +95,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -108,11 +108,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Attribute is `null` - Priority is invalid - Attribute with `Options` type must have an options - ID is not `null` - Option ID is not `null` | - | +**400** | - Attribute is `null` - Priority is invalid - Attribute with `Options` type must have an options - ID is not `null` - Option ID is not `null` | - | **401** | Unauthorized | - | **403** | Update permission for project settings is required | - | **404** | Project with provided ID was not found | - | -**409** | `CustomAttribute.Name` or `CustomAttribute.Id` are not unique in attributes schemes `CustomAttributeOptionModel.Id` or `CustomAttributeOptionModel.Value` are not unique in `attributesScheme.Options` | - | +**409** | `CustomAttribute.Name` or `CustomAttribute.Id` are not unique in attributes schemes `CustomAttributeOptionModel.Id` or `CustomAttributeOptionModel.Value` are not unique in `attributesScheme.Options` | - | **422** | Cannot add new attribute from template which is in use | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -122,12 +122,12 @@ Name | Type | Description | Notes Delete project attribute - Use case User sets project identifier and runs method execution User sets attribute identifier User runs method execution System search project System search and delete attribute System returns no content response + Use case User sets project identifier and runs method execution User sets attribute identifier User runs method execution System search project System search and delete attribute System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -153,11 +153,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -188,7 +188,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -201,7 +201,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | - Project ID is invalid - Project attribute ID is invalid - Attribute is empty | - | +**400** | - Project ID is invalid - Project attribute ID is invalid - Attribute is empty | - | **401** | Unauthorized | - | **403** | Update permission for project settings is required | - | **404** | Project with provided ID was not found | - | @@ -215,12 +215,12 @@ void (empty response body) Get project attribute - Use case User sets project internal or global identifier User sets project attribute identifier User runs method execution System search project System search project attribute System returns project attribute (listed in response model) + Use case User sets project internal or global identifier User sets project attribute identifier User runs method execution System search project System search project attribute System returns project attribute (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -247,11 +247,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -283,7 +283,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -299,7 +299,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test library is required | - | -**404** | - Project with provided ID was not found - Project attribute with provided ID was not found | - | +**404** | - Project with provided ID was not found - Project attribute with provided ID was not found | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -310,12 +310,12 @@ Name | Type | Description | Notes Get project attributes - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project [Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all attributes related to project System returns array of found attributes (listed in response model) + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project [Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all attributes related to project System returns array of found attributes (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -343,11 +343,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -388,7 +388,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -418,7 +418,7 @@ Search for attributes used in the project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -446,11 +446,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -501,7 +501,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -531,7 +531,7 @@ Edit attribute of the project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -558,11 +558,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -601,7 +601,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectConfigurationsApi.md b/docs/ProjectConfigurationsApi.md index 6f174e43..e02bd3e2 100644 --- a/docs/ProjectConfigurationsApi.md +++ b/docs/ProjectConfigurationsApi.md @@ -12,12 +12,12 @@ Method | HTTP request | Description Get project configurations - Use case User sets project internal or global identifier User runs method execution System search project System search all configurations related to project System returns array of found configurations (listed in response model) + Use case User sets project internal or global identifier User runs method execution System search project System search all configurations related to project System returns array of found configurations (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -44,11 +44,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -78,7 +78,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectExternalServicesApi.md b/docs/ProjectExternalServicesApi.md new file mode 100644 index 00000000..7d41fcdb --- /dev/null +++ b/docs/ProjectExternalServicesApi.md @@ -0,0 +1,610 @@ +# testit_api_client.ProjectExternalServicesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_projects_id_external_services_external_service_id_delete**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_delete) | **DELETE** /api/v2/projects/{id}/external-services/{externalServiceId} | Disable an external service +[**api_v2_projects_id_external_services_external_service_id_get**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_get) | **GET** /api/v2/projects/{id}/external-services/{externalServiceId} | Retrieves settings of an external service +[**api_v2_projects_id_external_services_external_service_id_patch**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_patch) | **PATCH** /api/v2/projects/{id}/external-services/{externalServiceId} | Replaces one active external service with another +[**api_v2_projects_id_external_services_external_service_id_put**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_external_service_id_put) | **PUT** /api/v2/projects/{id}/external-services/{externalServiceId} | Enable an external service +[**api_v2_projects_id_external_services_get**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_get) | **GET** /api/v2/projects/{id}/external-services | Retrieves information about external services, including their integration status (enabled or not) +[**api_v2_projects_id_external_services_issues_search_post**](ProjectExternalServicesApi.md#api_v2_projects_id_external_services_issues_search_post) | **POST** /api/v2/projects/{id}/external-services/issues/search | Searches for external issues using enabled external services in project + + +# **api_v2_projects_id_external_services_external_service_id_delete** +> api_v2_projects_id_external_services_external_service_id_delete(id, external_service_id) + +Disable an external service + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Project ID + external_service_id = "externalServiceId_example" # str | External service ID + + # example passing only required values which don't have defaults set + try: + # Disable an external service + api_instance.api_v2_projects_id_external_services_external_service_id_delete(id, external_service_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Project ID | + **external_service_id** | **str**| External service ID | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_id_external_services_external_service_id_get** +> ProjectExternalServiceSettingsApiResult api_v2_projects_id_external_services_external_service_id_get(id, external_service_id) + +Retrieves settings of an external service + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.project_external_service_settings_api_result import ProjectExternalServiceSettingsApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Project ID + external_service_id = "externalServiceId_example" # str | External service ID + + # example passing only required values which don't have defaults set + try: + # Retrieves settings of an external service + api_response = api_instance.api_v2_projects_id_external_services_external_service_id_get(id, external_service_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Project ID | + **external_service_id** | **str**| External service ID | + +### Return type + +[**ProjectExternalServiceSettingsApiResult**](ProjectExternalServiceSettingsApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_id_external_services_external_service_id_patch** +> api_v2_projects_id_external_services_external_service_id_patch(id, external_service_id) + +Replaces one active external service with another + +See RFC 6902: JavaScript Object Notation (JSON) Patch for details + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_patch_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Project ID + external_service_id = "externalServiceId_example" # str | External service ID + api_v2_projects_id_external_services_external_service_id_patch_request = ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest(None) # ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Replaces one active external service with another + api_instance.api_v2_projects_id_external_services_external_service_id_patch(id, external_service_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_patch: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Replaces one active external service with another + api_instance.api_v2_projects_id_external_services_external_service_id_patch(id, external_service_id, api_v2_projects_id_external_services_external_service_id_patch_request=api_v2_projects_id_external_services_external_service_id_patch_request) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_patch: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Project ID | + **external_service_id** | **str**| External service ID | + **api_v2_projects_id_external_services_external_service_id_patch_request** | [**ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest**](ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_id_external_services_external_service_id_put** +> api_v2_projects_id_external_services_external_service_id_put(id, external_service_id) + +Enable an external service + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_put_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Project ID + external_service_id = "externalServiceId_example" # str | External service ID + api_v2_projects_id_external_services_external_service_id_put_request = ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest(None) # ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Enable an external service + api_instance.api_v2_projects_id_external_services_external_service_id_put(id, external_service_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_put: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Enable an external service + api_instance.api_v2_projects_id_external_services_external_service_id_put(id, external_service_id, api_v2_projects_id_external_services_external_service_id_put_request=api_v2_projects_id_external_services_external_service_id_put_request) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_external_service_id_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Project ID | + **external_service_id** | **str**| External service ID | + **api_v2_projects_id_external_services_external_service_id_put_request** | [**ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest**](ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_id_external_services_get** +> ProjectExternalServicesApiResult api_v2_projects_id_external_services_get(id) + +Retrieves information about external services, including their integration status (enabled or not) + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.api_external_service_category import ApiExternalServiceCategory +from testit_api_client.model.project_external_services_api_result import ProjectExternalServicesApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Project ID + category = None # ApiExternalServiceCategory | (optional) + + # example passing only required values which don't have defaults set + try: + # Retrieves information about external services, including their integration status (enabled or not) + api_response = api_instance.api_v2_projects_id_external_services_get(id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_get: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Retrieves information about external services, including their integration status (enabled or not) + api_response = api_instance.api_v2_projects_id_external_services_get(id, category=category) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Project ID | + **category** | **ApiExternalServiceCategory**| | [optional] + +### Return type + +[**ProjectExternalServicesApiResult**](ProjectExternalServicesApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_id_external_services_issues_search_post** +> [ExternalIssueApiResult] api_v2_projects_id_external_services_issues_search_post(id) + +Searches for external issues using enabled external services in project + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_external_services_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.external_issue_api_result import ExternalIssueApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from testit_api_client.model.api_v2_projects_id_external_services_issues_search_post_request import ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_external_services_api.ProjectExternalServicesApi(api_client) + id = "id_example" # str | Internal (UUID) or global (integer) identifier + api_v2_projects_id_external_services_issues_search_post_request = ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest(None) # ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Searches for external issues using enabled external services in project + api_response = api_instance.api_v2_projects_id_external_services_issues_search_post(id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_issues_search_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Searches for external issues using enabled external services in project + api_response = api_instance.api_v2_projects_id_external_services_issues_search_post(id, api_v2_projects_id_external_services_issues_search_post_request=api_v2_projects_id_external_services_issues_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectExternalServicesApi->api_v2_projects_id_external_services_issues_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_projects_id_external_services_issues_search_post_request** | [**ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest**](ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest.md)| | [optional] + +### Return type + +[**[ExternalIssueApiResult]**](ExternalIssueApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ProjectFailureCategoriesApi.md b/docs/ProjectFailureCategoriesApi.md new file mode 100644 index 00000000..e75f70fb --- /dev/null +++ b/docs/ProjectFailureCategoriesApi.md @@ -0,0 +1,503 @@ +# testit_api_client.ProjectFailureCategoriesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_projects_project_id_autotests_failure_categories_grouping_search_post**](ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_grouping_search_post) | **POST** /api/v2/projects/{projectId}/autotests/failure-categories/grouping-search | Get failure categories with support for filtering, sorting and grouping +[**api_v2_projects_project_id_autotests_failure_categories_id_delete**](ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_id_delete) | **DELETE** /api/v2/projects/{projectId}/autotests/failure-categories/{id} | Delete failure category +[**api_v2_projects_project_id_autotests_failure_categories_id_get**](ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_id_get) | **GET** /api/v2/projects/{projectId}/autotests/failure-categories/{id} | Get failure category by ID +[**api_v2_projects_project_id_autotests_failure_categories_post**](ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_post) | **POST** /api/v2/projects/{projectId}/autotests/failure-categories | Create failure category +[**api_v2_projects_project_id_autotests_failure_categories_put**](ProjectFailureCategoriesApi.md#api_v2_projects_project_id_autotests_failure_categories_put) | **PUT** /api/v2/projects/{projectId}/autotests/failure-categories | Update failure category + + +# **api_v2_projects_project_id_autotests_failure_categories_grouping_search_post** +> ProjectFailureCategoryGroupItemApiResultReply api_v2_projects_project_id_autotests_failure_categories_grouping_search_post(project_id) + +Get failure categories with support for filtering, sorting and grouping + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.project_failure_category_group_item_api_result_reply import ProjectFailureCategoryGroupItemApiResultReply +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_failure_categories_api.ProjectFailureCategoriesApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + api_v2_autotests_result_reasons_grouping_search_post_request = ApiV2AutotestsResultReasonsGroupingSearchPostRequest(None) # ApiV2AutotestsResultReasonsGroupingSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Get failure categories with support for filtering, sorting and grouping + api_response = api_instance.api_v2_projects_project_id_autotests_failure_categories_grouping_search_post(project_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_grouping_search_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get failure categories with support for filtering, sorting and grouping + api_response = api_instance.api_v2_projects_project_id_autotests_failure_categories_grouping_search_post(project_id, api_v2_autotests_result_reasons_grouping_search_post_request=api_v2_autotests_result_reasons_grouping_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_grouping_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_autotests_result_reasons_grouping_search_post_request** | [**ApiV2AutotestsResultReasonsGroupingSearchPostRequest**](ApiV2AutotestsResultReasonsGroupingSearchPostRequest.md)| | [optional] + +### Return type + +[**ProjectFailureCategoryGroupItemApiResultReply**](ProjectFailureCategoryGroupItemApiResultReply.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_autotests_failure_categories_id_delete** +> api_v2_projects_project_id_autotests_failure_categories_id_delete(project_id, id) + +Delete failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_failure_categories_api.ProjectFailureCategoriesApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete failure category + api_instance.api_v2_projects_project_id_autotests_failure_categories_id_delete(project_id, id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_autotests_failure_categories_id_get** +> ProjectDetailedFailureCategoryApiResult api_v2_projects_project_id_autotests_failure_categories_id_get(project_id, id) + +Get failure category by ID + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.project_detailed_failure_category_api_result import ProjectDetailedFailureCategoryApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_failure_categories_api.ProjectFailureCategoriesApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Get failure category by ID + api_response = api_instance.api_v2_projects_project_id_autotests_failure_categories_id_get(project_id, id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **id** | **str**| | + +### Return type + +[**ProjectDetailedFailureCategoryApiResult**](ProjectDetailedFailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_autotests_failure_categories_post** +> ProjectDetailedFailureCategoryApiResult api_v2_projects_project_id_autotests_failure_categories_post(project_id) + +Create failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_failure_categories_api +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_post_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.project_detailed_failure_category_api_result import ProjectDetailedFailureCategoryApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_failure_categories_api.ProjectFailureCategoriesApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + api_v2_projects_project_id_autotests_failure_categories_post_request = ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest(None) # ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Create failure category + api_response = api_instance.api_v2_projects_project_id_autotests_failure_categories_post(project_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create failure category + api_response = api_instance.api_v2_projects_project_id_autotests_failure_categories_post(project_id, api_v2_projects_project_id_autotests_failure_categories_post_request=api_v2_projects_project_id_autotests_failure_categories_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_projects_project_id_autotests_failure_categories_post_request** | [**ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest**](ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest.md)| | [optional] + +### Return type + +[**ProjectDetailedFailureCategoryApiResult**](ProjectDetailedFailureCategoryApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_autotests_failure_categories_put** +> api_v2_projects_project_id_autotests_failure_categories_put(project_id) + +Update failure category + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_failure_categories_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_put_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_failure_categories_api.ProjectFailureCategoriesApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + api_v2_projects_project_id_autotests_failure_categories_put_request = ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest(None) # ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Update failure category + api_instance.api_v2_projects_project_id_autotests_failure_categories_put(project_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_put: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update failure category + api_instance.api_v2_projects_project_id_autotests_failure_categories_put(project_id, api_v2_projects_project_id_autotests_failure_categories_put_request=api_v2_projects_project_id_autotests_failure_categories_put_request) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectFailureCategoriesApi->api_v2_projects_project_id_autotests_failure_categories_put: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_projects_project_id_autotests_failure_categories_put_request** | [**ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest**](ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ProjectSectionsApi.md b/docs/ProjectSectionsApi.md index c5d89b85..1c501b6f 100644 --- a/docs/ProjectSectionsApi.md +++ b/docs/ProjectSectionsApi.md @@ -12,12 +12,12 @@ Method | HTTP request | Description Get project sections - Use case User sets project internal or global identifier and runs method execution System search project System search all sections related to the project System returns array of sections (listed in response) + Use case User sets project internal or global identifier and runs method execution System search project System search all sections related to the project System returns array of sections (listed in response) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -44,11 +44,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -97,7 +97,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectSettingsApi.md b/docs/ProjectSettingsApi.md index 120b47a1..9d43e61b 100644 --- a/docs/ProjectSettingsApi.md +++ b/docs/ProjectSettingsApi.md @@ -16,7 +16,7 @@ Set autotest project settings. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -43,11 +43,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -86,7 +86,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -116,7 +116,7 @@ Get autotest project settings. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -143,11 +143,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -177,7 +177,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectTestPlanAttributesApi.md b/docs/ProjectTestPlanAttributesApi.md index cfb6e896..3b6449f1 100644 --- a/docs/ProjectTestPlanAttributesApi.md +++ b/docs/ProjectTestPlanAttributesApi.md @@ -16,12 +16,12 @@ Method | HTTP request | Description Add attributes to project's test plans - Use case User sets project internal or global identifier and attributes identifiers User runs method execution System updates project and add attributes to project for test plans System returns no content response + Use case User sets project internal or global identifier and attributes identifiers User runs method execution System updates project and add attributes to project for test plans System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -47,11 +47,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -92,7 +92,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -105,7 +105,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | Attributes must be global | - | +**400** | Attributes must be global | - | **401** | Unauthorized | - | **403** | Update permission for project settings is required | - | **404** | Not Found | - | @@ -119,12 +119,12 @@ void (empty response body) Delete attribute from project's test plans - Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response + Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -150,11 +150,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -185,7 +185,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -212,12 +212,12 @@ void (empty response body) Get project's test plan attributes - Use case User runs method execution System returns project for test plans attributes by project identifier + Use case User runs method execution System returns project for test plans attributes by project identifier ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -244,11 +244,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -278,7 +278,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -308,7 +308,7 @@ Search for attributes used in the project test plans ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -336,11 +336,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -391,7 +391,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -418,12 +418,12 @@ Name | Type | Description | Notes Update attribute of project's test plans - Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response + Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -450,11 +450,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -493,7 +493,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectTestPlanTestPointsApi.md b/docs/ProjectTestPlanTestPointsApi.md index a7521b27..9a6bd594 100644 --- a/docs/ProjectTestPlanTestPointsApi.md +++ b/docs/ProjectTestPlanTestPointsApi.md @@ -4,10 +4,118 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- +[**api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post**](ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/analytics | Get test points analytics. [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post**](ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun | Rerun autotests. [**api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post**](ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run | Run autotests. +[**api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post**](ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/grouping-search | Search test points in test plan. +[**api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post**](ProjectTestPlanTestPointsApi.md#api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post) | **POST** /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/testers | Distribute test points between the users. +# **api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post** +> TestPlanTestPointsAnalyticsApiResult api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post(project_id, test_plan_id) + +Get test points analytics. + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_test_plan_test_points_api +from testit_api_client.model.test_plan_test_points_analytics_api_result import TestPlanTestPointsAnalyticsApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_test_plan_test_points_api.ProjectTestPlanTestPointsApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + test_plan_id = "testPlanId_example" # str | + api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request = ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest(None) # ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Get test points analytics. + api_response = api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post(project_id, test_plan_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get test points analytics. + api_response = api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post(project_id, test_plan_id, api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request=api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **test_plan_id** | **str**| | + **api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request** | [**ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest**](ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest.md)| | [optional] + +### Return type + +[**TestPlanTestPointsAnalyticsApiResult**](TestPlanTestPointsAnalyticsApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post** > api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post(project_id, test_plan_id) @@ -16,7 +124,7 @@ Rerun autotests. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -43,11 +151,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -88,7 +196,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -118,7 +226,7 @@ Run autotests. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -146,11 +254,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -193,7 +301,214 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post** +> TestPlanTestPointsGroupSearchApiResult api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post(project_id, test_plan_id) + +Search test points in test plan. + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_test_plan_test_points_api +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.test_plan_test_points_group_search_api_result import TestPlanTestPointsGroupSearchApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_test_plan_test_points_api.ProjectTestPlanTestPointsApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + test_plan_id = "testPlanId_example" # str | + api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request = ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest(None) # ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Search test points in test plan. + api_response = api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post(project_id, test_plan_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Search test points in test plan. + api_response = api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post(project_id, test_plan_id, api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request=api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **test_plan_id** | **str**| | + **api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request** | [**ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest**](ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest.md)| | [optional] + +### Return type + +[**TestPlanTestPointsGroupSearchApiResult**](TestPlanTestPointsGroupSearchApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post** +> api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post(project_id, test_plan_id) + +Distribute test points between the users. + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_test_plan_test_points_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_test_plan_test_points_api.ProjectTestPlanTestPointsApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + test_plan_id = "testPlanId_example" # str | + api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request = ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest(None) # ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + # Distribute test points between the users. + api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post(project_id, test_plan_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Distribute test points between the users. + api_instance.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post(project_id, test_plan_id, api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request=api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectTestPlanTestPointsApi->api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **test_plan_id** | **str**| | + **api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request** | [**ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest**](ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectTestPlansApi.md b/docs/ProjectTestPlansApi.md index 07c99459..3d1d5f29 100644 --- a/docs/ProjectTestPlansApi.md +++ b/docs/ProjectTestPlansApi.md @@ -17,12 +17,12 @@ Method | HTTP request | Description Get TestPlans analytics - Use case User sets project internal identifier User sets query params User runs method execution System return analytics + Use case User sets project internal identifier User sets query params User runs method execution System return analytics ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -49,11 +49,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -106,7 +106,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -136,7 +136,7 @@ Delete multiple test plans ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -163,11 +163,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -208,7 +208,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -223,7 +223,7 @@ Name | Type | Description | Notes **200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | -**403** | - Read permission for the project is required - Delete permission for test plans is required | - | +**403** | - Read permission for the project is required - Delete permission for test plans is required | - | **404** | Not Found | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -235,12 +235,12 @@ Name | Type | Description | Notes Checks if TestPlan exists with the specified name exists for the project - Use case User sets project internal or global identifier User runs method execution System purge delete project workitems + Use case User sets project internal or global identifier User runs method execution System purge delete project workitems ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -266,11 +266,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -302,7 +302,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -332,7 +332,7 @@ Permanently delete multiple archived test plans ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -359,11 +359,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -402,7 +402,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -432,7 +432,7 @@ Restore multiple test plans ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -459,11 +459,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -504,7 +504,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -531,12 +531,12 @@ Name | Type | Description | Notes Get Project TestPlans with analytics - Use case User sets project internal or global identifier User sets request body User runs method execution System returns project testplans with analytics + Use case User sets project internal or global identifier User sets request body User runs method execution System returns project testplans with analytics ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -564,11 +564,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -621,7 +621,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/ProjectWorkItemsApi.md b/docs/ProjectWorkItemsApi.md index 16bf2f37..1bee2b5e 100644 --- a/docs/ProjectWorkItemsApi.md +++ b/docs/ProjectWorkItemsApi.md @@ -4,6 +4,8 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- +[**api_v2_projects_project_id_work_items_previews_bulk_post**](ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_previews_bulk_post) | **POST** /api/v2/projects/{projectId}/work-items/previews/bulk | +[**api_v2_projects_project_id_work_items_previews_post**](ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_previews_post) | **POST** /api/v2/projects/{projectId}/work-items/previews | [**api_v2_projects_project_id_work_items_search_grouped_post**](ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_grouped_post) | **POST** /api/v2/projects/{projectId}/workItems/search/grouped | Search for work items and group results by attribute [**api_v2_projects_project_id_work_items_search_id_post**](ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_id_post) | **POST** /api/v2/projects/{projectId}/workItems/search/id | Search for work items and extract IDs only [**api_v2_projects_project_id_work_items_search_post**](ProjectWorkItemsApi.md#api_v2_projects_project_id_work_items_search_post) | **POST** /api/v2/projects/{projectId}/workItems/search | Search for work items @@ -12,6 +14,205 @@ Method | HTTP request | Description [**get_work_items_by_project_id**](ProjectWorkItemsApi.md#get_work_items_by_project_id) | **GET** /api/v2/projects/{projectId}/workItems | Get project work items +# **api_v2_projects_project_id_work_items_previews_bulk_post** +> api_v2_projects_project_id_work_items_previews_bulk_post(project_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_work_items_api +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_bulk_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_work_items_api.ProjectWorkItemsApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + api_v2_projects_project_id_work_items_previews_bulk_post_request = ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest(None) # ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_projects_project_id_work_items_previews_bulk_post(project_id) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectWorkItemsApi->api_v2_projects_project_id_work_items_previews_bulk_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_instance.api_v2_projects_project_id_work_items_previews_bulk_post(project_id, api_v2_projects_project_id_work_items_previews_bulk_post_request=api_v2_projects_project_id_work_items_previews_bulk_post_request) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectWorkItemsApi->api_v2_projects_project_id_work_items_previews_bulk_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_projects_project_id_work_items_previews_bulk_post_request** | [**ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest**](ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_projects_project_id_work_items_previews_post** +> GenerateWorkItemPreviewsApiResult api_v2_projects_project_id_work_items_previews_post(project_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import project_work_items_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.generate_work_item_previews_api_result import GenerateWorkItemPreviewsApiResult +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = project_work_items_api.ProjectWorkItemsApi(api_client) + project_id = "projectId_example" # str | Internal (UUID) or global (integer) identifier + api_v2_projects_project_id_work_items_previews_post_request = ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest(None) # ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.api_v2_projects_project_id_work_items_previews_post(project_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectWorkItemsApi->api_v2_projects_project_id_work_items_previews_post: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.api_v2_projects_project_id_work_items_previews_post(project_id, api_v2_projects_project_id_work_items_previews_post_request=api_v2_projects_project_id_work_items_previews_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling ProjectWorkItemsApi->api_v2_projects_project_id_work_items_previews_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **project_id** | **str**| Internal (UUID) or global (integer) identifier | + **api_v2_projects_project_id_work_items_previews_post_request** | [**ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest**](ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest.md)| | [optional] + +### Return type + +[**GenerateWorkItemPreviewsApiResult**](GenerateWorkItemPreviewsApiResult.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **api_v2_projects_project_id_work_items_search_grouped_post** > [WorkItemGroupModel] api_v2_projects_project_id_work_items_search_grouped_post(project_id) @@ -20,7 +221,7 @@ Search for work items and group results by attribute ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -48,11 +249,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -103,7 +304,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -133,7 +334,7 @@ Search for work items and extract IDs only ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -160,11 +361,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -215,7 +416,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -245,7 +446,7 @@ Search for work items ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -273,11 +474,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -328,7 +529,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -358,7 +559,7 @@ Get work item index (position) in a collection by its id. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -386,11 +587,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -443,7 +644,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -470,12 +671,12 @@ Name | Type | Description | Notes Get WorkItems Tags - Use case User sets project internal identifier User runs method execution System returns work items tags + Use case User sets project internal identifier User runs method execution System returns work items tags ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -502,11 +703,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -547,7 +748,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -574,12 +775,12 @@ Name | Type | Description | Notes Get project work items - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project [Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted If User did not set isDeleted field value, System search all workitems related to project System returns array of found workitems (listed in response model) + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project [Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted If User did not set isDeleted field value, System search all workitems related to project System returns array of found workitems (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -606,11 +807,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -667,7 +868,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -680,7 +881,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| -**400** | - `orderBy` statement must have one `.` and no `,` characters - `orderBy` statement has invalid length - `orderBy` statement must have UUID as attribute key - Search field was not found | - | +**400** | - `orderBy` statement must have one `.` and no `,` characters - `orderBy` statement has invalid length - `orderBy` statement must have UUID as attribute key - Search field was not found | - | **401** | Unauthorized | - | **403** | Read permission for test library is required | - | **404** | Project with provided ID was not found | - | diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md index c957114e..c03fd43f 100644 --- a/docs/ProjectsApi.md +++ b/docs/ProjectsApi.md @@ -5,7 +5,6 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_global_attributes_to_project**](ProjectsApi.md#add_global_attributes_to_project) | **POST** /api/v2/projects/{id}/globalAttributes | Add global attributes to project -[**api_v2_projects_demo_post**](ProjectsApi.md#api_v2_projects_demo_post) | **POST** /api/v2/projects/demo | [**api_v2_projects_id_delete**](ProjectsApi.md#api_v2_projects_id_delete) | **DELETE** /api/v2/projects/{id} | Archive project [**api_v2_projects_id_failure_classes_get**](ProjectsApi.md#api_v2_projects_id_failure_classes_get) | **GET** /api/v2/projects/{id}/failureClasses | Get failure classes [**api_v2_projects_id_favorite_put**](ProjectsApi.md#api_v2_projects_id_favorite_put) | **PUT** /api/v2/projects/{id}/favorite | Mark Project as favorite @@ -36,12 +35,12 @@ Method | HTTP request | Description Add global attributes to project - Use case User sets project internal or global identifier and attributes identifiers System search project System relates global attributes with project System returns no content response + Use case User sets project internal or global identifier and attributes identifiers System search project System relates global attributes with project System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -67,11 +66,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -112,7 +111,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -125,7 +124,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Success | - | -**400** | Attributes must be global | - | +**400** | Attributes must be global | - | **401** | Unauthorized | - | **403** | Project admin permission for project settings is required | - | **404** | Project with provided ID was not found | - | @@ -134,92 +133,6 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **api_v2_projects_demo_post** -> DemoProjectApiResult api_v2_projects_demo_post() - - - -### Example - -* Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): - -```python -import time -import testit_api_client -from testit_api_client.api import projects_api -from testit_api_client.model.problem_details import ProblemDetails -from testit_api_client.model.demo_project_api_result import DemoProjectApiResult -from testit_api_client.model.validation_problem_details import ValidationProblemDetails -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = testit_api_client.Configuration( - host = "http://localhost" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: PrivateToken -configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['PrivateToken'] = 'Bearer' - -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' - -# Enter a context with an instance of the API client -with testit_api_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = projects_api.ProjectsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.api_v2_projects_demo_post() - pprint(api_response) - except testit_api_client.ApiException as e: - print("Exception when calling ProjectsApi->api_v2_projects_demo_post: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**DemoProjectApiResult**](DemoProjectApiResult.md) - -### Authorization - -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad Request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Not Found | - | -**409** | Conflict | - | -**422** | Unprocessable Entity | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **api_v2_projects_id_delete** > api_v2_projects_id_delete(id) @@ -228,7 +141,7 @@ Archive project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -254,11 +167,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -287,7 +200,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -317,7 +230,7 @@ Get failure classes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -344,11 +257,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -389,7 +302,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -419,7 +332,7 @@ Mark Project as favorite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -445,11 +358,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -478,7 +391,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -505,12 +418,12 @@ void (empty response body) Get Project filters - Use case User sets project internal or global identifier User runs method execution System returns project filters + Use case User sets project internal or global identifier User runs method execution System returns project filters ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -537,11 +450,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -571,7 +484,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -603,7 +516,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -630,11 +543,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -680,7 +593,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -710,7 +623,7 @@ Purge the project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -736,11 +649,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -769,7 +682,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -799,7 +712,7 @@ Restore archived project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -825,11 +738,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -858,7 +771,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -885,12 +798,12 @@ void (empty response body) Delete attribute from project's test plans - Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response + Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -916,11 +829,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -951,7 +864,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -978,12 +891,12 @@ void (empty response body) Update attribute of project's test plans - Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response + Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1010,11 +923,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1053,7 +966,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1080,12 +993,12 @@ void (empty response body) Get Project TestRuns full models - Use case User sets project internal or global identifier User sets query params User runs method execution System returns project test runs full models + Use case User sets project internal or global identifier User sets query params User runs method execution System returns project test runs full models ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1112,11 +1025,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1183,7 +1096,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1213,7 +1126,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1239,11 +1152,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1272,7 +1185,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1302,7 +1215,7 @@ Purge multiple projects ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1329,11 +1242,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1364,7 +1277,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1394,7 +1307,7 @@ Restore multiple projects ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1421,11 +1334,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1456,7 +1369,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1486,7 +1399,7 @@ Search for projects ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1514,11 +1427,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1559,7 +1472,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1586,12 +1499,12 @@ Name | Type | Description | Notes Get projects short models - Use case User sets query params User runs method execution System return projects short models + Use case User sets query params User runs method execution System return projects short models ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1619,11 +1532,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1654,7 +1567,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1681,12 +1594,12 @@ Name | Type | Description | Notes Create project - Use case User sets project parameters (listed in request example) and runs method execution System creates project System returns project model (example listed in response parameters) + Use case User sets project parameters (listed in request example) and runs method execution System creates project System returns project model (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1714,11 +1627,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1749,7 +1662,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1779,7 +1692,7 @@ Delete all autotests from project ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1805,11 +1718,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1838,7 +1751,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1865,12 +1778,12 @@ void (empty response body) Get all projects - Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted projects [Optional] If User sets isDeleted field value as false, System search all projects which are not deleted If User did not set isDeleted field value, System search all projects System returns array of all found projects(listed in response model) + Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted projects [Optional] If User sets isDeleted field value as false, System search all projects which are not deleted If User did not set isDeleted field value, System search all projects System returns array of all found projects(listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1897,11 +1810,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1944,7 +1857,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1971,12 +1884,12 @@ Name | Type | Description | Notes Get namespaces of autotests in project - Use case User sets project internal or global identifier and runs method execution System search project System search all autotest related to the project System returns array of autotest with namespaces and classnames (listed in response) + Use case User sets project internal or global identifier and runs method execution System search project System search all autotest related to the project System returns array of autotest with namespaces and classnames (listed in response) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2003,11 +1916,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2037,7 +1950,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2064,12 +1977,12 @@ Name | Type | Description | Notes Get project by ID - Use case User sets project internal or global identifier and runs method execution System search project System returns project (example listed in response parameters) + Use case User sets project internal or global identifier and runs method execution System search project System returns project (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2096,11 +2009,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2130,7 +2043,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2157,12 +2070,12 @@ Name | Type | Description | Notes Get project test plans - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted test plans related to project [Optional] If User sets isDeleted field value as false, System search all test plans related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all v related to project System returns array of found test plans (listed in response model) + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted test plans related to project [Optional] If User sets isDeleted field value as false, System search all test plans related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all v related to project System returns array of found test plans (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2189,11 +2102,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2234,7 +2147,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2261,12 +2174,12 @@ Name | Type | Description | Notes Get project test runs - Use case User sets project internal or global identifier User runs method execution System search project System search all test runs related to project System returns array of found test runs (listed in response model) + Use case User sets project internal or global identifier User runs method execution System search project System search all test runs related to project System returns array of found test runs (listed in response model) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2293,11 +2206,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2360,7 +2273,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2387,12 +2300,12 @@ Name | Type | Description | Notes Update project - Use case User sets project parameters (listed in request example) and runs method execution System updates project System returns updated project model (example listed in response parameters) + Use case User sets project parameters (listed in request example) and runs method execution System updates project System returns updated project model (example listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2419,11 +2332,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2453,7 +2366,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2466,7 +2379,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is invalid - Field is required | - | +**400** | - ID is invalid - Field is required | - | **401** | Unauthorized | - | **403** | Update permission for projects is required | - | **404** | Project with provided ID was not found | - | diff --git a/docs/DemoProjectApiResult.md b/docs/RoleApiModel.md similarity index 74% rename from docs/DemoProjectApiResult.md rename to docs/RoleApiModel.md index 39989a3b..cc503ca8 100644 --- a/docs/DemoProjectApiResult.md +++ b/docs/RoleApiModel.md @@ -1,10 +1,12 @@ -# DemoProjectApiResult +# RoleApiModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**job_id** | **str** | Job ID | +**id** | **str** | | +**name** | **str** | | +**is_system** | **bool** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RoleApiModelApiCollection.md b/docs/RoleApiModelApiCollection.md new file mode 100644 index 00000000..885169cd --- /dev/null +++ b/docs/RoleApiModelApiCollection.md @@ -0,0 +1,12 @@ +# RoleApiModelApiCollection + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[RoleApiModel]**](RoleApiModel.md) | Items | +**total_count** | **int** | Total count | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RolesApi.md b/docs/RolesApi.md new file mode 100644 index 00000000..fecbcfd9 --- /dev/null +++ b/docs/RolesApi.md @@ -0,0 +1,95 @@ +# testit_api_client.RolesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_roles_get**](RolesApi.md#api_v2_roles_get) | **GET** /api/v2/roles | + + +# **api_v2_roles_get** +> RoleApiModelApiCollection api_v2_roles_get() + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import roles_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.role_api_model_api_collection import RoleApiModelApiCollection +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = roles_api.RolesApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.api_v2_roles_get() + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling RolesApi->api_v2_roles_get: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**RoleApiModelApiCollection**](RoleApiModelApiCollection.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SearchWorkItemsRequest.md b/docs/SearchWorkItemsRequest.md index d871b88f..f4b54942 100644 --- a/docs/SearchWorkItemsRequest.md +++ b/docs/SearchWorkItemsRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag_names** | **[str], none_type** | Collection of tags | [optional] -**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] +**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] **name_or_id** | **str, none_type** | Name or identifier (UUID) of work item | [optional] **include_ids** | **[str], none_type** | Collection of identifiers of work items which need to be included in result regardless of filtering | [optional] **exclude_ids** | **[str], none_type** | Collection of identifiers of work items which need to be excluded from result regardless of filtering | [optional] diff --git a/docs/SectionsApi.md b/docs/SectionsApi.md index 428149fc..55efeab8 100644 --- a/docs/SectionsApi.md +++ b/docs/SectionsApi.md @@ -24,7 +24,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -51,11 +51,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -101,7 +101,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -128,12 +128,12 @@ void (empty response body) Create section - Use case User sets section properties (listed in request example) User runs method execution System creates section property values System returns section (listed in response example) + Use case User sets section properties (listed in request example) User runs method execution System creates section property values System returns section (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -161,11 +161,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -196,7 +196,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -223,12 +223,12 @@ Name | Type | Description | Notes Delete section - Use case User sets section identifier User runs method execution System search section by the identifier System search and delete nested sections of the found section System search and delete workitems related to the found nested sections System deletes initial section and related workitem System returns no content response + Use case User sets section identifier User runs method execution System search section by the identifier System search and delete nested sections of the found section System search and delete workitems related to the found nested sections System deletes initial section and related workitem System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -254,11 +254,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -287,7 +287,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -314,12 +314,12 @@ void (empty response body) Get section - Use case User sets section internal (guid format) identifier User runs method execution System search section by the section identifier [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns section + Use case User sets section internal (guid format) identifier User runs method execution System search section by the section identifier [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns section ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -347,11 +347,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -392,7 +392,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -419,12 +419,12 @@ Name | Type | Description | Notes Get section work items - Use case User sets section identifier User runs method execution System search section by the identifier System search work items related to the section [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns work item collection + Use case User sets section identifier User runs method execution System search section by the identifier System search work items related to the section [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns work item collection ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -451,11 +451,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -512,7 +512,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -525,7 +525,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| -**400** | - `orderBy` statement must have one `.` and no `,` symbols - `orderBy` statement has invalid length - `orderBy` statement must have UUID as attribute key - Search field was not found | - | +**400** | - `orderBy` statement must have one `.` and no `,` symbols - `orderBy` statement has invalid length - `orderBy` statement must have UUID as attribute key - Search field was not found | - | **401** | Unauthorized | - | **403** | Read permission for test library is required | - | **404** | Section with provided ID was not found | - | @@ -542,7 +542,7 @@ Move section with all work items into another section ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -569,11 +569,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -603,7 +603,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -630,12 +630,12 @@ void (empty response body) Rename section - Use case User sets section identifier and new name (listed in request example) User runs method execution System search section by the identifier System updates section name using the new name System returns no content response + Use case User sets section identifier and new name (listed in request example) User runs method execution System search section by the identifier System updates section name using the new name System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -662,11 +662,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -696,7 +696,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -723,12 +723,12 @@ void (empty response body) Update section - Use case User sets section properties (listed in request example) User runs method execution System search section by the identifier System updates section using the property values System returns no content response + Use case User sets section properties (listed in request example) User runs method execution System search section by the identifier System updates section using the property values System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -755,11 +755,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -789,7 +789,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -802,12 +802,12 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is invalid - Root section cannot be create | - | +**400** | - ID is invalid - Root section cannot be create | - | **401** | Unauthorized | - | **403** | Update permission for test library is required | - | -**404** | - Section cannot be found - Parent section cannot be found - Project cannot be found | - | +**404** | - Section cannot be found - Parent section cannot be found - Project cannot be found | - | **409** | Section with the same name already exists in the parent section | - | -**422** | - Root section cannot be edited - Parent ID cannot be changed - Project ID cannot be changed | - | +**422** | - Root section cannot be edited - Parent ID cannot be changed - Project ID cannot be changed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/SharedStepReferencesQueryFilterModel.md b/docs/SharedStepReferencesQueryFilterModel.md index 7a6388fe..8b137051 100644 --- a/docs/SharedStepReferencesQueryFilterModel.md +++ b/docs/SharedStepReferencesQueryFilterModel.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **modified_by_ids** | **[str], none_type** | Collection of identifiers of users who applied last modification to work item | [optional] **states** | [**[WorkItemStates], none_type**](WorkItemStates.md) | Collection of states of work item | [optional] **priorities** | [**[WorkItemPriorityModel], none_type**](WorkItemPriorityModel.md) | Collection of priorities of work item | [optional] -**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] +**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] **created_date** | [**SharedStepReferenceSectionsQueryFilterModelCreatedDate**](SharedStepReferenceSectionsQueryFilterModelCreatedDate.md) | | [optional] **modified_date** | [**SharedStepReferenceSectionsQueryFilterModelModifiedDate**](SharedStepReferenceSectionsQueryFilterModelModifiedDate.md) | | [optional] **is_automated** | **bool, none_type** | Is result must consist of only manual/automated work items | [optional] diff --git a/docs/TagsApi.md b/docs/TagsApi.md index 42da8c0b..75311711 100644 --- a/docs/TagsApi.md +++ b/docs/TagsApi.md @@ -17,12 +17,12 @@ Method | HTTP request | Description Delete tags - Use case User sets collection of tags internal (guid format) identifiers System searches and deletes a collection of tags + Use case User sets collection of tags internal (guid format) identifiers System searches and deletes a collection of tags ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -49,11 +49,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -83,7 +83,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -96,7 +96,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid | - | +**400** | - ID is not valid | - | **401** | Unauthorized | - | **403** | System administrator role is required | - | **404** | No tags with provided IDs were found | - | @@ -110,12 +110,12 @@ void (empty response body) Delete tag - Use case User sets tag internal (guid format) identifier System search and delete tag + Use case User sets tag internal (guid format) identifier System search and delete tag ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -141,11 +141,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -174,7 +174,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -187,7 +187,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid | - | +**400** | - ID is not valid | - | **401** | Unauthorized | - | **403** | System administrator role is required | - | **404** | Tag with provided ID cannot be found | - | @@ -201,12 +201,12 @@ void (empty response body) Create tag - Use case User sets tag model (listed in the request example) User runs method execution System creates tag System returns tag model (listed in the response example) + Use case User sets tag model (listed in the request example) User runs method execution System creates tag System returns tag model (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -234,11 +234,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -269,7 +269,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -282,7 +282,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful operation | - | -**400** | - Name cannot be empty or contain only white space characters - Name already in use - Name must be no more than 30 characters long | - | +**400** | - Name cannot be empty or contain only white space characters - Name already in use - Name must be no more than 30 characters long | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -296,12 +296,12 @@ Name | Type | Description | Notes Update tag - Use case User sets tag ID and model (listed in the request example) User runs method execution System updates tag System returns tag model (listed in the response example) + Use case User sets tag ID and model (listed in the request example) User runs method execution System updates tag System returns tag model (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -329,11 +329,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -366,7 +366,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -379,7 +379,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | - | -**400** | - ID is not valid - Name cannot be empty or contain only white space characters - Name already in use - Name must be no more than 30 characters long | - | +**400** | - ID is not valid - Name cannot be empty or contain only white space characters - Name already in use - Name must be no more than 30 characters long | - | **401** | Unauthorized | - | **403** | Project creator role is required | - | **404** | Tag with provided ID cannot be found | - | @@ -393,12 +393,12 @@ Name | Type | Description | Notes Search tags - Use case User runs method execution System returns collection of tags (listed in the response example) + Use case User runs method execution System returns collection of tags (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -425,11 +425,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -468,7 +468,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -481,7 +481,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| -**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | +**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -495,12 +495,12 @@ Name | Type | Description | Notes Get all Tags that are used in TestPlans - Use case User runs method execution System returns tags (listed in the response example) + Use case User runs method execution System returns tags (listed in the response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -527,11 +527,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -570,7 +570,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -583,7 +583,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
| -**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | +**400** | orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | diff --git a/docs/TestPlansApi.md b/docs/TestPlansApi.md index 42abe45c..908dc838 100644 --- a/docs/TestPlansApi.md +++ b/docs/TestPlansApi.md @@ -45,7 +45,7 @@ Add test-points to TestPlan with sections ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -72,17 +72,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier api_v2_projects_project_id_work_items_search_id_post_request = ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest(None) # ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest | Filter object to retrieve work items for test-suite's project (optional) # example passing only required values which don't have defaults set @@ -106,7 +106,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **api_v2_projects_project_id_work_items_search_id_post_request** | [**ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest**](ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest.md)| Filter object to retrieve work items for test-suite's project | [optional] ### Return type @@ -115,7 +115,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -142,12 +142,12 @@ void (empty response body) Add WorkItems to TestPlan with Sections as TestSuites - Use case User sets TestPlan identifier User sets WorkItem identifiers (listed in request example) User runs method execution System added WorkItems and Sections to TestPlan System returns no content response + Use case User sets TestPlan identifier User sets WorkItem identifiers (listed in request example) User runs method execution System added WorkItems and Sections to TestPlan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -173,17 +173,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier request_body = [ "request_body_example", ] # [str] | (optional) @@ -209,7 +209,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **request_body** | **[str]**| | [optional] ### Return type @@ -218,7 +218,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -231,10 +231,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | TestPlan is locked Some of configurations do not exist in the project, or they are not active | - | +**400** | TestPlan is locked Some of configurations do not exist in the project, or they are not active | - | **401** | Unauthorized | - | **403** | Update permission for TestPlan required | - | -**404** | Can't find a TestPlan with id Some of workItems do not exist | - | +**404** | Can't find a TestPlan with id Some of workItems do not exist | - | **409** | Conflict | - | **422** | Can't put a SharedSteps in the TestSuite | - | @@ -245,12 +245,12 @@ void (empty response body) Get analytics by TestPlan - Use case User sets test plan identifier User runs method execution System returns analytics by test plan + Use case User sets test plan identifier User runs method execution System returns analytics by test plan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -277,17 +277,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -303,7 +303,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -311,7 +311,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -341,7 +341,7 @@ Distribute test points between the users ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -368,11 +368,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -415,7 +415,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -442,12 +442,12 @@ Name | Type | Description | Notes Get TestPlan configurations - Use case User sets test plan identifier User runs method execution System return test plan configurations + Use case User sets test plan identifier User runs method execution System return test plan configurations ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -474,17 +474,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -500,7 +500,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -508,7 +508,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -535,12 +535,12 @@ Name | Type | Description | Notes Export TestPoints from TestPlan in xls format - Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file + Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -567,17 +567,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier time_zone_offset_in_minutes = 1 # int | (optional) api_v2_test_plans_id_export_test_points_xlsx_post_request = ApiV2TestPlansIdExportTestPointsXlsxPostRequest(None) # ApiV2TestPlansIdExportTestPointsXlsxPostRequest | (optional) @@ -602,7 +602,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **time_zone_offset_in_minutes** | **int**| | [optional] **api_v2_test_plans_id_export_test_points_xlsx_post_request** | [**ApiV2TestPlansIdExportTestPointsXlsxPostRequest**](ApiV2TestPlansIdExportTestPointsXlsxPostRequest.md)| | [optional] @@ -612,7 +612,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -639,12 +639,12 @@ void (empty response body) Export TestResults history from TestPlan in xls format - Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file + Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -670,17 +670,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier must_return_only_last_test_result = True # bool | (optional) include_steps = True # bool | (optional) include_deleted_test_suites = True # bool | (optional) @@ -707,7 +707,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **must_return_only_last_test_result** | **bool**| | [optional] **include_steps** | **bool**| | [optional] **include_deleted_test_suites** | **bool**| | [optional] @@ -719,7 +719,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -746,12 +746,12 @@ void (empty response body) Get TestPlan history - Use case User sets test plan identifier User runs method execution System return test plan history + Use case User sets test plan identifier User runs method execution System return test plan history ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -778,17 +778,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier skip = 1 # int | Amount of items to be skipped (offset) (optional) take = 1 # int | Amount of items to be taken (limit) (optional) order_by = "OrderBy_example" # str | SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) (optional) @@ -818,7 +818,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **skip** | **int**| Amount of items to be skipped (offset) | [optional] **take** | **int**| Amount of items to be taken (limit) | [optional] **order_by** | **str**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] @@ -831,7 +831,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -858,12 +858,12 @@ Name | Type | Description | Notes Get Links of TestPlan - Use case User sets test plan identifier User sets pagination filter (listed in request example) User runs method execution System returns links of TestPlan + Use case User sets test plan identifier User sets pagination filter (listed in request example) User runs method execution System returns links of TestPlan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -890,17 +890,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier skip = 1 # int | (optional) take = 1 # int | (optional) order_by = "orderBy_example" # str | (optional) @@ -928,7 +928,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **skip** | **int**| | [optional] **take** | **int**| | [optional] **order_by** | **str**| | [optional] @@ -939,7 +939,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -971,7 +971,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -998,11 +998,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1048,7 +1048,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1075,12 +1075,12 @@ void (empty response body) Get summary by TestPlan - Use case User sets test plan identifier User runs method execution System returns summary by test plan + Use case User sets test plan identifier User runs method execution System returns summary by test plan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1107,17 +1107,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -1133,7 +1133,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -1141,7 +1141,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1168,12 +1168,12 @@ Name | Type | Description | Notes Get TestPoints with last result from TestPlan - Use case User sets test plan identifier User sets filter (listed in request example) User runs method execution System return test points with last result from test plan + Use case User sets test plan identifier User sets filter (listed in request example) User runs method execution System return test points with last result from test plan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1200,17 +1200,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier tester_id = "testerId_example" # str | (optional) skip = 1 # int | Amount of items to be skipped (offset) (optional) take = 1 # int | Amount of items to be taken (limit) (optional) @@ -1241,7 +1241,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **tester_id** | **str**| | [optional] **skip** | **int**| Amount of items to be skipped (offset) | [optional] **take** | **int**| Amount of items to be taken (limit) | [optional] @@ -1255,7 +1255,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1282,12 +1282,12 @@ Name | Type | Description | Notes Reset TestPoints status of TestPlan - Use case User sets test plan identifier User sets test points identifiers User runs method execution System reset test points statuses of test plan + Use case User sets test plan identifier User sets test points identifiers User runs method execution System reset test points statuses of test plan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1313,17 +1313,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier request_body = [ "request_body_example", ] # [str] | (optional) @@ -1349,7 +1349,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **request_body** | **[str]**| | [optional] ### Return type @@ -1358,7 +1358,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1388,7 +1388,7 @@ Unassign users from multiple test points ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1415,11 +1415,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1460,7 +1460,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1490,7 +1490,7 @@ Assign user as a tester to multiple test points ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1517,11 +1517,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1564,7 +1564,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1591,12 +1591,12 @@ Name | Type | Description | Notes Get TestRuns of TestPlan - Use case User sets test plan identifier User sets TestRun status filter (listed in request example) User runs method execution System returns TestRuns for TestPlan + Use case User sets test plan identifier User sets TestRun status filter (listed in request example) User runs method execution System returns TestRuns for TestPlan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1623,17 +1623,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier not_started = True # bool | (optional) in_progress = True # bool | (optional) stopped = True # bool | (optional) @@ -1667,7 +1667,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **not_started** | **bool**| | [optional] **in_progress** | **bool**| | [optional] **stopped** | **bool**| | [optional] @@ -1684,7 +1684,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1711,12 +1711,12 @@ Name | Type | Description | Notes Search TestRuns of TestPlan - Use case User sets test plan identifier User sets TestRuns filter (listed in request example) User runs method execution System returns TestRuns for TestPlan + Use case User sets test plan identifier User sets TestRuns filter (listed in request example) User runs method execution System returns TestRuns for TestPlan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1744,17 +1744,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier skip = 1 # int | Amount of items to be skipped (offset) (optional) take = 1 # int | Amount of items to be taken (limit) (optional) order_by = "OrderBy_example" # str | SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) (optional) @@ -1785,7 +1785,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | **skip** | **int**| Amount of items to be skipped (offset) | [optional] **take** | **int**| Amount of items to be taken (limit) | [optional] **order_by** | **str**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] @@ -1799,7 +1799,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1829,7 +1829,7 @@ Get last modification date of test plan's test results ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1855,11 +1855,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1888,7 +1888,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1915,12 +1915,12 @@ void (empty response body) Send unlock TestPlan notification - Use case User sets test plan identifier User runs method execution System send unlock test plan notification + Use case User sets test plan identifier User runs method execution System send unlock test plan notification ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1946,17 +1946,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -1971,7 +1971,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -1979,7 +1979,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2006,12 +2006,12 @@ void (empty response body) Get TestPlans short models by Project identifiers - Use case User sets projects identifiers User runs method execution System return test plans short models (listed in response example) + Use case User sets projects identifiers User runs method execution System return test plans short models (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2038,11 +2038,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2077,7 +2077,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2104,12 +2104,12 @@ Name | Type | Description | Notes Clone TestPlan - Use case User sets test plan identifier User runs method execution System clones test plan System returns test plan (listed in response example) + Use case User sets test plan identifier User runs method execution System clones test plan System returns test plan (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2136,17 +2136,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2162,7 +2162,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2170,7 +2170,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2197,12 +2197,12 @@ Name | Type | Description | Notes Complete TestPlan - Use case User sets test plan identifier User runs method execution System completes the test plan and updates test plan status System returns no content response + Use case User sets test plan identifier User runs method execution System completes the test plan and updates test plan status System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2228,17 +2228,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2253,7 +2253,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2261,7 +2261,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2274,7 +2274,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Execute status from New to Completed forbidden Execute status from Completed to Completed forbidden | - | +**400** | Execute status from New to Completed forbidden Execute status from Completed to Completed forbidden | - | **401** | Unauthorized | - | **403** | Update permission for test plan required | - | **404** | Can't find a TestPlan with id! | - | @@ -2288,12 +2288,12 @@ void (empty response body) Create TestPlan - Use case User sets test plan properties (listed in request example) User runs method execution System creates test plan System returns test plan (listed in response example) + Use case User sets test plan properties (listed in request example) User runs method execution System creates test plan System returns test plan (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2321,11 +2321,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2356,7 +2356,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2369,7 +2369,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful operation | - | -**400** | Field is required Tags must be no more than 10! | - | +**400** | Field is required Tags must be no more than 10! | - | **401** | Unauthorized | - | **403** | Update permission for test plan required | - | **404** | Not Found | - | @@ -2383,12 +2383,12 @@ Name | Type | Description | Notes Delete TestPlan - Use case User sets test plan identifier User runs method execution System delete test plan System returns no content response + Use case User sets test plan identifier User runs method execution System delete test plan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2414,17 +2414,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2439,7 +2439,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2447,7 +2447,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2474,12 +2474,12 @@ void (empty response body) Get TestPlan by Id - Use case User sets test plan identifier User runs method execution System search test plan by the identifier System returns test plan + Use case User sets test plan identifier User runs method execution System search test plan by the identifier System returns test plan ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2506,17 +2506,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2532,7 +2532,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2540,7 +2540,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2567,12 +2567,12 @@ Name | Type | Description | Notes Get TestSuites Tree By Id - Use case User sets test plan identifier User runs method execution System finds test suites related to the test plan System returns test suites as a tree model (listed in response example) + Use case User sets test plan identifier User runs method execution System finds test suites related to the test plan System returns test suites as a tree model (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2599,17 +2599,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2625,7 +2625,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2633,7 +2633,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2660,12 +2660,12 @@ Name | Type | Description | Notes Pause TestPlan - Use case User sets test plan identifier User runs method execution System pauses the test plan and updates test plan status System returns no content response + Use case User sets test plan identifier User runs method execution System pauses the test plan and updates test plan status System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2691,17 +2691,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2716,7 +2716,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2724,7 +2724,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2737,7 +2737,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Execute status from New to Paused forbidden Execute status from Paused to Paused forbidden Execute status from Completed to Paused forbidden | - | +**400** | Execute status from New to Paused forbidden Execute status from Paused to Paused forbidden Execute status from Completed to Paused forbidden | - | **401** | Unauthorized | - | **403** | Update permission for test plan required | - | **404** | Can't find a TestPlan with id! | - | @@ -2754,7 +2754,7 @@ Permanently delete test plan from archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2780,11 +2780,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2813,7 +2813,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2840,12 +2840,12 @@ void (empty response body) Restore TestPlan - Use case User sets test plan identifier User runs method execution System restores test plan System returns no content response + Use case User sets test plan identifier User runs method execution System restores test plan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2871,17 +2871,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2896,7 +2896,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2904,7 +2904,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2931,12 +2931,12 @@ void (empty response body) Start TestPlan - Use case User sets test plan identifier User runs method execution System starts the test plan and updates test plan status System returns no content response + Use case User sets test plan identifier User runs method execution System starts the test plan and updates test plan status System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2962,17 +2962,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = test_plans_api.TestPlansApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test plan internal (guid format) or global (int format) identifier # example passing only required values which don't have defaults set try: @@ -2987,7 +2987,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| Test plan internal (guid format) or global (int format) identifier | + **id** | **str**| Test plan internal (guid format) or global (int format) identifier | ### Return type @@ -2995,7 +2995,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -3022,12 +3022,12 @@ void (empty response body) Update TestPlan - Use case User sets test plan properties(listed in request example) User runs method execution System updates test plan System returns no content response + Use case User sets test plan properties(listed in request example) User runs method execution System updates test plan System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -3054,11 +3054,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -3088,7 +3088,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -3101,7 +3101,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required Tags must be no more than 10! StartDate can't be more than EndDate! | - | +**400** | Field is required Tags must be no more than 10! StartDate can't be more than EndDate! | - | **401** | Unauthorized | - | **403** | Update permission for test plan required | - | **404** | Can't find a TestPlan with id! | - | diff --git a/docs/TestPointByTestSuiteModel.md b/docs/TestPointByTestSuiteModel.md index b44fdd77..ed176a03 100644 --- a/docs/TestPointByTestSuiteModel.md +++ b/docs/TestPointByTestSuiteModel.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **tester_id** | **str, none_type** | Tester who is responded for the test unique internal identifier | [optional] **work_item_id** | **str, none_type** | Workitem to which test point relates unique identifier | [optional] **configuration_id** | **str, none_type** | Configuration to which test point relates unique identifier | [optional] -**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] +**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] **last_test_result_id** | **str, none_type** | Last test result unique identifier | [optional] **work_item_median_duration** | **int, none_type** | Median duration of work item the test point represents | [optional] diff --git a/docs/TestPointRelatedToTestResult.md b/docs/TestPointRelatedToTestResult.md index 684a09e1..69e933cb 100644 --- a/docs/TestPointRelatedToTestResult.md +++ b/docs/TestPointRelatedToTestResult.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **tester_id** | **str, none_type** | Tester who is responded for the test unique internal identifier | [optional] **work_item_id** | **str, none_type** | Workitem to which test point relates unique identifier | [optional] **configuration_id** | **str, none_type** | Configuration to which test point relates unique identifier | [optional] -**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] +**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] **last_test_result_id** | **str, none_type** | Last test result unique identifier | [optional] **work_item_median_duration** | **int, none_type** | Median duration of work item the test point represents | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/docs/TestPointShortApiResult.md b/docs/TestPointShortApiResult.md index 86cc1376..cc633c62 100644 --- a/docs/TestPointShortApiResult.md +++ b/docs/TestPointShortApiResult.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **tester_id** | **str, none_type** | Tester who is responded for the test unique internal identifier | [optional] **work_item_id** | **str, none_type** | Workitem to which test point relates unique identifier | [optional] **configuration_id** | **str, none_type** | Configuration to which test point relates unique identifier | [optional] -**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] +**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] **last_test_result_id** | **str, none_type** | Last test result unique identifier | [optional] **work_item_median_duration** | **int, none_type** | Median duration of work item the test point represents | [optional] diff --git a/docs/TestPointShortModel.md b/docs/TestPointShortModel.md index 8fd20faf..a949c976 100644 --- a/docs/TestPointShortModel.md +++ b/docs/TestPointShortModel.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **tester_id** | **str, none_type** | Tester who is responded for the test unique internal identifier | [optional] **work_item_id** | **str, none_type** | Workitem to which test point relates unique identifier | [optional] **configuration_id** | **str, none_type** | Configuration to which test point relates unique identifier | [optional] -**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] +**status** | **str, none_type** | Test point status Applies one of these values: Blocked, NoResults, Failed, Passed | [optional] **last_test_result_id** | **str, none_type** | Last test result unique identifier | [optional] **work_item_median_duration** | **int, none_type** | Median duration of work item the test point represents | [optional] diff --git a/docs/TestPointsApi.md b/docs/TestPointsApi.md index 62e2577c..bb38c509 100644 --- a/docs/TestPointsApi.md +++ b/docs/TestPointsApi.md @@ -18,7 +18,7 @@ Get all test runs which use test point ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -45,11 +45,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -79,7 +79,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -109,7 +109,7 @@ Get work item represented by test point ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -136,11 +136,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -170,7 +170,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -200,7 +200,7 @@ Search for test points and extract IDs only ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -227,11 +227,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -272,7 +272,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -302,7 +302,7 @@ Search for test points ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -330,11 +330,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -375,7 +375,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/TestResultHistoryReportApiResult.md b/docs/TestResultHistoryReportApiResult.md index 03664655..3f347eac 100644 --- a/docs/TestResultHistoryReportApiResult.md +++ b/docs/TestResultHistoryReportApiResult.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Internal test result identifier | **created_date** | **datetime** | Test result creation date | -**user_id** | **str** | Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result | +**user_id** | **str** | Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result | **is_automated** | **bool** | Boolean flag defines if test point related to the test result is automated or not | **status** | [**TestResultHistoryReportApiResultStatus**](TestResultHistoryReportApiResultStatus.md) | | **created_by_id** | **str** | Unique identifier of user who created first test result in the test run | @@ -18,15 +18,15 @@ Name | Type | Description | Notes **test_plan_id** | **str, none_type** | Internal identifier of test plan related to the test result's test run | [optional] **test_plan_global_id** | **int, none_type** | Global identifier of test plan related to the test result's test run | [optional] **test_plan_name** | **str, none_type** | Name of test plan related to the test result's test run | [optional] -**configuration_name** | **str, none_type** | Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name | [optional] -**outcome** | **str, none_type** | Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run. | [optional] -**comment** | **str, none_type** | Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run | [optional] -**links** | [**[LinkApiResult], none_type**](LinkApiResult.md) | Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run. | [optional] +**configuration_name** | **str, none_type** | Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name | [optional] +**outcome** | **str, none_type** | Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run. | [optional] +**comment** | **str, none_type** | Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run | [optional] +**links** | [**[LinkApiResult], none_type**](LinkApiResult.md) | Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run. | [optional] **started_on** | **datetime, none_type** | Start date time from test result or from test run (if test run new state is Running or Completed state) | [optional] **completed_on** | **datetime, none_type** | End date time from test result or from test run (if test run new state is In progress, Stopped or Completed) | [optional] **duration** | **int, none_type** | Duration of first created test result in the test run | [optional] **modified_by_id** | **str, none_type** | Unique identifier of user who applied last modification of first test result in the test run | [optional] -**attachments** | [**[AttachmentApiResult], none_type**](AttachmentApiResult.md) | Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run. | [optional] +**attachments** | [**[AttachmentApiResult], none_type**](AttachmentApiResult.md) | Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run. | [optional] **work_item_version_id** | **str, none_type** | Unique identifier of workitem version related to the first test result in the test run | [optional] **work_item_version_number** | **int, none_type** | Number of workitem version related to the first test result in the test run | [optional] **launch_source** | **str, none_type** | | [optional] diff --git a/docs/TestResultsApi.md b/docs/TestResultsApi.md index f3e303f8..d112c453 100644 --- a/docs/TestResultsApi.md +++ b/docs/TestResultsApi.md @@ -30,7 +30,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -58,11 +58,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -101,7 +101,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -131,7 +131,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -159,11 +159,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -202,7 +202,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -232,7 +232,7 @@ Get test result by ID aggregated with previous results ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -259,11 +259,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -293,7 +293,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -323,7 +323,7 @@ Attach file to the test result ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -349,11 +349,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -384,7 +384,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -414,7 +414,7 @@ Get test result attachments meta-information ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -441,11 +441,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -475,7 +475,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -505,7 +505,7 @@ Get test result by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -532,11 +532,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -566,7 +566,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -598,7 +598,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -625,11 +625,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -675,7 +675,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -705,7 +705,7 @@ Edit test result by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -732,11 +732,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -775,7 +775,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -805,7 +805,7 @@ Get reruns ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -832,11 +832,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -866,7 +866,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -896,7 +896,7 @@ Search for test results ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -924,11 +924,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -969,7 +969,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -999,7 +999,7 @@ Search for test results and extract statistics ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1027,11 +1027,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1062,7 +1062,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1089,12 +1089,12 @@ Name | Type | Description | Notes Upload and link attachment to TestResult - Use case User sets testResultId User attaches a file System creates attachment and links it to the test result System returns attachment identifier + Use case User sets testResultId User attaches a file System creates attachment and links it to the test result System returns attachment identifier ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1120,11 +1120,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1163,7 +1163,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1191,12 +1191,12 @@ void (empty response body) Remove attachment and unlink from TestResult - Use case User sets testResultId and attachmentId User attaches a file User runs method execution System deletes attachment and unlinks it from the test result System returns attachment identifier + Use case User sets testResultId and attachmentId User attaches a file User runs method execution System deletes attachment and unlinks it from the test result System returns attachment identifier ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1222,11 +1222,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1257,7 +1257,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1284,12 +1284,12 @@ void (empty response body) Get attachment of TestResult - Use case User sets attachmentId and testResultId [Optional] User sets resize configuration User runs method execution System search attachments by the attachmentId and the testResultId [Optional] If resize configuration is set, System resizes the attachment according to the resize configuration [Optional] Otherwise, System does not resize the attachment System returns attachment as a file + Use case User sets attachmentId and testResultId [Optional] User sets resize configuration User runs method execution System search attachments by the attachmentId and the testResultId [Optional] If resize configuration is set, System resizes the attachment according to the resize configuration [Optional] Otherwise, System does not resize the attachment System returns attachment as a file ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1316,11 +1316,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1369,7 +1369,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1385,7 +1385,7 @@ void (empty response body) **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test result required | - | -**404** | File not found Attachment not found | - | +**404** | File not found Attachment not found | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1396,12 +1396,12 @@ void (empty response body) Get Metadata of TestResult's attachment - Use case User sets attachmentId and testResultId User runs method execution System search attachment by the attachmentId and the testResultId System returns attachment data + Use case User sets attachmentId and testResultId User runs method execution System search attachment by the attachmentId and the testResultId System returns attachment data ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1428,11 +1428,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1464,7 +1464,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1491,12 +1491,12 @@ Name | Type | Description | Notes Get all attachments of TestResult - Use case User sets testResultId User runs method execution System search all attachments of the test result System returns attachments enumeration + Use case User sets testResultId User runs method execution System search all attachments of the test result System returns attachments enumeration ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1523,11 +1523,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1557,7 +1557,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/TestRunV2ApiResult.md b/docs/TestRunV2ApiResult.md index ef372c2d..d81ddd69 100644 --- a/docs/TestRunV2ApiResult.md +++ b/docs/TestRunV2ApiResult.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **name** | **str** | Test run name | **state_name** | [**TestRunState**](TestRunState.md) | | **status** | [**TestRunByAutoTestApiResultStatus**](TestRunByAutoTestApiResultStatus.md) | | -**project_id** | **str** | Project unique identifier This property is used to link test run with project. | +**project_id** | **str** | Project unique identifier This property is used to link test run with project. | **created_date** | **datetime** | Date and time of test run creation | **created_by_id** | **str** | Unique identifier of user who created test run | **attachments** | [**[AttachmentApiResult]**](AttachmentApiResult.md) | Collection of attachments related to the test run | @@ -17,10 +17,10 @@ Name | Type | Description | Notes **run_count** | **int** | Run count | **tags** | **[str]** | Collection of tags associated with the test run | **description** | **str, none_type** | Test run description | [optional] -**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated. | [optional] +**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated. | [optional] **started_on** | **datetime, none_type** | Date and time of test run start | [optional] **completed_on** | **datetime, none_type** | Date and time of test run end | [optional] -**test_plan_id** | **str, none_type** | Test plan unique identifier This property is used to link test run with test plan. | [optional] +**test_plan_id** | **str, none_type** | Test plan unique identifier This property is used to link test run with test plan. | [optional] **test_results** | [**[TestResultV2GetModel], none_type**](TestResultV2GetModel.md) | Enumeration of test results related to test run | [optional] **modified_date** | **datetime, none_type** | Date and time of last test run modification | [optional] **modified_by_id** | **str, none_type** | Unique identifier of user who applied last test run modification | [optional] diff --git a/docs/TestRunsApi.md b/docs/TestRunsApi.md index e9fb0802..d3836cc1 100644 --- a/docs/TestRunsApi.md +++ b/docs/TestRunsApi.md @@ -36,12 +36,12 @@ Method | HTTP request | Description Delete multiple test runs - Use case User sets selection parameters of test runs System search and delete collection of test runs System returns the number of deleted test runs + Use case User sets selection parameters of test runs System search and delete collection of test runs System returns the number of deleted test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -68,11 +68,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -103,7 +103,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -116,7 +116,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | +**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -133,7 +133,7 @@ Get autotest classes and namespaces in test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -160,11 +160,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -194,7 +194,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -221,12 +221,12 @@ Name | Type | Description | Notes Delete test run - Use case User sets test run internal (guid format) identifier System search and delete test run + Use case User sets test run internal (guid format) identifier System search and delete test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -252,11 +252,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -285,7 +285,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -298,7 +298,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | +**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | **401** | Unauthorized | - | **403** | Forbidden | - | **404** | Test run with provided ID cannot be found | - | @@ -317,7 +317,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -344,11 +344,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -394,7 +394,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -421,12 +421,12 @@ void (empty response body) Permanently delete test run from archive - Use case User sets archived test run internal (guid format) identifier System search and purge archived test run + Use case User sets archived test run internal (guid format) identifier System search and purge archived test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -452,11 +452,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -485,7 +485,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -498,7 +498,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid | - | +**400** | - ID is not valid | - | **401** | Unauthorized | - | **403** | Delete permission for archived test runs is required | - | **404** | Not Found | - | @@ -515,7 +515,7 @@ Manual autotests rerun in test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -543,11 +543,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -588,7 +588,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -615,12 +615,12 @@ Name | Type | Description | Notes Restore test run from the archive - Use case User sets archived test run internal (guid format) identifier System search and restore test run + Use case User sets archived test run internal (guid format) identifier System search and restore test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -646,11 +646,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -679,7 +679,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -692,7 +692,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | -**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | +**400** | - ID is not valid - Project was archived and cannot be edited anymore | - | **401** | Unauthorized | - | **403** | Read permission for archive is required | - | **404** | Not Found | - | @@ -709,7 +709,7 @@ Search for the test run test results and build statistics ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -737,11 +737,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -782,7 +782,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -812,7 +812,7 @@ Get test results from the test run grouped by test points ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -839,11 +839,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -873,7 +873,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -903,7 +903,7 @@ Partial edit of multiple test results in the test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -930,11 +930,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -973,7 +973,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1003,7 +1003,7 @@ Get modification date of last test result of the test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1029,11 +1029,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1063,7 +1063,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1090,12 +1090,12 @@ Name | Type | Description | Notes Permanently delete multiple test runs from archive - Use case User sets selection parameters of archived test runs System search and delete collection of archived test runs System returns the number of deleted archived test runs + Use case User sets selection parameters of archived test runs System search and delete collection of archived test runs System returns the number of deleted archived test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1122,11 +1122,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1157,7 +1157,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1184,12 +1184,12 @@ Name | Type | Description | Notes Restore multiple test runs from the archive - Use case User sets selection parameters of archived test runs System search and restore collection of archived test runs System returns the number of restored test runs + Use case User sets selection parameters of archived test runs System search and restore collection of archived test runs System returns the number of restored test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1216,11 +1216,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1251,7 +1251,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1281,7 +1281,7 @@ Search for test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1309,11 +1309,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1354,7 +1354,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1384,7 +1384,7 @@ Update multiple test runs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1411,11 +1411,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1445,7 +1445,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1472,12 +1472,12 @@ void (empty response body) Complete TestRun - Use case User sets test run identifier User runs method execution System completes test run System returns no content response + Use case User sets test run identifier User runs method execution System completes test run System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1503,11 +1503,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1536,7 +1536,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1549,10 +1549,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required the StateName is already Stopped the StateName is already Completed | - | +**400** | Field is required the StateName is already Stopped the StateName is already Completed | - | **401** | Unauthorized | - | **403** | Update permission for test result required | - | -**404** | Can't find a TestRun with id! | - | +**404** | Can't find a TestRun with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1563,12 +1563,12 @@ void (empty response body) Create test runs based on autotests and configurations -This method creates a test run based on an autotest and a configuration. The difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is that in this method there is no need to create a test plan and work items (test cases and checklists). +This method creates a test run based on an autotest and a configuration. The difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is that in this method there is no need to create a test plan and work items (test cases and checklists). ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1596,11 +1596,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1631,7 +1631,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1644,7 +1644,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Field is required - Configuration does not exist in the project - Autotest does not exist in the project - Test run must be automated - Project ID is invalid - Autotest external IDs are required - Configuration IDs are required | - | +**400** | - Field is required - Configuration does not exist in the project - Autotest does not exist in the project - Test run must be automated - Project ID is invalid - Autotest external IDs are required - Configuration IDs are required | - | **401** | Unauthorized | - | **403** | Update permission for test results is required | - | **404** | Some autotests do not exist | - | @@ -1658,12 +1658,12 @@ Name | Type | Description | Notes Create test runs picking the needed test points -This method creates a test run based on a combination of a configuration and a work item(test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. This method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a jagged array within the \"testPointSelectors\" parameter. +This method creates a test run based on a combination of a configuration and a work item(test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. This method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a jagged array within the \"testPointSelectors\" parameter. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1691,11 +1691,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1726,7 +1726,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1739,7 +1739,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Field is required - Test run cannot be created with deleted test points - Test suites with IDs [ids] is archived - Configurations with IDs [ids] is archived - Test run cannot be created with non-automated test point - Test run must be automated - Some work items do not exist - Project ID is invalid - Test point selectors are required - Some work item IDs are invalid - Some configuration IDs are invalid | - | +**400** | - Field is required - Test run cannot be created with deleted test points - Test suites with IDs [ids] is archived - Configurations with IDs [ids] is archived - Test run cannot be created with non-automated test point - Test run must be automated - Some work items do not exist - Project ID is invalid - Test point selectors are required - Some work item IDs are invalid - Some configuration IDs are invalid | - | **401** | Unauthorized | - | **403** | Update permission for test results is required | - | **404** | Some test points do not exists | - | @@ -1753,12 +1753,12 @@ Name | Type | Description | Notes Create test run based on configurations and work items -This method creates a test run based on a combination of configuration and work item (test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. +This method creates a test run based on a combination of configuration and work item (test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1786,11 +1786,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1821,7 +1821,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1834,7 +1834,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | -**400** | - Field is required - Test run cannot be created with deleted test points - Test suites with IDs [ids] is archived - Configurations with IDs [ids] is archived - Test run cannot be created with non-automated test point - Some work items do not exist - Project ID is invalid | - | +**400** | - Field is required - Test run cannot be created with deleted test points - Test suites with IDs [ids] is archived - Configurations with IDs [ids] is archived - Test run cannot be created with non-automated test point - Some work items do not exist - Project ID is invalid | - | **401** | Unauthorized | - | **403** | Update permission for test results is required | - | **404** | Some test points, work items or configurations do not exist | - | @@ -1848,12 +1848,12 @@ Name | Type | Description | Notes Create empty TestRun - Use case User sets test run model (listed in the request example) User runs method execution System creates test run System returns test run model + Use case User sets test run model (listed in the request example) User runs method execution System creates test run System returns test run model ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1881,11 +1881,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1916,7 +1916,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1929,7 +1929,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful operation | - | -**400** | Field is required TestRun must be automated ProjectId is not a valid! | - | +**400** | Field is required TestRun must be automated ProjectId is not a valid! | - | **401** | TestRunTesterRequirement permission required | - | **403** | Update permission for test result required | - | **404** | Can't find a TestRun with id = testRunId | - | @@ -1943,12 +1943,12 @@ Name | Type | Description | Notes Get TestRun by Id - Use case User sets test run identifier User runs method execution System finds test run System returns test run + Use case User sets test run identifier User runs method execution System finds test run System returns test run ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1975,11 +1975,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2009,7 +2009,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2025,7 +2025,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test result required | - | -**404** | TestRun with ID '{id}' does not exist. | - | +**404** | TestRun with ID '{id}' does not exist. | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -2041,7 +2041,7 @@ This method sends test results to the test management system. ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2068,11 +2068,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2215,7 +2215,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2228,12 +2228,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | - | -**400** | - Field is required - Body is invalid - Test points are required - Duration must be a positive number - Outcome is not defined - Test run is stopped | - | +**400** | - Field is required - Body is invalid - Test points are required - Duration must be a positive number - Outcome is not defined - Test run is stopped | - | **401** | Unauthorized | - | **403** | Update permission for test results is required | - | -**404** | - Test run with provided ID was not found - Test point was not found - Autotest with provided external ID was not found | - | +**404** | - Test run with provided ID was not found - Test point was not found - Autotest with provided external ID was not found | - | **409** | Conflict | - | -**422** | - Configuration with provided ID was not found - Test points relevant to provided filters were not found | - | +**422** | - Configuration with provided ID was not found - Test points relevant to provided filters were not found | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -2242,12 +2242,12 @@ Name | Type | Description | Notes Start TestRun - Use case User sets test run identifier User runs method execution System starts test run System returns no content response + Use case User sets test run identifier User runs method execution System starts test run System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2273,11 +2273,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2306,7 +2306,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2319,10 +2319,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required the StateName is already InProgress the StateName is already Stopped the StateName is already Completed | - | +**400** | Field is required the StateName is already InProgress the StateName is already Stopped the StateName is already Completed | - | **401** | Unauthorized | - | **403** | Update permission for test result required | - | -**404** | Can't find a TestRun with id! | - | +**404** | Can't find a TestRun with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -2333,12 +2333,12 @@ void (empty response body) Stop TestRun - Use case User sets test run identifier User runs method execution System stops test run System returns no content response + Use case User sets test run identifier User runs method execution System stops test run System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2364,11 +2364,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2397,7 +2397,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2410,10 +2410,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required the StateName is already Stopped the StateName is already Completed | - | +**400** | Field is required the StateName is already Stopped the StateName is already Completed | - | **401** | Unauthorized | - | **403** | Update permission for test result required | - | -**404** | Can't find a TestRun with id! | - | +**404** | Can't find a TestRun with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -2424,12 +2424,12 @@ void (empty response body) Update empty TestRun - Use case User sets test run properties (listed in the request example) User runs method execution System updates test run System returns returns no content response + Use case User sets test run properties (listed in the request example) User runs method execution System updates test run System returns returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2456,11 +2456,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2490,7 +2490,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2503,10 +2503,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required Name is not valid | - | +**400** | Field is required Name is not valid | - | **401** | Unauthorized | - | **403** | Update permission for test result required | - | -**404** | Can't find a TestRun with id! | - | +**404** | Can't find a TestRun with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | diff --git a/docs/TestStatusesApi.md b/docs/TestStatusesApi.md index 890f8385..0e09457a 100644 --- a/docs/TestStatusesApi.md +++ b/docs/TestStatusesApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -47,11 +47,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -80,7 +80,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -110,7 +110,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -136,11 +136,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -168,7 +168,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -198,7 +198,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -225,11 +225,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -258,7 +258,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -288,7 +288,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -315,11 +315,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -356,7 +356,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -386,7 +386,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -412,11 +412,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -445,7 +445,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -475,7 +475,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -503,11 +503,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -537,7 +537,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -567,7 +567,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -595,11 +595,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -629,7 +629,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/TestSuiteWorkItemsSearchModel.md b/docs/TestSuiteWorkItemsSearchModel.md index ee14152e..352ddad5 100644 --- a/docs/TestSuiteWorkItemsSearchModel.md +++ b/docs/TestSuiteWorkItemsSearchModel.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag_names** | **[str], none_type** | Collection of tags | [optional] -**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] +**entity_types** | [**[WorkItemTypeModel], none_type**](WorkItemTypeModel.md) | Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional] **name_or_id** | **str, none_type** | Name or identifier (UUID) of work item | [optional] **include_ids** | **[str], none_type** | Collection of identifiers of work items which need to be included in result regardless of filtering | [optional] **exclude_ids** | **[str], none_type** | Collection of identifiers of work items which need to be excluded from result regardless of filtering | [optional] diff --git a/docs/TestSuitesApi.md b/docs/TestSuitesApi.md index 8a29367b..b97ea81e 100644 --- a/docs/TestSuitesApi.md +++ b/docs/TestSuitesApi.md @@ -27,7 +27,7 @@ Add test-points to test suite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -54,11 +54,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -97,7 +97,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -129,7 +129,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -156,11 +156,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -206,7 +206,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -236,7 +236,7 @@ Refresh test suite. Only dynamic test suites are supported by this method ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -262,11 +262,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -295,7 +295,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -325,7 +325,7 @@ Set work items for test suite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -351,11 +351,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -396,7 +396,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -426,7 +426,7 @@ Create test suite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -454,11 +454,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -489,7 +489,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -519,7 +519,7 @@ Edit test suite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -546,11 +546,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -580,7 +580,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -607,12 +607,12 @@ void (empty response body) Delete TestSuite - Use case User sets test suite identifier User runs method execution System search test suite by identifier System deletes test suite System returns no content response + Use case User sets test suite identifier User runs method execution System search test suite by identifier System deletes test suite System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -638,11 +638,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -671,7 +671,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -687,7 +687,7 @@ void (empty response body) **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Delete permission for test plan required | - | -**404** | Can't find a TestSuite with id | - | +**404** | Can't find a TestSuite with id | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -698,12 +698,12 @@ void (empty response body) Get Configurations By Id - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search configurations related to the test points System returns configurations array + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search configurations related to the test points System returns configurations array ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -730,11 +730,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -764,7 +764,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -780,7 +780,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test plan required | - | -**404** | Can't find a TestSuite with id! | - | +**404** | Can't find a TestSuite with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -791,12 +791,12 @@ Name | Type | Description | Notes Get TestPoints By Id - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System returns test points array + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System returns test points array ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -823,11 +823,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -857,7 +857,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -873,7 +873,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test plan required | - | -**404** | Can't find a TestSuite with id! | - | +**404** | Can't find a TestSuite with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -884,12 +884,12 @@ Name | Type | Description | Notes Get TestResults By Id - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search test results related to the test points System returns test results array + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search test results related to the test points System returns test results array ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -916,11 +916,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -950,7 +950,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -966,7 +966,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test plan required | - | -**404** | Can't find a TestSuite with id! | - | +**404** | Can't find a TestSuite with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -977,12 +977,12 @@ Name | Type | Description | Notes Get TestSuite by Id - Use case User sets test suite identifier User runs method execution System search test suite by identifier System returns test suite + Use case User sets test suite identifier User runs method execution System search test suite by identifier System returns test suite ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1009,11 +1009,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1043,7 +1043,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1059,7 +1059,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Read permission for test plan required | - | -**404** | Can't find a TestSuite with id! | - | +**404** | Can't find a TestSuite with id! | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1070,12 +1070,12 @@ Name | Type | Description | Notes Search WorkItems - Use case User sets test suite identifier [Optional] User sets filter User runs method execution System search test suite by identifier System search test points related to the test suite System search work items related to the test points [Optional] User sets filter, system applies filter System returns work items array + Use case User sets test suite identifier [Optional] User sets filter User runs method execution System search test suite by identifier System search test points related to the test suite System search work items related to the test points [Optional] User sets filter, system applies filter System returns work items array ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1103,11 +1103,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1158,7 +1158,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1185,12 +1185,12 @@ Name | Type | Description | Notes Set Configurations By TestSuite Id - Use case User sets test suite identifier User sets collection of configuration identifiers User runs method execution System search test suite by identifier System search test points related to the test suite System search configuration System restores(if exist) or creates test points with listed configuration System returns no content response + Use case User sets test suite identifier User sets collection of configuration identifiers User runs method execution System search test suite by identifier System search test points related to the test suite System search configuration System restores(if exist) or creates test points with listed configuration System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1216,11 +1216,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1261,7 +1261,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1274,10 +1274,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Some of Configurations do not exist in the project, or they are not active | - | +**400** | Some of Configurations do not exist in the project, or they are not active | - | **401** | Unauthorized | - | **403** | Update permission for test plan required | - | -**404** | Can't find a TestSuite with id | - | +**404** | Can't find a TestSuite with id | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | diff --git a/docs/UpdateEmptyRequest.md b/docs/UpdateEmptyRequest.md index b0fa3c34..261888f9 100644 --- a/docs/UpdateEmptyRequest.md +++ b/docs/UpdateEmptyRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | Test run unique identifier | **name** | **str** | Test run name | **description** | **str, none_type** | Test run description | [optional] -**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated | [optional] +**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated | [optional] **attachments** | [**[AssignAttachmentApiModel], none_type**](AssignAttachmentApiModel.md) | Collection of attachments related to the test run | [optional] **links** | [**[UpdateLinkApiModel], none_type**](UpdateLinkApiModel.md) | Collection of links related to the test run | [optional] **tags** | **[str], none_type** | Collection of tags to assign to the test run | [optional] diff --git a/docs/UpdateEmptyTestRunApiModel.md b/docs/UpdateEmptyTestRunApiModel.md index 3c4dd931..969bf77a 100644 --- a/docs/UpdateEmptyTestRunApiModel.md +++ b/docs/UpdateEmptyTestRunApiModel.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | Test run unique identifier | **name** | **str** | Test run name | **description** | **str, none_type** | Test run description | [optional] -**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated | [optional] +**launch_source** | **str, none_type** | Test run launch source Once launch source is specified it cannot be updated | [optional] **attachments** | [**[AssignAttachmentApiModel], none_type**](AssignAttachmentApiModel.md) | Collection of attachments related to the test run | [optional] **links** | [**[UpdateLinkApiModel], none_type**](UpdateLinkApiModel.md) | Collection of links related to the test run | [optional] **tags** | **[str], none_type** | Collection of tags to assign to the test run | [optional] diff --git a/docs/UpdateProjectsAttributeRequest.md b/docs/UpdateProjectsAttributeRequest.md index ab7e5503..c64cfac2 100644 --- a/docs/UpdateProjectsAttributeRequest.md +++ b/docs/UpdateProjectsAttributeRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **is_enabled** | **bool** | Indicates if the attribute is enabled | **is_required** | **bool** | Indicates if the attribute value is mandatory to specify | **is_global** | **bool** | Indicates if the attribute is available across all projects | -**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | [optional] +**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of the attribute options Available for attributes of type `options` and `multiple options` only | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserApiModel.md b/docs/UserApiModel.md new file mode 100644 index 00000000..04a9154c --- /dev/null +++ b/docs/UserApiModel.md @@ -0,0 +1,17 @@ +# UserApiModel + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**user_name** | **str** | | +**first_name** | **str** | | +**last_name** | **str** | | +**display_name** | **str** | | +**email** | **str** | | +**provider_id** | **str, none_type** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UserRoleAssignmentsApi.md b/docs/UserRoleAssignmentsApi.md new file mode 100644 index 00000000..bd3602a4 --- /dev/null +++ b/docs/UserRoleAssignmentsApi.md @@ -0,0 +1,190 @@ +# testit_api_client.UserRoleAssignmentsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_users_user_id_roles_role_id_delete**](UserRoleAssignmentsApi.md#api_v2_users_user_id_roles_role_id_delete) | **DELETE** /api/v2/users/{userId}/roles/{roleId} | +[**api_v2_users_user_id_roles_role_id_post**](UserRoleAssignmentsApi.md#api_v2_users_user_id_roles_role_id_post) | **POST** /api/v2/users/{userId}/roles/{roleId} | + + +# **api_v2_users_user_id_roles_role_id_delete** +> api_v2_users_user_id_roles_role_id_delete(user_id, role_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import user_role_assignments_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = user_role_assignments_api.UserRoleAssignmentsApi(api_client) + user_id = "userId_example" # str | + role_id = "roleId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_users_user_id_roles_role_id_delete(user_id, role_id) + except testit_api_client.ApiException as e: + print("Exception when calling UserRoleAssignmentsApi->api_v2_users_user_id_roles_role_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **role_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_users_user_id_roles_role_id_post** +> api_v2_users_user_id_roles_role_id_post(user_id, role_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import user_role_assignments_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = user_role_assignments_api.UserRoleAssignmentsApi(api_client) + user_id = "userId_example" # str | + role_id = "roleId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_users_user_id_roles_role_id_post(user_id, role_id) + except testit_api_client.ApiException as e: + print("Exception when calling UserRoleAssignmentsApi->api_v2_users_user_id_roles_role_id_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **role_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UserStoragesApi.md b/docs/UserStoragesApi.md new file mode 100644 index 00000000..4f1636f5 --- /dev/null +++ b/docs/UserStoragesApi.md @@ -0,0 +1,186 @@ +# testit_api_client.UserStoragesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_v2_user_storages_resource_get**](UserStoragesApi.md#api_v2_user_storages_resource_get) | **GET** /api/v2/user-storages/{resource} | +[**api_v2_user_storages_resource_post**](UserStoragesApi.md#api_v2_user_storages_resource_post) | **POST** /api/v2/user-storages/{resource} | + + +# **api_v2_user_storages_resource_get** +> api_v2_user_storages_resource_get(resource) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import user_storages_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = user_storages_api.UserStoragesApi(api_client) + resource = "resource_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_user_storages_resource_get(resource) + except testit_api_client.ApiException as e: + print("Exception when calling UserStoragesApi->api_v2_user_storages_resource_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **resource** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_user_storages_resource_post** +> api_v2_user_storages_resource_post(resource) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import user_storages_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = user_storages_api.UserStoragesApi(api_client) + resource = "resource_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_user_storages_resource_post(resource) + except testit_api_client.ApiException as e: + print("Exception when calling UserStoragesApi->api_v2_user_storages_resource_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **resource** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UsersApi.md b/docs/UsersApi.md index 95293611..93f08820 100644 --- a/docs/UsersApi.md +++ b/docs/UsersApi.md @@ -5,6 +5,9 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**api_v2_users_exists_get**](UsersApi.md#api_v2_users_exists_get) | **GET** /api/v2/users/exists | +[**api_v2_users_post**](UsersApi.md#api_v2_users_post) | **POST** /api/v2/users | +[**api_v2_users_user_id_delete**](UsersApi.md#api_v2_users_user_id_delete) | **DELETE** /api/v2/users/{userId} | +[**api_v2_users_user_id_get**](UsersApi.md#api_v2_users_user_id_get) | **GET** /api/v2/users/{userId} | # **api_v2_users_exists_get** @@ -15,7 +18,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -42,11 +45,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -76,7 +79,277 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_users_post** +> UserApiModel api_v2_users_post() + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import users_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.api_v2_users_post_request import ApiV2UsersPostRequest +from testit_api_client.model.user_api_model import UserApiModel +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = users_api.UsersApi(api_client) + api_v2_users_post_request = ApiV2UsersPostRequest(None) # ApiV2UsersPostRequest | (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.api_v2_users_post(api_v2_users_post_request=api_v2_users_post_request) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling UsersApi->api_v2_users_post: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **api_v2_users_post_request** | [**ApiV2UsersPostRequest**](ApiV2UsersPostRequest.md)| | [optional] + +### Return type + +[**UserApiModel**](UserApiModel.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_users_user_id_delete** +> api_v2_users_user_id_delete(user_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import users_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = users_api.UsersApi(api_client) + user_id = "userId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.api_v2_users_user_id_delete(user_id) + except testit_api_client.ApiException as e: + print("Exception when calling UsersApi->api_v2_users_user_id_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**409** | Conflict | - | +**422** | Unprocessable Entity | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **api_v2_users_user_id_get** +> UserApiModel api_v2_users_user_id_get(user_id) + + + +### Example + +* Api Key Authentication (PrivateToken): +* Api Key Authentication (Cookies): + +```python +import time +import testit_api_client +from testit_api_client.api import users_api +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.user_api_model import UserApiModel +from testit_api_client.model.validation_problem_details import ValidationProblemDetails +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = testit_api_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: PrivateToken +configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['PrivateToken'] = 'Bearer' + +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Cookies'] = 'Bearer' + +# Enter a context with an instance of the API client +with testit_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = users_api.UsersApi(api_client) + user_id = "userId_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.api_v2_users_user_id_get(user_id) + pprint(api_response) + except testit_api_client.ApiException as e: + print("Exception when calling UsersApi->api_v2_users_user_id_get: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + +### Return type + +[**UserApiModel**](UserApiModel.md) + +### Authorization + +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index 8f3de5ce..43ffa39e 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -24,7 +24,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -51,11 +51,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -84,7 +84,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -114,7 +114,7 @@ Get all webhooks ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -141,11 +141,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -176,7 +176,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -206,7 +206,7 @@ Delete webhook by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -232,11 +232,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -265,7 +265,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -295,7 +295,7 @@ Get webhook by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -322,11 +322,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -356,7 +356,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -386,7 +386,7 @@ Edit webhook by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -414,11 +414,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -459,7 +459,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -489,7 +489,7 @@ Create webhook ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -517,11 +517,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -552,7 +552,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -582,7 +582,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -610,11 +610,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -644,7 +644,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -674,7 +674,7 @@ Search for webhooks ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -702,11 +702,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -747,7 +747,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -777,7 +777,7 @@ Get special variables for webhook event type ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -805,11 +805,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -842,7 +842,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -872,7 +872,7 @@ Test webhook's url ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -900,11 +900,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -935,7 +935,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/WebhooksLogsApi.md b/docs/WebhooksLogsApi.md index 63a87c6b..e5f3e754 100644 --- a/docs/WebhooksLogsApi.md +++ b/docs/WebhooksLogsApi.md @@ -17,7 +17,7 @@ Get last webhook logs ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -44,11 +44,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -89,7 +89,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -119,7 +119,7 @@ Delete webhook log by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -145,11 +145,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -178,7 +178,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -208,7 +208,7 @@ Get webhook log by ID ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -235,11 +235,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -269,7 +269,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/WorkItemsApi.md b/docs/WorkItemsApi.md index 5bc16162..4c89324b 100644 --- a/docs/WorkItemsApi.md +++ b/docs/WorkItemsApi.md @@ -38,12 +38,12 @@ Method | HTTP request | Description Upload and link attachment to WorkItem - Use case User sets workItemId User attaches a file System creates attachment and links it to the work item System returns attachment identifier + Use case User sets workItemId User attaches a file System creates attachment and links it to the work item System returns attachment identifier ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -69,11 +69,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -112,7 +112,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -140,12 +140,12 @@ void (empty response body) Transform CheckList to TestCase - Use case User sets checklist identifier User runs method execution System transform CheckList to TestCase + Use case User sets checklist identifier User runs method execution System transform CheckList to TestCase ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -172,11 +172,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -206,7 +206,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -233,12 +233,12 @@ Name | Type | Description | Notes Get change history of WorkItem - Use case User sets work item identifier User runs method execution System return change history of WorkItem + Use case User sets work item identifier User runs method execution System return change history of WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -265,11 +265,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -318,7 +318,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -345,12 +345,12 @@ Name | Type | Description | Notes Delete like from WorkItem - Use case User sets WorkItem identifier User runs method execution System delete like from WorkItem + Use case User sets WorkItem identifier User runs method execution System delete like from WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -376,11 +376,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -409,7 +409,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -436,12 +436,12 @@ void (empty response body) Set like to WorkItem - Use case User sets WorkItem identifier User runs method execution System set like to WorkItem + Use case User sets WorkItem identifier User runs method execution System set like to WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -467,11 +467,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -500,7 +500,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -527,12 +527,12 @@ void (empty response body) Get likes count of WorkItem - Use case User sets WorkItem identifier User runs method execution System return likes count of WorkItem + Use case User sets WorkItem identifier User runs method execution System return likes count of WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -558,11 +558,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -592,7 +592,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -619,12 +619,12 @@ Name | Type | Description | Notes Get likes of WorkItem - Use case User sets WorkItem identifier User runs method execution System return likes of WorkItem + Use case User sets WorkItem identifier User runs method execution System return likes of WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -651,11 +651,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -685,7 +685,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -717,7 +717,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -744,17 +744,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" operation = [ Operation( value=None, @@ -785,7 +785,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | **operation** | [**[Operation]**](Operation.md)| | [optional] ### Return type @@ -794,7 +794,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -821,12 +821,12 @@ void (empty response body) Get test results history of WorkItem - Use case User sets WorkItem identifier User runs method execution System return test results history of WorkItem + Use case User sets WorkItem identifier User runs method execution System return test results history of WorkItem ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -853,11 +853,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -938,7 +938,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -965,12 +965,12 @@ Name | Type | Description | Notes Set WorkItem as actual - Use case User sets work item identifier User runs method execution System set WorkItem as actual + Use case User sets work item identifier User runs method execution System set WorkItem as actual ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -997,11 +997,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1033,7 +1033,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1063,7 +1063,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1091,11 +1091,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1135,7 +1135,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1162,12 +1162,12 @@ Name | Type | Description | Notes Move WorkItem to another section - Use case User sets WorkItem identifier User runs method execution System move WorkItem to another section + Use case User sets WorkItem identifier User runs method execution System move WorkItem to another section ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1195,11 +1195,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1230,7 +1230,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1260,7 +1260,7 @@ Creates work item ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1288,11 +1288,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1323,7 +1323,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1350,12 +1350,12 @@ Name | Type | Description | Notes Update Test Case, Checklist or Shared Step - Use case User sets work item properties (listed in request parameters) User runs method execution System updates work item by identifier System returns updated work item model (listed in response parameters) + Use case User sets work item properties (listed in request parameters) User runs method execution System updates work item by identifier System returns updated work item model (listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1382,11 +1382,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1416,7 +1416,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1429,10 +1429,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | -**400** | Field is required Priority is not a valid duration should be a positive number should be empty for CheckList There is no option in ProjectAttributesScheme with such Id Attribute value must be a valid guid for options scheme | - | +**400** | Field is required Priority is not a valid duration should be a positive number should be empty for CheckList There is no option in ProjectAttributesScheme with such Id Attribute value must be a valid guid for options scheme | - | **401** | Unauthorized | - | **403** | Update permission for test library required | - | -**404** | WorkItem not found Can't find section Can't attributesScheme Can't attribute AutoTestIds not exist in project | - | +**404** | WorkItem not found Can't find section Can't attributesScheme Can't attribute AutoTestIds not exist in project | - | **409** | Conflict | - | **422** | Unprocessable Entity | - | @@ -1446,7 +1446,7 @@ Search for work items ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1474,11 +1474,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1519,7 +1519,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1546,12 +1546,12 @@ Name | Type | Description | Notes Get SharedStep references in sections - Use case User sets SharedStep identifier User runs method execution System return SharedStep references + Use case User sets SharedStep identifier User runs method execution System return SharedStep references ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1579,11 +1579,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1634,7 +1634,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1661,12 +1661,12 @@ Name | Type | Description | Notes Get SharedStep references in work items - Use case User sets SharedStep identifier User runs method execution System return SharedStep references + Use case User sets SharedStep identifier User runs method execution System return SharedStep references ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1694,11 +1694,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1749,7 +1749,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1776,12 +1776,12 @@ Name | Type | Description | Notes Get SharedStep references - Use case User sets SharedStep identifier User runs method execution System return SharedStep references + Use case User sets SharedStep identifier User runs method execution System return SharedStep references ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1808,11 +1808,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -1842,7 +1842,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1869,12 +1869,12 @@ Name | Type | Description | Notes Delete all links AutoTests from WorkItem by Id or GlobalId - Use case User sets work item identifier User runs method execution System search work item by identifier System search and delete all autotests, related to found work item System returns no content response + Use case User sets work item identifier User runs method execution System search work item by identifier System search and delete all autotests, related to found work item System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1900,17 +1900,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" # example passing only required values which don't have defaults set try: @@ -1925,7 +1925,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | ### Return type @@ -1933,7 +1933,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -1961,12 +1961,12 @@ void (empty response body) Delete Test Case, Checklist or Shared Step by Id or GlobalId - Use case User sets work item identifier User runs method execution System deletes work item System returns no content response + Use case User sets work item identifier User runs method execution System deletes work item System returns no content response ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -1992,17 +1992,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" # example passing only required values which don't have defaults set try: @@ -2017,7 +2017,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | ### Return type @@ -2025,7 +2025,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2052,12 +2052,12 @@ void (empty response body) Get all AutoTests linked to WorkItem by Id or GlobalId - Use case User sets work item identifier User runs method execution System search work item by identifier System search all autotests, related to found work item System returns list of found autotests + Use case User sets work item identifier User runs method execution System search work item by identifier System search all autotests, related to found work item System returns list of found autotests ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2084,17 +2084,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" # example passing only required values which don't have defaults set try: @@ -2110,7 +2110,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | ### Return type @@ -2118,7 +2118,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2148,7 +2148,7 @@ Get iterations by work item Id or GlobalId ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2175,17 +2175,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" version_id = "00000000-0000-0000-0000-000000000000" # str | WorkItem version (guid format) identifier (optional) version_number = 0 # int | WorkItem version number (0 is the last version)\" (optional) @@ -2212,7 +2212,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | **version_id** | **str**| WorkItem version (guid format) identifier | [optional] **version_number** | **int**| WorkItem version number (0 is the last version)\" | [optional] @@ -2222,7 +2222,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2249,12 +2249,12 @@ Name | Type | Description | Notes Get Test Case, Checklist or Shared Step by Id or GlobalId - Use case User sets work item identifier [Optional] User sets work item version identifier [Optional] User sets work item version number User runs method execution System search work item by identifier [Optional] if User sets work item version identifier, system search work item version by identifier. [Optional] if user sets work item version number, system search work item version by number Otherwise, system search last work item version System returns work item + Use case User sets work item identifier [Optional] User sets work item version identifier [Optional] User sets work item version number User runs method execution System search work item by identifier [Optional] if User sets work item version identifier, system search work item version by identifier. [Optional] if user sets work item version number, system search work item version by number Otherwise, system search last work item version System returns work item ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2281,17 +2281,17 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" version_id = "00000000-0000-0000-0000-000000000000" # str | WorkItem version (guid format) identifier\" (optional) version_number = 0 # int | WorkItem version number (0 is the last version)\" (optional) @@ -2318,7 +2318,7 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | **version_id** | **str**| WorkItem version (guid format) identifier\" | [optional] **version_number** | **int**| WorkItem version number (0 is the last version)\" | [optional] @@ -2328,7 +2328,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2355,12 +2355,12 @@ Name | Type | Description | Notes Get WorkItem chronology by Id or GlobalId - Use case User sets work item identifier User runs method execution System search work item by identifier System search test results of all autotests, related to found work item System sort results by CompletedOn ascending, then by CreatedDate ascending System returns sorted collection of test results + Use case User sets work item identifier User runs method execution System search work item by identifier System search test results of all autotests, related to found work item System sort results by CompletedOn ascending, then by CreatedDate ascending System returns sorted collection of test results ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2387,11 +2387,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2421,7 +2421,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2448,12 +2448,12 @@ Name | Type | Description | Notes Get WorkItem versions - Use case User sets work item identifier [Optional] User sets work item version identifier User runs method execution System search work item by identifier [Optional] If User set work item version identifier, System search work item version by version identifier Otherwise, system search all version of work item System returns array of work item version models (listed in response example) + Use case User sets work item identifier [Optional] User sets work item version identifier User runs method execution System search work item by identifier [Optional] If User set work item version identifier, System search work item version by version identifier Otherwise, system search all version of work item System returns array of work item version models (listed in response example) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2480,19 +2480,19 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = work_items_api.WorkItemsApi(api_client) - id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" - work_item_version_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem version (guid format) identifier\" (optional) - version_number = 1 # int | WorkItem version (integer format) number\" (optional) + id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem internal (guid format) or global(integer format) identifier\" + work_item_version_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | WorkItem version (guid format) identifier\" (optional) + version_number = 1 # int | WorkItem version (integer format) number\" (optional) # example passing only required values which don't have defaults set try: @@ -2517,9 +2517,9 @@ with testit_api_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | - **work_item_version_id** | **str**| WorkItem version (guid format) identifier\" | [optional] - **version_number** | **int**| WorkItem version (integer format) number\" | [optional] + **id** | **str**| WorkItem internal (guid format) or global(integer format) identifier\" | + **work_item_version_id** | **str**| WorkItem version (guid format) identifier\" | [optional] + **version_number** | **int**| WorkItem version (integer format) number\" | [optional] ### Return type @@ -2527,7 +2527,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2557,7 +2557,7 @@ Permanently delete test case, checklist or shared steps from archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2583,11 +2583,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2616,7 +2616,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -2646,7 +2646,7 @@ Restore test case, checklist or shared steps from archive ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -2672,11 +2672,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -2705,7 +2705,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/WorkItemsCommentsApi.md b/docs/WorkItemsCommentsApi.md index 2b8bcbb3..48b09574 100644 --- a/docs/WorkItemsCommentsApi.md +++ b/docs/WorkItemsCommentsApi.md @@ -16,12 +16,12 @@ Method | HTTP request | Description Delete WorkItem comment - Use case User sets comment identifier User runs method execution System delete comment System returns success status code + Use case User sets comment identifier User runs method execution System delete comment System returns success status code ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -47,11 +47,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -80,7 +80,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -107,12 +107,12 @@ void (empty response body) Create WorkItem comment - Use case User sets comment properties (listed in request parameters) User runs method execution System creates comment System returns comment model (listed in response parameters) + Use case User sets comment properties (listed in request parameters) User runs method execution System creates comment System returns comment model (listed in response parameters) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -140,11 +140,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -175,7 +175,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -205,7 +205,7 @@ Update work item comment ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -232,11 +232,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -266,7 +266,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -296,7 +296,7 @@ Get work item comments count ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -322,11 +322,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -356,7 +356,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -386,7 +386,7 @@ Get work item comments ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -413,11 +413,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -447,7 +447,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/docs/WorkflowsApi.md b/docs/WorkflowsApi.md index 069151d3..7ad9a197 100644 --- a/docs/WorkflowsApi.md +++ b/docs/WorkflowsApi.md @@ -22,7 +22,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -48,11 +48,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -80,7 +80,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -110,7 +110,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -137,11 +137,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -170,7 +170,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -202,7 +202,7 @@ See RFC 690 ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -229,11 +229,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -277,7 +277,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -307,7 +307,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -335,11 +335,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -378,7 +378,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -408,7 +408,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -435,11 +435,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -476,7 +476,7 @@ void (empty response body) ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -506,7 +506,7 @@ void (empty response body) ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -533,11 +533,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -566,7 +566,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -596,7 +596,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -624,11 +624,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -658,7 +658,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers @@ -688,7 +688,7 @@ Name | Type | Description | Notes ### Example * Api Key Authentication (PrivateToken): -* Api Key Authentication (Identity.Application): +* Api Key Authentication (Cookies): ```python import time @@ -716,11 +716,11 @@ configuration.api_key['PrivateToken'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['PrivateToken'] = 'Bearer' -# Configure API key authorization: Identity.Application -configuration.api_key['Identity.Application'] = 'YOUR_API_KEY' +# Configure API key authorization: Cookies +configuration.api_key['Cookies'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Identity.Application'] = 'Bearer' +# configuration.api_key_prefix['Cookies'] = 'Bearer' # Enter a context with an instance of the API client with testit_api_client.ApiClient(configuration) as api_client: @@ -750,7 +750,7 @@ Name | Type | Description | Notes ### Authorization -[PrivateToken](../README.md#PrivateToken), [Identity.Application](../README.md#Identity.Application) +[PrivateToken](../README.md#PrivateToken), [Cookies](../README.md#Cookies) ### HTTP request headers diff --git a/genConfig.yml b/genConfig.yml index ab626dea..881ee54f 100644 --- a/genConfig.yml +++ b/genConfig.yml @@ -1,4 +1,4 @@ packageName: "testit_api_client" packageUrl: "https://pypi.org/project/testit-api-client/" -packageVersion: 7.5.11 +packageVersion: 7.6.0.post580 projectName: "testit-api-client" diff --git a/run.sh b/run.sh index 523f54bb..2440b8c1 100644 --- a/run.sh +++ b/run.sh @@ -1,8 +1,8 @@ #!/bin/bash # Настройка переменных -FILE_NAME="cloud-swagger.json" -NEW_VERSION="7.5.11" +FILE_NAME="swagger-v2-5.8.json" +NEW_VERSION="7.6.0.post580" GENERATOR="openapi-generator-cli-6.6.0.jar" if [ ! -f ".swagger/$FILE_NAME" ]; then diff --git a/setup.py b/setup.py index 3f7ecc91..565daca1 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ NAME = "testit-api-client" -VERSION = "7.5.11" +VERSION = "7.6.0.post580" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ diff --git a/src/testit_api_client/__init__.py b/src/testit_api_client/__init__.py index 2e3d5476..5e112c86 100644 --- a/src/testit_api_client/__init__.py +++ b/src/testit_api_client/__init__.py @@ -10,7 +10,7 @@ """ -__version__ = "7.5.11" +__version__ = "7.6.0.post580" # import ApiClient from testit_api_client.api_client import ApiClient diff --git a/src/testit_api_client/api/__init__.py b/src/testit_api_client/api/__init__.py index dad211d1..30e3592e 100644 --- a/src/testit_api_client/api/__init__.py +++ b/src/testit_api_client/api/__init__.py @@ -1,3 +1,3 @@ # do not import all apis into this module because that uses a lot of memory and stack frames # if you need the ability to import all apis from one package, import them with -# from testit_api_client.apis import AttachmentsApi +# from testit_api_client.apis import AIServicesAPIApi diff --git a/src/testit_api_client/api/ai_services_api_api.py b/src/testit_api_client/api/ai_services_api_api.py new file mode 100644 index 00000000..9fdda5fc --- /dev/null +++ b/src/testit_api_client/api/ai_services_api_api.py @@ -0,0 +1,182 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.ai_service_model_api_result_i_reply import AIServiceModelApiResultIReply +from testit_api_client.model.api_v2_external_services_id_ai_models_post_request import ApiV2ExternalServicesIdAiModelsPostRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class AIServicesAPIApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_external_services_id_ai_models_post_endpoint = _Endpoint( + settings={ + 'response_type': (AIServiceModelApiResultIReply,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/external-services/{id}/ai/models', + 'operation_id': 'api_v2_external_services_id_ai_models_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'api_v2_external_services_id_ai_models_post_request', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'api_v2_external_services_id_ai_models_post_request': + (ApiV2ExternalServicesIdAiModelsPostRequest,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'api_v2_external_services_id_ai_models_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def api_v2_external_services_id_ai_models_post( + self, + id, + **kwargs + ): + """Ask for models with inquiry filter, cached # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_external_services_id_ai_models_post(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + api_v2_external_services_id_ai_models_post_request (ApiV2ExternalServicesIdAiModelsPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + AIServiceModelApiResultIReply + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_external_services_id_ai_models_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/attachments_api.py b/src/testit_api_client/api/attachments_api.py index cf1e85cd..9d852e6e 100644 --- a/src/testit_api_client/api/attachments_api.py +++ b/src/testit_api_client/api/attachments_api.py @@ -43,7 +43,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/attachments/{id}', 'operation_id': 'api_v2_attachments_id_delete', @@ -95,7 +95,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/attachments/{id}', 'operation_id': 'api_v2_attachments_id_get', @@ -192,7 +192,7 @@ def __init__(self, api_client=None): 'response_type': (AttachmentModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/attachments/{id}/metadata', 'operation_id': 'api_v2_attachments_id_metadata_get', @@ -244,7 +244,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/attachments/occupiedFileStorageSize', 'operation_id': 'api_v2_attachments_occupied_file_storage_size_get', @@ -289,7 +289,7 @@ def __init__(self, api_client=None): 'response_type': (AttachmentModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/attachments', 'operation_id': 'api_v2_attachments_post', @@ -671,7 +671,7 @@ def api_v2_attachments_post( ): """Upload new attachment file # noqa: E501 - File size is restricted to 50 MB (52 428 800 bytes) # noqa: E501 + File size is restricted to 1 GB (1 073 741 824 bytes) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/auto_tests_api.py b/src/testit_api_client/api/auto_tests_api.py index 97dfdca3..8fc83762 100644 --- a/src/testit_api_client/api/auto_tests_api.py +++ b/src/testit_api_client/api/auto_tests_api.py @@ -59,7 +59,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestBulkDeleteApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests', 'operation_id': 'api_v2_auto_tests_delete', @@ -110,7 +110,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/flaky/bulk', 'operation_id': 'api_v2_auto_tests_flaky_bulk_post', @@ -186,7 +186,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}', 'operation_id': 'api_v2_auto_tests_id_patch', @@ -244,7 +244,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestResultHistoryApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/testResults/search', 'operation_id': 'api_v2_auto_tests_id_test_results_search_post', @@ -327,7 +327,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/workItems/changed/id', 'operation_id': 'api_v2_auto_tests_id_work_items_changed_id_get', @@ -379,7 +379,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/workItems/changed/{workItemId}/approve', 'operation_id': 'api_v2_auto_tests_id_work_items_changed_work_item_id_approve_post', @@ -437,7 +437,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/search', 'operation_id': 'api_v2_auto_tests_search_post', @@ -513,7 +513,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests', 'operation_id': 'create_auto_test', @@ -564,7 +564,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/bulk', 'operation_id': 'create_multiple', @@ -620,7 +620,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}', 'operation_id': 'delete_auto_test', @@ -672,7 +672,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/workItems', 'operation_id': 'delete_auto_test_link_from_work_item', @@ -729,7 +729,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests', 'operation_id': 'get_all_auto_tests', @@ -905,7 +905,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestAverageDurationApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/averageDuration', 'operation_id': 'get_auto_test_average_duration', @@ -957,7 +957,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}', 'operation_id': 'get_auto_test_by_id', @@ -1009,7 +1009,7 @@ def __init__(self, api_client=None): 'response_type': ([TestResultChronologyModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/chronology', 'operation_id': 'get_auto_test_chronology', @@ -1061,7 +1061,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunByAutoTestApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/testRuns', 'operation_id': 'get_test_runs', @@ -1113,7 +1113,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestWorkItemIdentifierApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/workItems', 'operation_id': 'get_work_items_linked_to_auto_test', @@ -1175,7 +1175,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/{id}/workItems', 'operation_id': 'link_auto_test_to_work_item', @@ -1233,7 +1233,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests', 'operation_id': 'update_auto_test', @@ -1284,7 +1284,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/autoTests/bulk', 'operation_id': 'update_multiple', @@ -1415,7 +1415,7 @@ def api_v2_auto_tests_flaky_bulk_post( ): """Set \"Flaky\" status for multiple autotests # noqa: E501 - User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 + User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1584,7 +1584,7 @@ def api_v2_auto_tests_id_test_results_search_post( ): """Get test results history for autotest # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier User sets getTestResultHistoryReportQuery (listed in the example) User runs method execution System search for test results using filters set by user in getTestResultHistoryReportQuery and id System returns the enumeration of test results # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier User sets getTestResultHistoryReportQuery (listed in the example) User runs method execution System search for test results using filters set by user in getTestResultHistoryReportQuery and id System returns the enumeration of test results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1673,7 +1673,7 @@ def api_v2_auto_tests_id_work_items_changed_id_get( ): """Get identifiers of changed linked work items # noqa: E501 - User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 + User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1757,7 +1757,7 @@ def api_v2_auto_tests_id_work_items_changed_work_item_id_approve_post( ): """Approve changes to work items linked to autotest # noqa: E501 - User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 + User permissions for project: - Read only - Execute - Write - Full control # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1925,7 +1925,7 @@ def create_auto_test( ): """Create autotest # noqa: E501 - This method creates a new autotest. To add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method. Use the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan. # noqa: E501 + This method creates a new autotest. To add an autotest to the test plan, link it to a work item using the `POST /api/v2/autoTests/{autoTestId}/workItems` method. Use the `POST /api/v2/testRuns/byAutoTests` method to run autotest outside the test plan. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2004,7 +2004,7 @@ def create_multiple( ): """Create multiple autotests # noqa: E501 - Use case User sets autotest parameters (listed in the example) and runs method execution System creates autotest [Optional] If steps enumeration is set, system creates step items and relates them to autotest [Optional] If setup enumeration is set, system creates setup items and relates them to autotest [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest [Optional] If label enumeration is set, system creates labels and relates them to autotest [Optional] If link enumeration is set, system creates links and relates them to autotest System returns autotest model (example listed in response parameters) # noqa: E501 + Use case User sets autotest parameters (listed in the example) and runs method execution System creates autotest [Optional] If steps enumeration is set, system creates step items and relates them to autotest [Optional] If setup enumeration is set, system creates setup items and relates them to autotest [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest [Optional] If label enumeration is set, system creates labels and relates them to autotest [Optional] If link enumeration is set, system creates links and relates them to autotest System returns autotest model (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2084,7 +2084,7 @@ def delete_auto_test( ): """Delete autotest # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier and runs method execution System finds the autotest by the identifier System deletes autotest and returns no content response # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier and runs method execution System finds the autotest by the identifier System deletes autotest and returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2167,7 +2167,7 @@ def delete_auto_test_link_from_work_item( ): """Unlink autotest from work item # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier [Optional] User sets workitem internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier [Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it from autotest. [Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest. System returns no content response # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier [Optional] User sets workitem internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier [Optional] if workitem id is set by User, System finds the workitem by the workitem identifier and unlinks it from autotest. [Optional] Otherwise, if workitem id is not specified, System unlinks all workitems linked to autotest. System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2354,7 +2354,7 @@ def get_auto_test_average_duration( ): """Get average autotest duration # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System calculates pass average duration and fail average duration of autotest from all related test results System returns pass average duration and fail average duration for autotest # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System calculates pass average duration and fail average duration of autotest from all related test results System returns pass average duration and fail average duration for autotest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2437,7 +2437,7 @@ def get_auto_test_by_id( ): """Get autotest by internal or global ID # noqa: E501 - Use case User sets autotest internal or global identifier and runs method execution System returns autotest, which internal or global identifier equals the identifier value set in the previous action # noqa: E501 + Use case User sets autotest internal or global identifier and runs method execution System returns autotest, which internal or global identifier equals the identifier value set in the previous action # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2520,7 +2520,7 @@ def get_auto_test_chronology( ): """Get autotest chronology # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search all test results related to autotest (with default limit equal 100) System orders the test results by CompletedOn property descending and then orders by CreatedDate property descending System returns test result chronology for autotest # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search all test results related to autotest (with default limit equal 100) System orders the test results by CompletedOn property descending and then orders by CreatedDate property descending System returns test result chronology for autotest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2603,7 +2603,7 @@ def get_test_runs( ): """Get completed tests runs for autotests # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search for all test runs related to the autotest System returns the enumeration of test runs # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier User runs method execution System search for all test runs related to the autotest System returns the enumeration of test runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2686,7 +2686,7 @@ def get_work_items_linked_to_auto_test( ): """Get work items linked to autotest # noqa: E501 - This method links an autotest to a test case or a checklist. A manual test case with a linked automated work item is marked in the test management system as an autotest. You can run it from graphical user interface (GUI). To do that: 1. Open the project in GUI. 2. Go to Test plans section and switch to the Execution tab. 3. Select the autotest(s) you want to run using checkboxes. 4. In the toolbar above the test list, click Run autotests. # noqa: E501 + This method links an autotest to a test case or a checklist. A manual test case with a linked automated work item is marked in the test management system as an autotest. You can run it from graphical user interface (GUI). To do that: 1. Open the project in GUI. 2. Go to Test plans section and switch to the Execution tab. 3. Select the autotest(s) you want to run using checkboxes. 4. In the toolbar above the test list, click Run autotests. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2694,7 +2694,7 @@ def get_work_items_linked_to_auto_test( >>> result = thread.get() Args: - id (str): Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. + id (str): Specifies the autotest entity ID. You can copy it from the address bar in your web browser or use autotest GUID. Keyword Args: is_deleted (bool): Specifies that a test is deleted or still relevant.. [optional] @@ -2771,7 +2771,7 @@ def link_auto_test_to_work_item( ): """Link autotest with work items # noqa: E501 - Use case User sets autotest internal (guid format) or global (integer format) identifier User sets work item internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier System finds the work item by the work item identifier System relates the work item with the autotest and returns no content response # noqa: E501 + Use case User sets autotest internal (guid format) or global (integer format) identifier User sets work item internal (guid format) or global (integer format) identifier User runs method execution System finds the autotest by the autotest identifier System finds the work item by the work item identifier System relates the work item with the autotest and returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2854,7 +2854,7 @@ def update_auto_test( ): """Update autotest # noqa: E501 - Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response # noqa: E501 + Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2933,7 +2933,7 @@ def update_multiple( ): """Update multiple autotests # noqa: E501 - Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response # noqa: E501 + Use case User sets autotest updated parameters values (listed in the example) and runs method execution System finds the autotest by the identifier System updates autotest parameters [Optional] If steps enumeration is set, system creates step items, relates them to autotest and deletes relations with current steps( if exist) [Optional] If Setup enumeration is set, system creates setup items and relates them to autotest and deletes relations with current Setup items (if exist) [Optional] If teardown enumeration is set, system creates teardown items and relates them to autotest and deletes relations with current teardown items (if exist) [Optional] If label enumeration is set, system creates labels and relates them to autotest and deletes relations with current Labels (if exist) [Optional] If link enumeration is set, system creates links and relates them to autotest and deletes relations with current Links (if exist) System updates autotest and returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/background_jobs_api.py b/src/testit_api_client/api/background_jobs_api.py index 3e176d68..99529934 100644 --- a/src/testit_api_client/api/background_jobs_api.py +++ b/src/testit_api_client/api/background_jobs_api.py @@ -44,7 +44,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs/completed', 'operation_id': 'api_v2_background_jobs_completed_delete', @@ -89,7 +89,7 @@ def __init__(self, api_client=None): 'response_type': ([BackgroundJobGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs', 'operation_id': 'api_v2_background_jobs_get', @@ -159,7 +159,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs/{id}/cancel', 'operation_id': 'api_v2_background_jobs_id_cancel_post', @@ -211,7 +211,7 @@ def __init__(self, api_client=None): 'response_type': (BackgroundJobGetModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs/{id}', 'operation_id': 'api_v2_background_jobs_id_get', @@ -263,7 +263,7 @@ def __init__(self, api_client=None): 'response_type': (BackgroundJobState,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs/{id}/status', 'operation_id': 'api_v2_background_jobs_id_status_get', @@ -315,7 +315,7 @@ def __init__(self, api_client=None): 'response_type': ([BackgroundJobGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/backgroundJobs/search', 'operation_id': 'api_v2_background_jobs_search_post', diff --git a/src/testit_api_client/api/configurations_api.py b/src/testit_api_client/api/configurations_api.py index 5a73d1ed..aa830480 100644 --- a/src/testit_api_client/api/configurations_api.py +++ b/src/testit_api_client/api/configurations_api.py @@ -49,7 +49,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/createByParameters', 'operation_id': 'api_v2_configurations_create_by_parameters_post', @@ -100,7 +100,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/delete/bulk', 'operation_id': 'api_v2_configurations_delete_bulk_post', @@ -151,7 +151,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/{id}', 'operation_id': 'api_v2_configurations_id_delete', @@ -203,7 +203,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/{id}', 'operation_id': 'api_v2_configurations_id_patch', @@ -261,7 +261,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/{id}/purge', 'operation_id': 'api_v2_configurations_id_purge_post', @@ -313,7 +313,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/{id}/restore', 'operation_id': 'api_v2_configurations_id_restore_post', @@ -365,7 +365,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/purge/bulk', 'operation_id': 'api_v2_configurations_purge_bulk_post', @@ -416,7 +416,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations', 'operation_id': 'api_v2_configurations_put', @@ -467,7 +467,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/restore/bulk', 'operation_id': 'api_v2_configurations_restore_bulk_post', @@ -518,7 +518,7 @@ def __init__(self, api_client=None): 'response_type': ([ConfigurationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/search', 'operation_id': 'api_v2_configurations_search_post', @@ -594,7 +594,7 @@ def __init__(self, api_client=None): 'response_type': (ConfigurationModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations', 'operation_id': 'create_configuration', @@ -645,7 +645,7 @@ def __init__(self, api_client=None): 'response_type': (ConfigurationModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/configurations/{id}', 'operation_id': 'get_configuration_by_id', @@ -1502,7 +1502,7 @@ def create_configuration( ): """Create Configuration # noqa: E501 - Use case User sets configuration model (listed in the request example) User runs method execution System creates configuration System returns created configuration (listed in the response example) # noqa: E501 + Use case User sets configuration model (listed in the request example) User runs method execution System creates configuration System returns created configuration (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1582,7 +1582,7 @@ def get_configuration_by_id( ): """Get configuration by internal or global ID # noqa: E501 - Use case User sets configuration internal (guid format) or global (integer format) identifier User runs method execution System search configuration using the identifier System returns configuration # noqa: E501 + Use case User sets configuration internal (guid format) or global (integer format) identifier User runs method execution System search configuration using the identifier System returns configuration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/custom_attribute_templates_api.py b/src/testit_api_client/api/custom_attribute_templates_api.py index d450ed01..57c06fb2 100644 --- a/src/testit_api_client/api/custom_attribute_templates_api.py +++ b/src/testit_api_client/api/custom_attribute_templates_api.py @@ -47,7 +47,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeTemplateValidationResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/exists', 'operation_id': 'api_v2_custom_attributes_templates_exists_get', @@ -97,7 +97,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/{id}/customAttributes/exclude', 'operation_id': 'api_v2_custom_attributes_templates_id_custom_attributes_exclude_post', @@ -159,7 +159,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/{id}/customAttributes/include', 'operation_id': 'api_v2_custom_attributes_templates_id_custom_attributes_include_post', @@ -221,7 +221,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/{id}', 'operation_id': 'api_v2_custom_attributes_templates_id_delete', @@ -273,7 +273,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeTemplateModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/{id}', 'operation_id': 'api_v2_custom_attributes_templates_id_get', @@ -325,7 +325,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeTemplateModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/{name}', 'operation_id': 'api_v2_custom_attributes_templates_name_get', @@ -377,7 +377,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeTemplateModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates', 'operation_id': 'api_v2_custom_attributes_templates_post', @@ -428,7 +428,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates', 'operation_id': 'api_v2_custom_attributes_templates_put', @@ -479,7 +479,7 @@ def __init__(self, api_client=None): 'response_type': ([SearchCustomAttributeTemplateGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/templates/search', 'operation_id': 'api_v2_custom_attributes_templates_search_post', @@ -636,7 +636,7 @@ def api_v2_custom_attributes_templates_id_custom_attributes_exclude_post( ): """Exclude CustomAttributes from CustomAttributeTemplate # noqa: E501 - Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System delete attributes from attributes tempalte # noqa: E501 + Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System delete attributes from attributes tempalte # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -720,7 +720,7 @@ def api_v2_custom_attributes_templates_id_custom_attributes_include_post( ): """Include CustomAttributes to CustomAttributeTemplate # noqa: E501 - Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System add attributes to attributes tempalte # noqa: E501 + Use case User sets attribute template internal identifier User sets attribute internal identifiers User runs method execution System add attributes to attributes tempalte # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -804,7 +804,7 @@ def api_v2_custom_attributes_templates_id_delete( ): """Delete CustomAttributeTemplate # noqa: E501 - Use case User sets attribute template internal identifier User runs method execution System search and delete attribute template System returns no content response # noqa: E501 + Use case User sets attribute template internal identifier User runs method execution System search and delete attribute template System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -887,7 +887,7 @@ def api_v2_custom_attributes_templates_id_get( ): """Get CustomAttributeTemplate by ID # noqa: E501 - Use case User sets attribute template internal identifier User runs method execution System return attribute template (listed in response example) # noqa: E501 + Use case User sets attribute template internal identifier User runs method execution System return attribute template (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -970,7 +970,7 @@ def api_v2_custom_attributes_templates_name_get( ): """Get CustomAttributeTemplate by name # noqa: E501 - Use case User sets attribute template name User runs method execution System search and return list of attribute templates (listed in response example) # noqa: E501 + Use case User sets attribute template name User runs method execution System search and return list of attribute templates (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1052,7 +1052,7 @@ def api_v2_custom_attributes_templates_post( ): """Create CustomAttributeTemplate # noqa: E501 - Use case User sets attribute template parameters (listed in request example) User runs method execution System creates attribute template System returns attribute template model (example listed in response parameters) # noqa: E501 + Use case User sets attribute template parameters (listed in request example) User runs method execution System creates attribute template System returns attribute template model (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1209,7 +1209,7 @@ def api_v2_custom_attributes_templates_search_post( ): """Search CustomAttributeTemplates # noqa: E501 - Use case User sets search params model (listed in request example) User runs method execution System return attribute templates (listed in response example) # noqa: E501 + Use case User sets search params model (listed in request example) User runs method execution System return attribute templates (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/custom_attributes_api.py b/src/testit_api_client/api/custom_attributes_api.py index daf82d92..a37f5403 100644 --- a/src/testit_api_client/api/custom_attributes_api.py +++ b/src/testit_api_client/api/custom_attributes_api.py @@ -47,7 +47,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeValidationResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/exists', 'operation_id': 'api_v2_custom_attributes_exists_get', @@ -102,7 +102,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/global/{id}', 'operation_id': 'api_v2_custom_attributes_global_id_delete', @@ -154,7 +154,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/global/{id}', 'operation_id': 'api_v2_custom_attributes_global_id_put', @@ -212,7 +212,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/global', 'operation_id': 'api_v2_custom_attributes_global_post', @@ -263,7 +263,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/{id}', 'operation_id': 'api_v2_custom_attributes_id_get', @@ -315,7 +315,7 @@ def __init__(self, api_client=None): 'response_type': ([CustomAttributeSearchResponseModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/customAttributes/search', 'operation_id': 'api_v2_custom_attributes_search_post', diff --git a/src/testit_api_client/api/external_issues_api.py b/src/testit_api_client/api/external_issues_api.py index e1f4ad80..dda1bf8a 100644 --- a/src/testit_api_client/api/external_issues_api.py +++ b/src/testit_api_client/api/external_issues_api.py @@ -43,7 +43,7 @@ def __init__(self, api_client=None): 'response_type': (ExternalIssueApiFieldSuggestionIReply,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/external-issues/suggestions', 'operation_id': 'api_v2_external_issues_suggestions_post', diff --git a/src/testit_api_client/api/external_services_api.py b/src/testit_api_client/api/external_services_api.py new file mode 100644 index 00000000..a28ab9f9 --- /dev/null +++ b/src/testit_api_client/api/external_services_api.py @@ -0,0 +1,162 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.external_services_metadata_api_result import ExternalServicesMetadataApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class ExternalServicesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_external_services_metadata_get_endpoint = _Endpoint( + settings={ + 'response_type': (ExternalServicesMetadataApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/external-services/metadata', + 'operation_id': 'api_v2_external_services_metadata_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def api_v2_external_services_metadata_get( + self, + **kwargs + ): + """Retrieves the metadata for all available external services # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_external_services_metadata_get(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ExternalServicesMetadataApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_external_services_metadata_get_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/failure_categories_api.py b/src/testit_api_client/api/failure_categories_api.py new file mode 100644 index 00000000..5d715516 --- /dev/null +++ b/src/testit_api_client/api/failure_categories_api.py @@ -0,0 +1,1954 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.api_v2_autotests_result_reasons_post_request import ApiV2AutotestsResultReasonsPostRequest +from testit_api_client.model.api_v2_autotests_result_reasons_put_request import ApiV2AutotestsResultReasonsPutRequest +from testit_api_client.model.api_v2_autotests_result_reasons_search_post_request import ApiV2AutotestsResultReasonsSearchPostRequest +from testit_api_client.model.autotest_result_reason_short_get_model import AutotestResultReasonShortGetModel +from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult +from testit_api_client.model.failure_category_group_item_api_result_reply import FailureCategoryGroupItemApiResultReply +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class FailureCategoriesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_autotests_failure_categories_grouping_search_post_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryGroupItemApiResultReply,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories/grouping-search', + 'operation_id': 'api_v2_autotests_failure_categories_grouping_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_grouping_search_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_grouping_search_post_request': + (ApiV2AutotestsResultReasonsGroupingSearchPostRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_grouping_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories/{id}', + 'operation_id': 'api_v2_autotests_failure_categories_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_id_get_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories/{id}', + 'operation_id': 'api_v2_autotests_failure_categories_id_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'is_deleted', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'is_deleted': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'is_deleted': 'isDeleted', + }, + 'location_map': { + 'id': 'path', + 'is_deleted': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_name_name_exists_get_endpoint = _Endpoint( + settings={ + 'response_type': (bool,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories/name/{name}/exists', + 'operation_id': 'api_v2_autotests_failure_categories_name_name_exists_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + ], + 'required': [ + 'name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + }, + 'attribute_map': { + 'name': 'name', + }, + 'location_map': { + 'name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_post_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories', + 'operation_id': 'api_v2_autotests_failure_categories_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_post_request': + (ApiV2AutotestsResultReasonsPostRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_put_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories', + 'operation_id': 'api_v2_autotests_failure_categories_put', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_put_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_put_request': + (ApiV2AutotestsResultReasonsPutRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_put_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_failure_categories_search_post_endpoint = _Endpoint( + settings={ + 'response_type': ([AutotestResultReasonShortGetModel],), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/failure-categories/search', + 'operation_id': 'api_v2_autotests_failure_categories_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'skip', + 'take', + 'order_by', + 'search_field', + 'search_value', + 'api_v2_autotests_result_reasons_search_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'skip': + (int,), + 'take': + (int,), + 'order_by': + (str,), + 'search_field': + (str,), + 'search_value': + (str,), + 'api_v2_autotests_result_reasons_search_post_request': + (ApiV2AutotestsResultReasonsSearchPostRequest,), + }, + 'attribute_map': { + 'skip': 'Skip', + 'take': 'Take', + 'order_by': 'OrderBy', + 'search_field': 'SearchField', + 'search_value': 'SearchValue', + }, + 'location_map': { + 'skip': 'query', + 'take': 'query', + 'order_by': 'query', + 'search_field': 'query', + 'search_value': 'query', + 'api_v2_autotests_result_reasons_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_grouping_search_post_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryGroupItemApiResultReply,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons/grouping-search', + 'operation_id': 'api_v2_autotests_result_reasons_grouping_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_grouping_search_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_grouping_search_post_request': + (ApiV2AutotestsResultReasonsGroupingSearchPostRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_grouping_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons/{id}', + 'operation_id': 'api_v2_autotests_result_reasons_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_id_get_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons/{id}', + 'operation_id': 'api_v2_autotests_result_reasons_id_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'is_deleted', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'is_deleted': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'is_deleted': 'isDeleted', + }, + 'location_map': { + 'id': 'path', + 'is_deleted': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_name_name_exists_get_endpoint = _Endpoint( + settings={ + 'response_type': (bool,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons/name/{name}/exists', + 'operation_id': 'api_v2_autotests_result_reasons_name_name_exists_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'name', + ], + 'required': [ + 'name', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'name': + (str,), + }, + 'attribute_map': { + 'name': 'name', + }, + 'location_map': { + 'name': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_post_endpoint = _Endpoint( + settings={ + 'response_type': (FailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons', + 'operation_id': 'api_v2_autotests_result_reasons_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_post_request': + (ApiV2AutotestsResultReasonsPostRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_put_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons', + 'operation_id': 'api_v2_autotests_result_reasons_put', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_autotests_result_reasons_put_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_autotests_result_reasons_put_request': + (ApiV2AutotestsResultReasonsPutRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_autotests_result_reasons_put_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_autotests_result_reasons_search_post_endpoint = _Endpoint( + settings={ + 'response_type': ([AutotestResultReasonShortGetModel],), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/autotests/resultReasons/search', + 'operation_id': 'api_v2_autotests_result_reasons_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'skip', + 'take', + 'order_by', + 'search_field', + 'search_value', + 'api_v2_autotests_result_reasons_search_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'skip': + (int,), + 'take': + (int,), + 'order_by': + (str,), + 'search_field': + (str,), + 'search_value': + (str,), + 'api_v2_autotests_result_reasons_search_post_request': + (ApiV2AutotestsResultReasonsSearchPostRequest,), + }, + 'attribute_map': { + 'skip': 'Skip', + 'take': 'Take', + 'order_by': 'OrderBy', + 'search_field': 'SearchField', + 'search_value': 'SearchValue', + }, + 'location_map': { + 'skip': 'query', + 'take': 'query', + 'order_by': 'query', + 'search_field': 'query', + 'search_value': 'query', + 'api_v2_autotests_result_reasons_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def api_v2_autotests_failure_categories_grouping_search_post( + self, + **kwargs + ): + """Get failure categories with support for filtering, sorting and grouping # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_grouping_search_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_grouping_search_post_request (ApiV2AutotestsResultReasonsGroupingSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryGroupItemApiResultReply + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_failure_categories_grouping_search_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_id_delete( + self, + id, + **kwargs + ): + """Delete failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_id_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_autotests_failure_categories_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_id_get( + self, + id, + **kwargs + ): + """Get failure category by ID # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_id_get(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + is_deleted (bool): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_autotests_failure_categories_id_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_name_name_exists_get( + self, + name, + **kwargs + ): + """Check failure category with the specified name already exists # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_name_name_exists_get(name, async_req=True) + >>> result = thread.get() + + Args: + name (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['name'] = \ + name + return self.api_v2_autotests_failure_categories_name_name_exists_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_post( + self, + **kwargs + ): + """Create failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_post_request (ApiV2AutotestsResultReasonsPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_failure_categories_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_put( + self, + **kwargs + ): + """Update failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_put(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_put_request (ApiV2AutotestsResultReasonsPutRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_failure_categories_put_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_failure_categories_search_post( + self, + **kwargs + ): + """api_v2_autotests_failure_categories_search_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_failure_categories_search_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + skip (int): Amount of items to be skipped (offset). [optional] + take (int): Amount of items to be taken (limit). [optional] + order_by (str): SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC). [optional] + search_field (str): Property name for searching. [optional] + search_value (str): Value for searching. [optional] + api_v2_autotests_result_reasons_search_post_request (ApiV2AutotestsResultReasonsSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [AutotestResultReasonShortGetModel] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_failure_categories_search_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_grouping_search_post( + self, + **kwargs + ): + """Get failure categories with support for filtering, sorting and grouping # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_grouping_search_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_grouping_search_post_request (ApiV2AutotestsResultReasonsGroupingSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryGroupItemApiResultReply + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_result_reasons_grouping_search_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_id_delete( + self, + id, + **kwargs + ): + """Delete failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_id_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_autotests_result_reasons_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_id_get( + self, + id, + **kwargs + ): + """Get failure category by ID # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_id_get(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + is_deleted (bool): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_autotests_result_reasons_id_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_name_name_exists_get( + self, + name, + **kwargs + ): + """Check failure category with the specified name already exists # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_name_name_exists_get(name, async_req=True) + >>> result = thread.get() + + Args: + name (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + bool + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['name'] = \ + name + return self.api_v2_autotests_result_reasons_name_name_exists_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_post( + self, + **kwargs + ): + """Create failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_post_request (ApiV2AutotestsResultReasonsPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + FailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_result_reasons_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_put( + self, + **kwargs + ): + """Update failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_put(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_autotests_result_reasons_put_request (ApiV2AutotestsResultReasonsPutRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_result_reasons_put_endpoint.call_with_http_info(**kwargs) + + def api_v2_autotests_result_reasons_search_post( + self, + **kwargs + ): + """api_v2_autotests_result_reasons_search_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_autotests_result_reasons_search_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + skip (int): Amount of items to be skipped (offset). [optional] + take (int): Amount of items to be taken (limit). [optional] + order_by (str): SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC). [optional] + search_field (str): Property name for searching. [optional] + search_value (str): Value for searching. [optional] + api_v2_autotests_result_reasons_search_post_request (ApiV2AutotestsResultReasonsSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [AutotestResultReasonShortGetModel] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_autotests_result_reasons_search_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/notifications_api.py b/src/testit_api_client/api/notifications_api.py index ffaadb0a..79d6f134 100644 --- a/src/testit_api_client/api/notifications_api.py +++ b/src/testit_api_client/api/notifications_api.py @@ -44,7 +44,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/notifications/count', 'operation_id': 'api_v2_notifications_count_get', @@ -94,7 +94,7 @@ def __init__(self, api_client=None): 'response_type': ([NotificationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/notifications', 'operation_id': 'api_v2_notifications_get', @@ -169,7 +169,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/notifications/{id}/read', 'operation_id': 'api_v2_notifications_id_read_post', @@ -221,7 +221,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/notifications/read', 'operation_id': 'api_v2_notifications_read_post', @@ -266,7 +266,7 @@ def __init__(self, api_client=None): 'response_type': ([NotificationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/notifications/search', 'operation_id': 'api_v2_notifications_search_post', @@ -344,7 +344,7 @@ def api_v2_notifications_count_get( ): """Get unread Notifications total in last 7 days # noqa: E501 - Use case User runs method execution System returns unread notifications total (listed in the response example) # noqa: E501 + Use case User runs method execution System returns unread notifications total (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -423,7 +423,7 @@ def api_v2_notifications_get( ): """Get all Notifications for current User # noqa: E501 - Use case User runs method execution System returns notifications (listed in the response example) # noqa: E501 + Use case User runs method execution System returns notifications (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -508,7 +508,7 @@ def api_v2_notifications_id_read_post( ): """Set Notification as read # noqa: E501 - Use case User sets notification internal (guid format) identifier User runs method execution System set notification as read # noqa: E501 + Use case User sets notification internal (guid format) identifier User runs method execution System set notification as read # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -590,7 +590,7 @@ def api_v2_notifications_read_post( ): """Set all Notifications as read # noqa: E501 - Use case User runs method execution System set all notifications as read # noqa: E501 + Use case User runs method execution System set all notifications as read # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -668,7 +668,7 @@ def api_v2_notifications_search_post( ): """Search Notifications for current User # noqa: E501 - Use case User set filter and runs method execution System returns notifications (listed in the response example) # noqa: E501 + Use case User set filter and runs method execution System returns notifications (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/open_id_connections_api.py b/src/testit_api_client/api/open_id_connections_api.py index 9c23ea1f..266120ef 100644 --- a/src/testit_api_client/api/open_id_connections_api.py +++ b/src/testit_api_client/api/open_id_connections_api.py @@ -42,7 +42,7 @@ def __init__(self, api_client=None): 'response_type': ([OpenIdConnectionClientShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/openid-connections', 'operation_id': 'api_v2_openid_connections_get', diff --git a/src/testit_api_client/api/parameters_api.py b/src/testit_api_client/api/parameters_api.py index 0a2feb39..7b0bb78a 100644 --- a/src/testit_api_client/api/parameters_api.py +++ b/src/testit_api_client/api/parameters_api.py @@ -49,7 +49,7 @@ def __init__(self, api_client=None): 'response_type': ([ParameterApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/bulk', 'operation_id': 'api_v2_parameters_bulk_post', @@ -100,7 +100,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/bulk', 'operation_id': 'api_v2_parameters_bulk_put', @@ -151,7 +151,7 @@ def __init__(self, api_client=None): 'response_type': ([ParameterGroupApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/groups', 'operation_id': 'api_v2_parameters_groups_get', @@ -247,7 +247,7 @@ def __init__(self, api_client=None): 'response_type': (bool,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/key/name/{name}/exists', 'operation_id': 'api_v2_parameters_key_name_name_exists_get', @@ -299,7 +299,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/{key}/values', 'operation_id': 'api_v2_parameters_key_values_get', @@ -351,7 +351,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/keys', 'operation_id': 'api_v2_parameters_keys_get', @@ -427,7 +427,7 @@ def __init__(self, api_client=None): 'response_type': ([ParameterGroupApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/search/groups', 'operation_id': 'api_v2_parameters_search_groups_post', @@ -503,7 +503,7 @@ def __init__(self, api_client=None): 'response_type': ([ParameterApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/search', 'operation_id': 'api_v2_parameters_search_post', @@ -579,7 +579,7 @@ def __init__(self, api_client=None): 'response_type': (ParameterApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters', 'operation_id': 'create_parameter', @@ -630,7 +630,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/name/{name}', 'operation_id': 'delete_by_name', @@ -687,7 +687,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/keyId/{keyId}', 'operation_id': 'delete_by_parameter_key_id', @@ -739,7 +739,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/{id}', 'operation_id': 'delete_parameter', @@ -791,7 +791,7 @@ def __init__(self, api_client=None): 'response_type': ([ParameterApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters', 'operation_id': 'get_all_parameters', @@ -866,7 +866,7 @@ def __init__(self, api_client=None): 'response_type': (ParameterApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters/{id}', 'operation_id': 'get_parameter_by_id', @@ -918,7 +918,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/parameters', 'operation_id': 'update_parameter', @@ -971,7 +971,7 @@ def api_v2_parameters_bulk_post( ): """Create multiple parameters # noqa: E501 - Use case User sets list of parameter model (listed in the request example) User runs method execution System creates parameters System returns list of parameter model (listed in the response example) # noqa: E501 + Use case User sets list of parameter model (listed in the request example) User runs method execution System creates parameters System returns list of parameter model (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1050,7 +1050,7 @@ def api_v2_parameters_bulk_put( ): """Update multiple parameters # noqa: E501 - Use case User sets list of parameter model (listed in the request example) User runs method execution System updates parameters # noqa: E501 + Use case User sets list of parameter model (listed in the request example) User runs method execution System updates parameters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1129,7 +1129,7 @@ def api_v2_parameters_groups_get( ): """Get parameters as group # noqa: E501 - Use case User runs method execution System search parameters System returns parameters models as groups (listed in the response example) # noqa: E501 + Use case User runs method execution System search parameters System returns parameters models as groups (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1217,7 +1217,7 @@ def api_v2_parameters_key_name_name_exists_get( ): """Check existence parameter key in system # noqa: E501 - Use case User sets name of parameter key User runs method execution System search parameter key System returns the flag for the existence of the parameter key in the system # noqa: E501 + Use case User sets name of parameter key User runs method execution System search parameter key System returns the flag for the existence of the parameter key in the system # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1300,7 +1300,7 @@ def api_v2_parameters_key_values_get( ): """Get all parameter key values # noqa: E501 - Use case User sets parameter key (string format) User runs method execution System search parameter values using the key System returns parameter # noqa: E501 + Use case User sets parameter key (string format) User runs method execution System search parameter values using the key System returns parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1382,7 +1382,7 @@ def api_v2_parameters_keys_get( ): """Get all parameter keys # noqa: E501 - Use case User runs method execution System search all parameter keys System returns parameter keys # noqa: E501 + Use case User runs method execution System search all parameter keys System returns parameter keys # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1632,7 +1632,7 @@ def create_parameter( ): """Create parameter # noqa: E501 - Use case User sets parameter model (listed in the request example) User runs method execution System creates parameter System returns parameter model # noqa: E501 + Use case User sets parameter model (listed in the request example) User runs method execution System creates parameter System returns parameter model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1878,7 +1878,7 @@ def delete_parameter( ): """Delete parameter # noqa: E501 - Use case User sets parameter internal (guid format) identifier System search and delete parameter System returns deleted parameter # noqa: E501 + Use case User sets parameter internal (guid format) identifier System search and delete parameter System returns deleted parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1960,7 +1960,7 @@ def get_all_parameters( ): """Get all parameters # noqa: E501 - Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted parameters [Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted If User did not set isDeleted field value, System search all parameters System returns array of all found parameters(listed in response model) # noqa: E501 + Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted parameters [Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted If User did not set isDeleted field value, System search all parameters System returns array of all found parameters(listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2045,7 +2045,7 @@ def get_parameter_by_id( ): """Get parameter by ID # noqa: E501 - Use case User sets parameter internal (guid format) identifier User runs method execution System search parameter using the identifier System returns parameter # noqa: E501 + Use case User sets parameter internal (guid format) identifier User runs method execution System search parameter using the identifier System returns parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2127,7 +2127,7 @@ def update_parameter( ): """Update parameter # noqa: E501 - Use case User sets parameter updated properties(listed in the request example) User runs method execution System updated parameter using updated properties System returns no content response # noqa: E501 + Use case User sets parameter updated properties(listed in the request example) User runs method execution System updated parameter using updated properties System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_attribute_templates_api.py b/src/testit_api_client/api/project_attribute_templates_api.py index 5264ad4b..aac36cb6 100644 --- a/src/testit_api_client/api/project_attribute_templates_api.py +++ b/src/testit_api_client/api/project_attribute_templates_api.py @@ -43,7 +43,7 @@ def __init__(self, api_client=None): 'response_type': ([ProjectCustomAttributeTemplateGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/templates/search', 'operation_id': 'api_v2_projects_project_id_attributes_templates_search_post', @@ -126,7 +126,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/templates/{templateId}', 'operation_id': 'api_v2_projects_project_id_attributes_templates_template_id_delete', @@ -184,7 +184,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/templates/{templateId}', 'operation_id': 'api_v2_projects_project_id_attributes_templates_template_id_post', @@ -334,7 +334,7 @@ def api_v2_projects_project_id_attributes_templates_template_id_delete( ): """Delete CustomAttributeTemplate from Project # noqa: E501 - Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System delete attribute template from project # noqa: E501 + Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System delete attribute template from project # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -421,7 +421,7 @@ def api_v2_projects_project_id_attributes_templates_template_id_post( ): """Add CustomAttributeTemplate to Project # noqa: E501 - Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System add attribute template to project # noqa: E501 + Use case User sets project internal or global identifier User sets attribute template internal identifier User runs method execution System add attribute template to project # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_attributes_api.py b/src/testit_api_client/api/project_attributes_api.py index d3967a7f..764ecfb2 100644 --- a/src/testit_api_client/api/project_attributes_api.py +++ b/src/testit_api_client/api/project_attributes_api.py @@ -47,7 +47,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes', 'operation_id': 'create_projects_attribute', @@ -105,7 +105,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/{attributeId}', 'operation_id': 'delete_projects_attribute', @@ -163,7 +163,7 @@ def __init__(self, api_client=None): 'response_type': (CustomAttributeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/{attributeId}', 'operation_id': 'get_attribute_by_project_id', @@ -221,7 +221,7 @@ def __init__(self, api_client=None): 'response_type': ([CustomAttributeModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes', 'operation_id': 'get_attributes_by_project_id', @@ -278,7 +278,7 @@ def __init__(self, api_client=None): 'response_type': ([CustomAttributeGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes/search', 'operation_id': 'search_attributes_in_project', @@ -361,7 +361,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/attributes', 'operation_id': 'update_projects_attribute', @@ -422,7 +422,7 @@ def create_projects_attribute( ): """Create project attribute # noqa: E501 - Use case User sets attribute parameters (listed in request example) and runs method execution System search project System creates attribute and relates it to the project System returns project attribute properties (example listed in response parameters) # noqa: E501 + Use case User sets attribute parameters (listed in request example) and runs method execution System search project System creates attribute and relates it to the project System returns project attribute properties (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -507,7 +507,7 @@ def delete_projects_attribute( ): """Delete project attribute # noqa: E501 - Use case User sets project identifier and runs method execution User sets attribute identifier User runs method execution System search project System search and delete attribute System returns no content response # noqa: E501 + Use case User sets project identifier and runs method execution User sets attribute identifier User runs method execution System search project System search and delete attribute System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -594,7 +594,7 @@ def get_attribute_by_project_id( ): """Get project attribute # noqa: E501 - Use case User sets project internal or global identifier User sets project attribute identifier User runs method execution System search project System search project attribute System returns project attribute (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier User sets project attribute identifier User runs method execution System search project System search project attribute System returns project attribute (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -680,7 +680,7 @@ def get_attributes_by_project_id( ): """Get project attributes # noqa: E501 - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project [Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all attributes related to project System returns array of found attributes (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project [Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all attributes related to project System returns array of found attributes (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_configurations_api.py b/src/testit_api_client/api/project_configurations_api.py index 7463aa7e..7f18f928 100644 --- a/src/testit_api_client/api/project_configurations_api.py +++ b/src/testit_api_client/api/project_configurations_api.py @@ -42,7 +42,7 @@ def __init__(self, api_client=None): 'response_type': ([ConfigurationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/configurations', 'operation_id': 'get_configurations_by_project_id', @@ -97,7 +97,7 @@ def get_configurations_by_project_id( ): """Get project configurations # noqa: E501 - Use case User sets project internal or global identifier User runs method execution System search project System search all configurations related to project System returns array of found configurations (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier User runs method execution System search project System search all configurations related to project System returns array of found configurations (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_external_services_api.py b/src/testit_api_client/api/project_external_services_api.py new file mode 100644 index 00000000..ac09c1e3 --- /dev/null +++ b/src/testit_api_client/api/project_external_services_api.py @@ -0,0 +1,918 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.api_external_service_category import ApiExternalServiceCategory +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_patch_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_put_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest +from testit_api_client.model.api_v2_projects_id_external_services_issues_search_post_request import ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest +from testit_api_client.model.external_issue_api_result import ExternalIssueApiResult +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.project_external_service_settings_api_result import ProjectExternalServiceSettingsApiResult +from testit_api_client.model.project_external_services_api_result import ProjectExternalServicesApiResult +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class ProjectExternalServicesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_projects_id_external_services_external_service_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services/{externalServiceId}', + 'operation_id': 'api_v2_projects_id_external_services_external_service_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'external_service_id', + ], + 'required': [ + 'id', + 'external_service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'external_service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'external_service_id': 'externalServiceId', + }, + 'location_map': { + 'id': 'path', + 'external_service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_projects_id_external_services_external_service_id_get_endpoint = _Endpoint( + settings={ + 'response_type': (ProjectExternalServiceSettingsApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services/{externalServiceId}', + 'operation_id': 'api_v2_projects_id_external_services_external_service_id_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'external_service_id', + ], + 'required': [ + 'id', + 'external_service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'external_service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'external_service_id': 'externalServiceId', + }, + 'location_map': { + 'id': 'path', + 'external_service_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_projects_id_external_services_external_service_id_patch_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services/{externalServiceId}', + 'operation_id': 'api_v2_projects_id_external_services_external_service_id_patch', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'external_service_id', + 'api_v2_projects_id_external_services_external_service_id_patch_request', + ], + 'required': [ + 'id', + 'external_service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'external_service_id': + (str,), + 'api_v2_projects_id_external_services_external_service_id_patch_request': + (ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest,), + }, + 'attribute_map': { + 'id': 'id', + 'external_service_id': 'externalServiceId', + }, + 'location_map': { + 'id': 'path', + 'external_service_id': 'path', + 'api_v2_projects_id_external_services_external_service_id_patch_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_id_external_services_external_service_id_put_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services/{externalServiceId}', + 'operation_id': 'api_v2_projects_id_external_services_external_service_id_put', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'external_service_id', + 'api_v2_projects_id_external_services_external_service_id_put_request', + ], + 'required': [ + 'id', + 'external_service_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'external_service_id': + (str,), + 'api_v2_projects_id_external_services_external_service_id_put_request': + (ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest,), + }, + 'attribute_map': { + 'id': 'id', + 'external_service_id': 'externalServiceId', + }, + 'location_map': { + 'id': 'path', + 'external_service_id': 'path', + 'api_v2_projects_id_external_services_external_service_id_put_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_id_external_services_get_endpoint = _Endpoint( + settings={ + 'response_type': (ProjectExternalServicesApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services', + 'operation_id': 'api_v2_projects_id_external_services_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'category', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'category': + (ApiExternalServiceCategory,), + }, + 'attribute_map': { + 'id': 'id', + 'category': 'category', + }, + 'location_map': { + 'id': 'path', + 'category': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_projects_id_external_services_issues_search_post_endpoint = _Endpoint( + settings={ + 'response_type': ([ExternalIssueApiResult],), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{id}/external-services/issues/search', + 'operation_id': 'api_v2_projects_id_external_services_issues_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'api_v2_projects_id_external_services_issues_search_post_request', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'api_v2_projects_id_external_services_issues_search_post_request': + (ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + 'api_v2_projects_id_external_services_issues_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def api_v2_projects_id_external_services_external_service_id_delete( + self, + id, + external_service_id, + **kwargs + ): + """Disable an external service # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_external_service_id_delete(id, external_service_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Project ID + external_service_id (str): External service ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['external_service_id'] = \ + external_service_id + return self.api_v2_projects_id_external_services_external_service_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_id_external_services_external_service_id_get( + self, + id, + external_service_id, + **kwargs + ): + """Retrieves settings of an external service # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_external_service_id_get(id, external_service_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Project ID + external_service_id (str): External service ID + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ProjectExternalServiceSettingsApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['external_service_id'] = \ + external_service_id + return self.api_v2_projects_id_external_services_external_service_id_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_id_external_services_external_service_id_patch( + self, + id, + external_service_id, + **kwargs + ): + """Replaces one active external service with another # noqa: E501 + + See RFC 6902: JavaScript Object Notation (JSON) Patch for details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_external_service_id_patch(id, external_service_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Project ID + external_service_id (str): External service ID + + Keyword Args: + api_v2_projects_id_external_services_external_service_id_patch_request (ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['external_service_id'] = \ + external_service_id + return self.api_v2_projects_id_external_services_external_service_id_patch_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_id_external_services_external_service_id_put( + self, + id, + external_service_id, + **kwargs + ): + """Enable an external service # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_external_service_id_put(id, external_service_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Project ID + external_service_id (str): External service ID + + Keyword Args: + api_v2_projects_id_external_services_external_service_id_put_request (ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['external_service_id'] = \ + external_service_id + return self.api_v2_projects_id_external_services_external_service_id_put_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_id_external_services_get( + self, + id, + **kwargs + ): + """Retrieves information about external services, including their integration status (enabled or not) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_get(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Project ID + + Keyword Args: + category (ApiExternalServiceCategory): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ProjectExternalServicesApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_projects_id_external_services_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_id_external_services_issues_search_post( + self, + id, + **kwargs + ): + """Searches for external issues using enabled external services in project # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_id_external_services_issues_search_post(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_projects_id_external_services_issues_search_post_request (ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [ExternalIssueApiResult] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.api_v2_projects_id_external_services_issues_search_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/project_failure_categories_api.py b/src/testit_api_client/api/project_failure_categories_api.py new file mode 100644 index 00000000..8aea523a --- /dev/null +++ b/src/testit_api_client/api/project_failure_categories_api.py @@ -0,0 +1,755 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_post_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_put_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.project_detailed_failure_category_api_result import ProjectDetailedFailureCategoryApiResult +from testit_api_client.model.project_failure_category_group_item_api_result_reply import ProjectFailureCategoryGroupItemApiResultReply +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class ProjectFailureCategoriesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_projects_project_id_autotests_failure_categories_grouping_search_post_endpoint = _Endpoint( + settings={ + 'response_type': (ProjectFailureCategoryGroupItemApiResultReply,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/autotests/failure-categories/grouping-search', + 'operation_id': 'api_v2_projects_project_id_autotests_failure_categories_grouping_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'api_v2_autotests_result_reasons_grouping_search_post_request', + ], + 'required': [ + 'project_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'api_v2_autotests_result_reasons_grouping_search_post_request': + (ApiV2AutotestsResultReasonsGroupingSearchPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + }, + 'location_map': { + 'project_id': 'path', + 'api_v2_autotests_result_reasons_grouping_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_project_id_autotests_failure_categories_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/autotests/failure-categories/{id}', + 'operation_id': 'api_v2_projects_project_id_autotests_failure_categories_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'id', + ], + 'required': [ + 'project_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'id': + (str,), + }, + 'attribute_map': { + 'project_id': 'projectId', + 'id': 'id', + }, + 'location_map': { + 'project_id': 'path', + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_projects_project_id_autotests_failure_categories_id_get_endpoint = _Endpoint( + settings={ + 'response_type': (ProjectDetailedFailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/autotests/failure-categories/{id}', + 'operation_id': 'api_v2_projects_project_id_autotests_failure_categories_id_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'id', + ], + 'required': [ + 'project_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'id': + (str,), + }, + 'attribute_map': { + 'project_id': 'projectId', + 'id': 'id', + }, + 'location_map': { + 'project_id': 'path', + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_projects_project_id_autotests_failure_categories_post_endpoint = _Endpoint( + settings={ + 'response_type': (ProjectDetailedFailureCategoryApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/autotests/failure-categories', + 'operation_id': 'api_v2_projects_project_id_autotests_failure_categories_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'api_v2_projects_project_id_autotests_failure_categories_post_request', + ], + 'required': [ + 'project_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'api_v2_projects_project_id_autotests_failure_categories_post_request': + (ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + }, + 'location_map': { + 'project_id': 'path', + 'api_v2_projects_project_id_autotests_failure_categories_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_project_id_autotests_failure_categories_put_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/autotests/failure-categories', + 'operation_id': 'api_v2_projects_project_id_autotests_failure_categories_put', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'api_v2_projects_project_id_autotests_failure_categories_put_request', + ], + 'required': [ + 'project_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'api_v2_projects_project_id_autotests_failure_categories_put_request': + (ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + }, + 'location_map': { + 'project_id': 'path', + 'api_v2_projects_project_id_autotests_failure_categories_put_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def api_v2_projects_project_id_autotests_failure_categories_grouping_search_post( + self, + project_id, + **kwargs + ): + """Get failure categories with support for filtering, sorting and grouping # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_autotests_failure_categories_grouping_search_post(project_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_autotests_result_reasons_grouping_search_post_request (ApiV2AutotestsResultReasonsGroupingSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ProjectFailureCategoryGroupItemApiResultReply + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + return self.api_v2_projects_project_id_autotests_failure_categories_grouping_search_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_autotests_failure_categories_id_delete( + self, + project_id, + id, + **kwargs + ): + """Delete failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_autotests_failure_categories_id_delete(project_id, id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + kwargs['id'] = \ + id + return self.api_v2_projects_project_id_autotests_failure_categories_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_autotests_failure_categories_id_get( + self, + project_id, + id, + **kwargs + ): + """Get failure category by ID # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_autotests_failure_categories_id_get(project_id, id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ProjectDetailedFailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + kwargs['id'] = \ + id + return self.api_v2_projects_project_id_autotests_failure_categories_id_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_autotests_failure_categories_post( + self, + project_id, + **kwargs + ): + """Create failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_autotests_failure_categories_post(project_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_projects_project_id_autotests_failure_categories_post_request (ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + ProjectDetailedFailureCategoryApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + return self.api_v2_projects_project_id_autotests_failure_categories_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_autotests_failure_categories_put( + self, + project_id, + **kwargs + ): + """Update failure category # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_autotests_failure_categories_put(project_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_projects_project_id_autotests_failure_categories_put_request (ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + return self.api_v2_projects_project_id_autotests_failure_categories_put_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/project_sections_api.py b/src/testit_api_client/api/project_sections_api.py index 9229e642..4e490d2f 100644 --- a/src/testit_api_client/api/project_sections_api.py +++ b/src/testit_api_client/api/project_sections_api.py @@ -42,7 +42,7 @@ def __init__(self, api_client=None): 'response_type': ([SectionModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/sections', 'operation_id': 'get_sections_by_project_id', @@ -122,7 +122,7 @@ def get_sections_by_project_id( ): """Get project sections # noqa: E501 - Use case User sets project internal or global identifier and runs method execution System search project System search all sections related to the project System returns array of sections (listed in response) # noqa: E501 + Use case User sets project internal or global identifier and runs method execution System search project System search all sections related to the project System returns array of sections (listed in response) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_settings_api.py b/src/testit_api_client/api/project_settings_api.py index c2e5e9d0..f29dd7ba 100644 --- a/src/testit_api_client/api/project_settings_api.py +++ b/src/testit_api_client/api/project_settings_api.py @@ -43,7 +43,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/settings/autotests', 'operation_id': 'api_v2_projects_project_id_settings_autotests_post', @@ -101,7 +101,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestProjectSettingsApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/settings/autotests', 'operation_id': 'get_autotest_project_settings', diff --git a/src/testit_api_client/api/project_test_plan_attributes_api.py b/src/testit_api_client/api/project_test_plan_attributes_api.py index 5dd339c3..d558d4dc 100644 --- a/src/testit_api_client/api/project_test_plan_attributes_api.py +++ b/src/testit_api_client/api/project_test_plan_attributes_api.py @@ -45,7 +45,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/attributes', 'operation_id': 'create_custom_attribute_test_plan_project_relations', @@ -107,7 +107,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/attributes/{attributeId}', 'operation_id': 'delete_custom_attribute_test_plan_project_relations', @@ -165,7 +165,7 @@ def __init__(self, api_client=None): 'response_type': ([CustomAttributeModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/attributes', 'operation_id': 'get_custom_attribute_test_plan_project_relations', @@ -217,7 +217,7 @@ def __init__(self, api_client=None): 'response_type': ([CustomAttributeGetModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/attributes/search', 'operation_id': 'search_test_plan_attributes_in_project', @@ -300,7 +300,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/attributes', 'operation_id': 'update_custom_attribute_test_plan_project_relations', @@ -361,7 +361,7 @@ def create_custom_attribute_test_plan_project_relations( ): """Add attributes to project's test plans # noqa: E501 - Use case User sets project internal or global identifier and attributes identifiers User runs method execution System updates project and add attributes to project for test plans System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attributes identifiers User runs method execution System updates project and add attributes to project for test plans System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -446,7 +446,7 @@ def delete_custom_attribute_test_plan_project_relations( ): """Delete attribute from project's test plans # noqa: E501 - Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -532,7 +532,7 @@ def get_custom_attribute_test_plan_project_relations( ): """Get project's test plan attributes # noqa: E501 - Use case User runs method execution System returns project for test plans attributes by project identifier # noqa: E501 + Use case User runs method execution System returns project for test plans attributes by project identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -703,7 +703,7 @@ def update_custom_attribute_test_plan_project_relations( ): """Update attribute of project's test plans # noqa: E501 - Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_test_plan_test_points_api.py b/src/testit_api_client/api/project_test_plan_test_points_api.py index 2e7e2f55..839a7830 100644 --- a/src/testit_api_client/api/project_test_plan_test_points_api.py +++ b/src/testit_api_client/api/project_test_plan_test_points_api.py @@ -21,9 +21,14 @@ none_type, validate_and_convert_types ) +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRerunPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRunPostRequest +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.test_plan_test_points_analytics_api_result import TestPlanTestPointsAnalyticsApiResult +from testit_api_client.model.test_plan_test_points_group_search_api_result import TestPlanTestPointsGroupSearchApiResult from testit_api_client.model.test_run_name_api_result import TestRunNameApiResult from testit_api_client.model.validation_problem_details import ValidationProblemDetails @@ -39,12 +44,76 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_endpoint = _Endpoint( + settings={ + 'response_type': (TestPlanTestPointsAnalyticsApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/analytics', + 'operation_id': 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'test_plan_id', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request', + ], + 'required': [ + 'project_id', + 'test_plan_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'test_plan_id': + (str,), + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request': + (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + 'test_plan_id': 'testPlanId', + }, + 'location_map': { + 'project_id': 'path', + 'test_plan_id': 'path', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun', 'operation_id': 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post', @@ -108,7 +177,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunNameApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run', 'operation_id': 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post', @@ -167,6 +236,221 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_endpoint = _Endpoint( + settings={ + 'response_type': (TestPlanTestPointsGroupSearchApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/grouping-search', + 'operation_id': 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'test_plan_id', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request', + ], + 'required': [ + 'project_id', + 'test_plan_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'test_plan_id': + (str,), + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request': + (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + 'test_plan_id': 'testPlanId', + }, + 'location_map': { + 'project_id': 'path', + 'test_plan_id': 'path', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/testers', + 'operation_id': 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'test_plan_id', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request', + ], + 'required': [ + 'project_id', + 'test_plan_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'test_plan_id': + (str,), + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request': + (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + 'test_plan_id': 'testPlanId', + }, + 'location_map': { + 'project_id': 'path', + 'test_plan_id': 'path', + 'api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post( + self, + project_id, + test_plan_id, + **kwargs + ): + """Get test points analytics. # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post(project_id, test_plan_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + test_plan_id (str): + + Keyword Args: + api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + TestPlanTestPointsAnalyticsApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + kwargs['test_plan_id'] = \ + test_plan_id + return self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_endpoint.call_with_http_info(**kwargs) def api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post( self, @@ -342,3 +626,177 @@ def api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run test_plan_id return self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post_endpoint.call_with_http_info(**kwargs) + def api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post( + self, + project_id, + test_plan_id, + **kwargs + ): + """Search test points in test plan. # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post(project_id, test_plan_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + test_plan_id (str): + + Keyword Args: + api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + TestPlanTestPointsGroupSearchApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + kwargs['test_plan_id'] = \ + test_plan_id + return self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post( + self, + project_id, + test_plan_id, + **kwargs + ): + """Distribute test points between the users. # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post(project_id, test_plan_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + test_plan_id (str): + + Keyword Args: + api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request (ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + kwargs['test_plan_id'] = \ + test_plan_id + return self.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/project_test_plans_api.py b/src/testit_api_client/api/project_test_plans_api.py index 5eadf381..0c254787 100644 --- a/src/testit_api_client/api/project_test_plans_api.py +++ b/src/testit_api_client/api/project_test_plans_api.py @@ -44,7 +44,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanWithAnalyticModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/analytics', 'operation_id': 'api_v2_projects_project_id_test_plans_analytics_get', @@ -131,7 +131,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/delete/bulk', 'operation_id': 'api_v2_projects_project_id_test_plans_delete_bulk_post', @@ -189,7 +189,7 @@ def __init__(self, api_client=None): 'response_type': (bool,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/{name}/exists', 'operation_id': 'api_v2_projects_project_id_test_plans_name_exists_get', @@ -247,7 +247,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/purge/bulk', 'operation_id': 'api_v2_projects_project_id_test_plans_purge_bulk_post', @@ -305,7 +305,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/restore/bulk', 'operation_id': 'api_v2_projects_project_id_test_plans_restore_bulk_post', @@ -363,7 +363,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanWithAnalyticModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/testPlans/search', 'operation_id': 'api_v2_projects_project_id_test_plans_search_post', @@ -454,7 +454,7 @@ def api_v2_projects_project_id_test_plans_analytics_get( ): """Get TestPlans analytics # noqa: E501 - Use case User sets project internal identifier User sets query params User runs method execution System return analytics # noqa: E501 + Use case User sets project internal identifier User sets query params User runs method execution System return analytics # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -628,7 +628,7 @@ def api_v2_projects_project_id_test_plans_name_exists_get( ): """Checks if TestPlan exists with the specified name exists for the project # noqa: E501 - Use case User sets project internal or global identifier User runs method execution System purge delete project workitems # noqa: E501 + Use case User sets project internal or global identifier User runs method execution System purge delete project workitems # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -880,7 +880,7 @@ def api_v2_projects_project_id_test_plans_search_post( ): """Get Project TestPlans with analytics # noqa: E501 - Use case User sets project internal or global identifier User sets request body User runs method execution System returns project testplans with analytics # noqa: E501 + Use case User sets project internal or global identifier User sets request body User runs method execution System returns project testplans with analytics # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/project_work_items_api.py b/src/testit_api_client/api/project_work_items_api.py index c93535b3..54b5a05c 100644 --- a/src/testit_api_client/api/project_work_items_api.py +++ b/src/testit_api_client/api/project_work_items_api.py @@ -21,9 +21,12 @@ none_type, validate_and_convert_types ) +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_bulk_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_grouped_post_request import ApiV2ProjectsProjectIdWorkItemsSearchGroupedPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_id_post_request import ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_post_request import ApiV2ProjectsProjectIdWorkItemsSearchPostRequest +from testit_api_client.model.generate_work_item_previews_api_result import GenerateWorkItemPreviewsApiResult from testit_api_client.model.problem_details import ProblemDetails from testit_api_client.model.tag_short_api_result import TagShortApiResult from testit_api_client.model.validation_problem_details import ValidationProblemDetails @@ -44,12 +47,128 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.api_v2_projects_project_id_work_items_previews_bulk_post_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/work-items/previews/bulk', + 'operation_id': 'api_v2_projects_project_id_work_items_previews_bulk_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'api_v2_projects_project_id_work_items_previews_bulk_post_request', + ], + 'required': [ + 'project_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'api_v2_projects_project_id_work_items_previews_bulk_post_request': + (ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + }, + 'location_map': { + 'project_id': 'path', + 'api_v2_projects_project_id_work_items_previews_bulk_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_projects_project_id_work_items_previews_post_endpoint = _Endpoint( + settings={ + 'response_type': (GenerateWorkItemPreviewsApiResult,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/projects/{projectId}/work-items/previews', + 'operation_id': 'api_v2_projects_project_id_work_items_previews_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'project_id', + 'api_v2_projects_project_id_work_items_previews_post_request', + ], + 'required': [ + 'project_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'project_id': + (str,), + 'api_v2_projects_project_id_work_items_previews_post_request': + (ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest,), + }, + 'attribute_map': { + 'project_id': 'projectId', + }, + 'location_map': { + 'project_id': 'path', + 'api_v2_projects_project_id_work_items_previews_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.api_v2_projects_project_id_work_items_search_grouped_post_endpoint = _Endpoint( settings={ 'response_type': ([WorkItemGroupModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems/search/grouped', 'operation_id': 'api_v2_projects_project_id_work_items_search_grouped_post', @@ -132,7 +251,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems/search/id', 'operation_id': 'api_v2_projects_project_id_work_items_search_id_post', @@ -215,7 +334,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemShortApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems/search', 'operation_id': 'api_v2_projects_project_id_work_items_search_post', @@ -298,7 +417,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemIndexApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems/search/{workItemId}/index', 'operation_id': 'api_v2_projects_project_id_work_items_search_work_item_id_index_post', @@ -387,7 +506,7 @@ def __init__(self, api_client=None): 'response_type': ([TagShortApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems/tags', 'operation_id': 'api_v2_projects_project_id_work_items_tags_get', @@ -444,7 +563,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{projectId}/workItems', 'operation_id': 'get_work_items_by_project_id', @@ -533,6 +652,172 @@ def __init__(self, api_client=None): api_client=api_client ) + def api_v2_projects_project_id_work_items_previews_bulk_post( + self, + project_id, + **kwargs + ): + """api_v2_projects_project_id_work_items_previews_bulk_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_work_items_previews_bulk_post(project_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_projects_project_id_work_items_previews_bulk_post_request (ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + return self.api_v2_projects_project_id_work_items_previews_bulk_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_projects_project_id_work_items_previews_post( + self, + project_id, + **kwargs + ): + """api_v2_projects_project_id_work_items_previews_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_projects_project_id_work_items_previews_post(project_id, async_req=True) + >>> result = thread.get() + + Args: + project_id (str): Internal (UUID) or global (integer) identifier + + Keyword Args: + api_v2_projects_project_id_work_items_previews_post_request (ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + GenerateWorkItemPreviewsApiResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['project_id'] = \ + project_id + return self.api_v2_projects_project_id_work_items_previews_post_endpoint.call_with_http_info(**kwargs) + def api_v2_projects_project_id_work_items_search_grouped_post( self, project_id, @@ -896,7 +1181,7 @@ def api_v2_projects_project_id_work_items_tags_get( ): """Get WorkItems Tags # noqa: E501 - Use case User sets project internal identifier User runs method execution System returns work items tags # noqa: E501 + Use case User sets project internal identifier User runs method execution System returns work items tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -980,7 +1265,7 @@ def get_work_items_by_project_id( ): """Get project work items # noqa: E501 - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project [Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted If User did not set isDeleted field value, System search all workitems related to project System returns array of found workitems (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project [Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted If User did not set isDeleted field value, System search all workitems related to project System returns array of found workitems (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/projects_api.py b/src/testit_api_client/api/projects_api.py index a9cbe717..8773a4e2 100644 --- a/src/testit_api_client/api/projects_api.py +++ b/src/testit_api_client/api/projects_api.py @@ -26,7 +26,6 @@ from testit_api_client.model.api_v2_projects_shorts_post_request import ApiV2ProjectsShortsPostRequest from testit_api_client.model.auto_test_namespace_api_result import AutoTestNamespaceApiResult from testit_api_client.model.create_project_request import CreateProjectRequest -from testit_api_client.model.demo_project_api_result import DemoProjectApiResult from testit_api_client.model.detailed_project_api_result import DetailedProjectApiResult from testit_api_client.model.failure_category_api_result import FailureCategoryApiResult from testit_api_client.model.filter_model import FilterModel @@ -58,7 +57,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/globalAttributes', 'operation_id': 'add_global_attributes_to_project', @@ -115,57 +114,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.api_v2_projects_demo_post_endpoint = _Endpoint( - settings={ - 'response_type': (DemoProjectApiResult,), - 'auth': [ - 'PrivateToken', - 'Identity.Application' - ], - 'endpoint_path': '/api/v2/projects/demo', - 'operation_id': 'api_v2_projects_demo_post', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.api_v2_projects_id_delete_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}', 'operation_id': 'api_v2_projects_id_delete', @@ -217,7 +171,7 @@ def __init__(self, api_client=None): 'response_type': ([FailureCategoryApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/failureClasses', 'operation_id': 'api_v2_projects_id_failure_classes_get', @@ -274,7 +228,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/favorite', 'operation_id': 'api_v2_projects_id_favorite_put', @@ -326,7 +280,7 @@ def __init__(self, api_client=None): 'response_type': ([FilterModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/filters', 'operation_id': 'api_v2_projects_id_filters_get', @@ -378,7 +332,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}', 'operation_id': 'api_v2_projects_id_patch', @@ -436,7 +390,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/purge', 'operation_id': 'api_v2_projects_id_purge_post', @@ -488,7 +442,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/restore', 'operation_id': 'api_v2_projects_id_restore_post', @@ -540,7 +494,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/testPlans/attribute/{attributeId}', 'operation_id': 'api_v2_projects_id_test_plans_attribute_attribute_id_delete', @@ -598,7 +552,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/testPlans/attribute', 'operation_id': 'api_v2_projects_id_test_plans_attribute_put', @@ -656,7 +610,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/testRuns/full', 'operation_id': 'api_v2_projects_id_test_runs_full_get', @@ -778,7 +732,7 @@ def __init__(self, api_client=None): 'response_type': (bool,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/name/{name}/exists', 'operation_id': 'api_v2_projects_name_name_exists_get', @@ -830,7 +784,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/purge/bulk', 'operation_id': 'api_v2_projects_purge_bulk_post', @@ -881,7 +835,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/restore/bulk', 'operation_id': 'api_v2_projects_restore_bulk_post', @@ -932,7 +886,7 @@ def __init__(self, api_client=None): 'response_type': ([ProjectApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/search', 'operation_id': 'api_v2_projects_search_post', @@ -1008,7 +962,7 @@ def __init__(self, api_client=None): 'response_type': (ProjectShortApiResultIReply,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/shorts', 'operation_id': 'api_v2_projects_shorts_post', @@ -1059,7 +1013,7 @@ def __init__(self, api_client=None): 'response_type': (ProjectApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects', 'operation_id': 'create_project', @@ -1110,7 +1064,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/autoTests', 'operation_id': 'delete_project_auto_tests', @@ -1162,7 +1116,7 @@ def __init__(self, api_client=None): 'response_type': ([ProjectApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects', 'operation_id': 'get_all_projects', @@ -1242,7 +1196,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestNamespaceApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/autoTestsNamespaces', 'operation_id': 'get_auto_tests_namespaces', @@ -1294,7 +1248,7 @@ def __init__(self, api_client=None): 'response_type': (DetailedProjectApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}', 'operation_id': 'get_project_by_id', @@ -1346,7 +1300,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/testPlans', 'operation_id': 'get_test_plans_by_project_id', @@ -1403,7 +1357,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunV2ApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects/{id}/testRuns', 'operation_id': 'get_test_runs_by_project_id', @@ -1519,7 +1473,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/projects', 'operation_id': 'update_project', @@ -1573,7 +1527,7 @@ def add_global_attributes_to_project( ): """Add global attributes to project # noqa: E501 - Use case User sets project internal or global identifier and attributes identifiers System search project System relates global attributes with project System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attributes identifiers System search project System relates global attributes with project System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1650,83 +1604,6 @@ def add_global_attributes_to_project( id return self.add_global_attributes_to_project_endpoint.call_with_http_info(**kwargs) - def api_v2_projects_demo_post( - self, - **kwargs - ): - """api_v2_projects_demo_post # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.api_v2_projects_demo_post(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - DemoProjectApiResult - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.api_v2_projects_demo_post_endpoint.call_with_http_info(**kwargs) - def api_v2_projects_id_delete( self, id, @@ -1981,7 +1858,7 @@ def api_v2_projects_id_filters_get( ): """Get Project filters # noqa: E501 - Use case User sets project internal or global identifier User runs method execution System returns project filters # noqa: E501 + Use case User sets project internal or global identifier User runs method execution System returns project filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2313,7 +2190,7 @@ def api_v2_projects_id_test_plans_attribute_attribute_id_delete( ): """Delete attribute from project's test plans # noqa: E501 - Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attribute identifier User runs method execution System updates project and delete attribute from project for test plans System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2399,7 +2276,7 @@ def api_v2_projects_id_test_plans_attribute_put( ): """Update attribute of project's test plans # noqa: E501 - Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response # noqa: E501 + Use case User sets project internal or global identifier and attribute model User runs method execution System updates project and project attribute for test plan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2483,7 +2360,7 @@ def api_v2_projects_id_test_runs_full_get( ): """Get Project TestRuns full models # noqa: E501 - Use case User sets project internal or global identifier User sets query params User runs method execution System returns project test runs full models # noqa: E501 + Use case User sets project internal or global identifier User sets query params User runs method execution System returns project test runs full models # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2900,7 +2777,7 @@ def api_v2_projects_shorts_post( ): """Get projects short models # noqa: E501 - Use case User sets query params User runs method execution System return projects short models # noqa: E501 + Use case User sets query params User runs method execution System return projects short models # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2979,7 +2856,7 @@ def create_project( ): """Create project # noqa: E501 - Use case User sets project parameters (listed in request example) and runs method execution System creates project System returns project model (example listed in response parameters) # noqa: E501 + Use case User sets project parameters (listed in request example) and runs method execution System creates project System returns project model (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3140,7 +3017,7 @@ def get_all_projects( ): """Get all projects # noqa: E501 - Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted projects [Optional] If User sets isDeleted field value as false, System search all projects which are not deleted If User did not set isDeleted field value, System search all projects System returns array of all found projects(listed in response model) # noqa: E501 + Use case [Optional] User sets isDeleted field value [Optional] If User sets isDeleted field value as true, System search all deleted projects [Optional] If User sets isDeleted field value as false, System search all projects which are not deleted If User did not set isDeleted field value, System search all projects System returns array of all found projects(listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3226,7 +3103,7 @@ def get_auto_tests_namespaces( ): """Get namespaces of autotests in project # noqa: E501 - Use case User sets project internal or global identifier and runs method execution System search project System search all autotest related to the project System returns array of autotest with namespaces and classnames (listed in response) # noqa: E501 + Use case User sets project internal or global identifier and runs method execution System search project System search all autotest related to the project System returns array of autotest with namespaces and classnames (listed in response) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3309,7 +3186,7 @@ def get_project_by_id( ): """Get project by ID # noqa: E501 - Use case User sets project internal or global identifier and runs method execution System search project System returns project (example listed in response parameters) # noqa: E501 + Use case User sets project internal or global identifier and runs method execution System search project System returns project (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3392,7 +3269,7 @@ def get_test_plans_by_project_id( ): """Get project test plans # noqa: E501 - Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted test plans related to project [Optional] If User sets isDeleted field value as false, System search all test plans related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all v related to project System returns array of found test plans (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier [Optional] User sets isDeleted field value User runs method execution System search project [Optional] If User sets isDeleted field value as true, System search all deleted test plans related to project [Optional] If User sets isDeleted field value as false, System search all test plans related to project which are not deleted [Optional] If User did not set isDeleted field value, System search all v related to project System returns array of found test plans (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3480,7 +3357,7 @@ def get_test_runs_by_project_id( ): """Get project test runs # noqa: E501 - Use case User sets project internal or global identifier User runs method execution System search project System search all test runs related to project System returns array of found test runs (listed in response model) # noqa: E501 + Use case User sets project internal or global identifier User runs method execution System search project System search all test runs related to project System returns array of found test runs (listed in response model) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3582,7 +3459,7 @@ def update_project( ): """Update project # noqa: E501 - Use case User sets project parameters (listed in request example) and runs method execution System updates project System returns updated project model (example listed in response parameters) # noqa: E501 + Use case User sets project parameters (listed in request example) and runs method execution System updates project System returns updated project model (example listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/roles_api.py b/src/testit_api_client/api/roles_api.py new file mode 100644 index 00000000..ac9b5229 --- /dev/null +++ b/src/testit_api_client/api/roles_api.py @@ -0,0 +1,162 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.role_api_model_api_collection import RoleApiModelApiCollection +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class RolesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_roles_get_endpoint = _Endpoint( + settings={ + 'response_type': (RoleApiModelApiCollection,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/roles', + 'operation_id': 'api_v2_roles_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def api_v2_roles_get( + self, + **kwargs + ): + """api_v2_roles_get # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_roles_get(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + RoleApiModelApiCollection + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_roles_get_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/sections_api.py b/src/testit_api_client/api/sections_api.py index 7174326c..9b70a327 100644 --- a/src/testit_api_client/api/sections_api.py +++ b/src/testit_api_client/api/sections_api.py @@ -49,7 +49,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/{id}', 'operation_id': 'api_v2_sections_id_patch', @@ -107,7 +107,7 @@ def __init__(self, api_client=None): 'response_type': (SectionWithStepsModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections', 'operation_id': 'create_section', @@ -158,7 +158,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/{id}', 'operation_id': 'delete_section', @@ -210,7 +210,7 @@ def __init__(self, api_client=None): 'response_type': (SectionWithStepsModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/{id}', 'operation_id': 'get_section_by_id', @@ -267,7 +267,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/{id}/workItems', 'operation_id': 'get_work_items_by_section_id', @@ -360,7 +360,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/move', 'operation_id': 'move', @@ -411,7 +411,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections/rename', 'operation_id': 'rename', @@ -462,7 +462,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/sections', 'operation_id': 'update_section', @@ -599,7 +599,7 @@ def create_section( ): """Create section # noqa: E501 - Use case User sets section properties (listed in request example) User runs method execution System creates section property values System returns section (listed in response example) # noqa: E501 + Use case User sets section properties (listed in request example) User runs method execution System creates section property values System returns section (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -679,7 +679,7 @@ def delete_section( ): """Delete section # noqa: E501 - Use case User sets section identifier User runs method execution System search section by the identifier System search and delete nested sections of the found section System search and delete workitems related to the found nested sections System deletes initial section and related workitem System returns no content response # noqa: E501 + Use case User sets section identifier User runs method execution System search section by the identifier System search and delete nested sections of the found section System search and delete workitems related to the found nested sections System deletes initial section and related workitem System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -762,7 +762,7 @@ def get_section_by_id( ): """Get section # noqa: E501 - Use case User sets section internal (guid format) identifier User runs method execution System search section by the section identifier [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns section # noqa: E501 + Use case User sets section internal (guid format) identifier User runs method execution System search section by the section identifier [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns section # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -846,7 +846,7 @@ def get_work_items_by_section_id( ): """Get section work items # noqa: E501 - Use case User sets section identifier User runs method execution System search section by the identifier System search work items related to the section [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns work item collection # noqa: E501 + Use case User sets section identifier User runs method execution System search section by the identifier System search work items related to the section [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. System returns work item collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1014,7 +1014,7 @@ def rename( ): """Rename section # noqa: E501 - Use case User sets section identifier and new name (listed in request example) User runs method execution System search section by the identifier System updates section name using the new name System returns no content response # noqa: E501 + Use case User sets section identifier and new name (listed in request example) User runs method execution System search section by the identifier System updates section name using the new name System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1093,7 +1093,7 @@ def update_section( ): """Update section # noqa: E501 - Use case User sets section properties (listed in request example) User runs method execution System search section by the identifier System updates section using the property values System returns no content response # noqa: E501 + Use case User sets section properties (listed in request example) User runs method execution System search section by the identifier System updates section using the property values System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/tags_api.py b/src/testit_api_client/api/tags_api.py index cd10006d..08f27b88 100644 --- a/src/testit_api_client/api/tags_api.py +++ b/src/testit_api_client/api/tags_api.py @@ -45,7 +45,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags', 'operation_id': 'api_v2_tags_delete', @@ -99,7 +99,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags/{id}', 'operation_id': 'api_v2_tags_id_delete', @@ -151,7 +151,7 @@ def __init__(self, api_client=None): 'response_type': (TagApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags', 'operation_id': 'api_v2_tags_post', @@ -205,7 +205,7 @@ def __init__(self, api_client=None): 'response_type': (TagApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags', 'operation_id': 'api_v2_tags_put', @@ -264,7 +264,7 @@ def __init__(self, api_client=None): 'response_type': ([TagApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags/search', 'operation_id': 'api_v2_tags_search_get', @@ -334,7 +334,7 @@ def __init__(self, api_client=None): 'response_type': ([TagApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/tags/testPlansTags', 'operation_id': 'api_v2_tags_test_plans_tags_get', @@ -406,7 +406,7 @@ def api_v2_tags_delete( ): """Delete tags # noqa: E501 - Use case User sets collection of tags internal (guid format) identifiers System searches and deletes a collection of tags # noqa: E501 + Use case User sets collection of tags internal (guid format) identifiers System searches and deletes a collection of tags # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -486,7 +486,7 @@ def api_v2_tags_id_delete( ): """Delete tag # noqa: E501 - Use case User sets tag internal (guid format) identifier System search and delete tag # noqa: E501 + Use case User sets tag internal (guid format) identifier System search and delete tag # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -568,7 +568,7 @@ def api_v2_tags_post( ): """Create tag # noqa: E501 - Use case User sets tag model (listed in the request example) User runs method execution System creates tag System returns tag model (listed in the response example) # noqa: E501 + Use case User sets tag model (listed in the request example) User runs method execution System creates tag System returns tag model (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -647,7 +647,7 @@ def api_v2_tags_put( ): """Update tag # noqa: E501 - Use case User sets tag ID and model (listed in the request example) User runs method execution System updates tag System returns tag model (listed in the response example) # noqa: E501 + Use case User sets tag ID and model (listed in the request example) User runs method execution System updates tag System returns tag model (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -727,7 +727,7 @@ def api_v2_tags_search_get( ): """Search tags # noqa: E501 - Use case User runs method execution System returns collection of tags (listed in the response example) # noqa: E501 + Use case User runs method execution System returns collection of tags (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -810,7 +810,7 @@ def api_v2_tags_test_plans_tags_get( ): """Get all Tags that are used in TestPlans # noqa: E501 - Use case User runs method execution System returns tags (listed in the response example) # noqa: E501 + Use case User runs method execution System returns tags (listed in the response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/test_plans_api.py b/src/testit_api_client/api/test_plans_api.py index a3f56797..9cc19540 100644 --- a/src/testit_api_client/api/test_plans_api.py +++ b/src/testit_api_client/api/test_plans_api.py @@ -59,7 +59,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/test-points/withSections', 'operation_id': 'add_test_points_with_sections', @@ -117,7 +117,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/workItems/withSections', 'operation_id': 'add_work_items_with_sections', @@ -179,7 +179,7 @@ def __init__(self, api_client=None): 'response_type': (TestPointAnalyticResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/analytics', 'operation_id': 'api_v2_test_plans_id_analytics_get', @@ -231,7 +231,7 @@ def __init__(self, api_client=None): 'response_type': (TestPlanWithTestSuiteTreeModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/autobalance', 'operation_id': 'api_v2_test_plans_id_autobalance_post', @@ -293,7 +293,7 @@ def __init__(self, api_client=None): 'response_type': ([ConfigurationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/configurations', 'operation_id': 'api_v2_test_plans_id_configurations_get', @@ -345,7 +345,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/export/testPoints/xlsx', 'operation_id': 'api_v2_test_plans_id_export_test_points_xlsx_post', @@ -408,7 +408,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/export/testResultHistory/xlsx', 'operation_id': 'api_v2_test_plans_id_export_test_result_history_xlsx_post', @@ -480,7 +480,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanChangeModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/history', 'operation_id': 'api_v2_test_plans_id_history_get', @@ -557,7 +557,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanLink],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/links', 'operation_id': 'api_v2_test_plans_id_links_get', @@ -624,7 +624,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}', 'operation_id': 'api_v2_test_plans_id_patch', @@ -682,7 +682,7 @@ def __init__(self, api_client=None): 'response_type': (TestPlanSummaryModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/summaries', 'operation_id': 'api_v2_test_plans_id_summaries_get', @@ -734,7 +734,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPointWithLastResultResponseModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testPoints/lastResults', 'operation_id': 'api_v2_test_plans_id_test_points_last_results_get', @@ -816,7 +816,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testPoints/reset', 'operation_id': 'api_v2_test_plans_id_test_points_reset_post', @@ -878,7 +878,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testPoints/tester', 'operation_id': 'api_v2_test_plans_id_test_points_tester_delete', @@ -936,7 +936,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testPoints/tester/{userId}', 'operation_id': 'api_v2_test_plans_id_test_points_tester_user_id_post', @@ -1000,7 +1000,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testRuns', 'operation_id': 'api_v2_test_plans_id_test_runs_get', @@ -1097,7 +1097,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testRuns/search', 'operation_id': 'api_v2_test_plans_id_test_runs_search_post', @@ -1180,7 +1180,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDate', 'operation_id': 'api_v2_test_plans_id_test_runs_test_results_last_modified_modified_date_get', @@ -1232,7 +1232,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/unlock/request', 'operation_id': 'api_v2_test_plans_id_unlock_request_post', @@ -1284,7 +1284,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPlanShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/shorts', 'operation_id': 'api_v2_test_plans_shorts_post', @@ -1344,7 +1344,7 @@ def __init__(self, api_client=None): 'response_type': (TestPlanModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/clone', 'operation_id': 'clone', @@ -1396,7 +1396,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/complete', 'operation_id': 'complete', @@ -1448,7 +1448,7 @@ def __init__(self, api_client=None): 'response_type': (TestPlanModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans', 'operation_id': 'create_test_plan', @@ -1499,7 +1499,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}', 'operation_id': 'delete_test_plan', @@ -1551,7 +1551,7 @@ def __init__(self, api_client=None): 'response_type': (TestPlanModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}', 'operation_id': 'get_test_plan_by_id', @@ -1603,7 +1603,7 @@ def __init__(self, api_client=None): 'response_type': ([TestSuiteHierarchyApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/testSuites', 'operation_id': 'get_test_suites_by_id', @@ -1655,7 +1655,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/pause', 'operation_id': 'pause', @@ -1707,7 +1707,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/purge', 'operation_id': 'purge_test_plan', @@ -1759,7 +1759,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/restore', 'operation_id': 'restore_test_plan', @@ -1811,7 +1811,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans/{id}/start', 'operation_id': 'start', @@ -1863,7 +1863,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPlans', 'operation_id': 'update_test_plan', @@ -1924,7 +1924,7 @@ def add_test_points_with_sections( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: api_v2_projects_project_id_work_items_search_id_post_request (ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest): Filter object to retrieve work items for test-suite's project. [optional] @@ -2000,7 +2000,7 @@ def add_work_items_with_sections( ): """Add WorkItems to TestPlan with Sections as TestSuites # noqa: E501 - Use case User sets TestPlan identifier User sets WorkItem identifiers (listed in request example) User runs method execution System added WorkItems and Sections to TestPlan System returns no content response # noqa: E501 + Use case User sets TestPlan identifier User sets WorkItem identifiers (listed in request example) User runs method execution System added WorkItems and Sections to TestPlan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2008,7 +2008,7 @@ def add_work_items_with_sections( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: request_body ([str]): [optional] @@ -2084,7 +2084,7 @@ def api_v2_test_plans_id_analytics_get( ): """Get analytics by TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System returns analytics by test plan # noqa: E501 + Use case User sets test plan identifier User runs method execution System returns analytics by test plan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2092,7 +2092,7 @@ def api_v2_test_plans_id_analytics_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -2250,7 +2250,7 @@ def api_v2_test_plans_id_configurations_get( ): """Get TestPlan configurations # noqa: E501 - Use case User sets test plan identifier User runs method execution System return test plan configurations # noqa: E501 + Use case User sets test plan identifier User runs method execution System return test plan configurations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2258,7 +2258,7 @@ def api_v2_test_plans_id_configurations_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -2333,7 +2333,7 @@ def api_v2_test_plans_id_export_test_points_xlsx_post( ): """Export TestPoints from TestPlan in xls format # noqa: E501 - Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file # noqa: E501 + Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2341,7 +2341,7 @@ def api_v2_test_plans_id_export_test_points_xlsx_post( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: time_zone_offset_in_minutes (int): [optional] @@ -2418,7 +2418,7 @@ def api_v2_test_plans_id_export_test_result_history_xlsx_post( ): """Export TestResults history from TestPlan in xls format # noqa: E501 - Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file # noqa: E501 + Use case User sets test plan identifier User sets filter model (listed in request example) User runs method execution System return export xlsx file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2426,7 +2426,7 @@ def api_v2_test_plans_id_export_test_result_history_xlsx_post( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: must_return_only_last_test_result (bool): [optional] @@ -2505,7 +2505,7 @@ def api_v2_test_plans_id_history_get( ): """Get TestPlan history # noqa: E501 - Use case User sets test plan identifier User runs method execution System return test plan history # noqa: E501 + Use case User sets test plan identifier User runs method execution System return test plan history # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2513,7 +2513,7 @@ def api_v2_test_plans_id_history_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: skip (int): Amount of items to be skipped (offset). [optional] @@ -2593,7 +2593,7 @@ def api_v2_test_plans_id_links_get( ): """Get Links of TestPlan # noqa: E501 - Use case User sets test plan identifier User sets pagination filter (listed in request example) User runs method execution System returns links of TestPlan # noqa: E501 + Use case User sets test plan identifier User sets pagination filter (listed in request example) User runs method execution System returns links of TestPlan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2601,7 +2601,7 @@ def api_v2_test_plans_id_links_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: skip (int): [optional] @@ -2763,7 +2763,7 @@ def api_v2_test_plans_id_summaries_get( ): """Get summary by TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System returns summary by test plan # noqa: E501 + Use case User sets test plan identifier User runs method execution System returns summary by test plan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2771,7 +2771,7 @@ def api_v2_test_plans_id_summaries_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -2846,7 +2846,7 @@ def api_v2_test_plans_id_test_points_last_results_get( ): """Get TestPoints with last result from TestPlan # noqa: E501 - Use case User sets test plan identifier User sets filter (listed in request example) User runs method execution System return test points with last result from test plan # noqa: E501 + Use case User sets test plan identifier User sets filter (listed in request example) User runs method execution System return test points with last result from test plan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2854,7 +2854,7 @@ def api_v2_test_plans_id_test_points_last_results_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: tester_id (str): [optional] @@ -2935,7 +2935,7 @@ def api_v2_test_plans_id_test_points_reset_post( ): """Reset TestPoints status of TestPlan # noqa: E501 - Use case User sets test plan identifier User sets test points identifiers User runs method execution System reset test points statuses of test plan # noqa: E501 + Use case User sets test plan identifier User sets test points identifiers User runs method execution System reset test points statuses of test plan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2943,7 +2943,7 @@ def api_v2_test_plans_id_test_points_reset_post( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: request_body ([str]): [optional] @@ -3189,7 +3189,7 @@ def api_v2_test_plans_id_test_runs_get( ): """Get TestRuns of TestPlan # noqa: E501 - Use case User sets test plan identifier User sets TestRun status filter (listed in request example) User runs method execution System returns TestRuns for TestPlan # noqa: E501 + Use case User sets test plan identifier User sets TestRun status filter (listed in request example) User runs method execution System returns TestRuns for TestPlan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3197,7 +3197,7 @@ def api_v2_test_plans_id_test_runs_get( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: not_started (bool): [optional] @@ -3281,7 +3281,7 @@ def api_v2_test_plans_id_test_runs_search_post( ): """Search TestRuns of TestPlan # noqa: E501 - Use case User sets test plan identifier User sets TestRuns filter (listed in request example) User runs method execution System returns TestRuns for TestPlan # noqa: E501 + Use case User sets test plan identifier User sets TestRuns filter (listed in request example) User runs method execution System returns TestRuns for TestPlan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3289,7 +3289,7 @@ def api_v2_test_plans_id_test_runs_search_post( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: skip (int): Amount of items to be skipped (offset). [optional] @@ -3452,7 +3452,7 @@ def api_v2_test_plans_id_unlock_request_post( ): """Send unlock TestPlan notification # noqa: E501 - Use case User sets test plan identifier User runs method execution System send unlock test plan notification # noqa: E501 + Use case User sets test plan identifier User runs method execution System send unlock test plan notification # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3460,7 +3460,7 @@ def api_v2_test_plans_id_unlock_request_post( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -3534,7 +3534,7 @@ def api_v2_test_plans_shorts_post( ): """Get TestPlans short models by Project identifiers # noqa: E501 - Use case User sets projects identifiers User runs method execution System return test plans short models (listed in response example) # noqa: E501 + Use case User sets projects identifiers User runs method execution System return test plans short models (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3615,7 +3615,7 @@ def clone( ): """Clone TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System clones test plan System returns test plan (listed in response example) # noqa: E501 + Use case User sets test plan identifier User runs method execution System clones test plan System returns test plan (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3623,7 +3623,7 @@ def clone( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -3698,7 +3698,7 @@ def complete( ): """Complete TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System completes the test plan and updates test plan status System returns no content response # noqa: E501 + Use case User sets test plan identifier User runs method execution System completes the test plan and updates test plan status System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3706,7 +3706,7 @@ def complete( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -3780,7 +3780,7 @@ def create_test_plan( ): """Create TestPlan # noqa: E501 - Use case User sets test plan properties (listed in request example) User runs method execution System creates test plan System returns test plan (listed in response example) # noqa: E501 + Use case User sets test plan properties (listed in request example) User runs method execution System creates test plan System returns test plan (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3860,7 +3860,7 @@ def delete_test_plan( ): """Delete TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System delete test plan System returns no content response # noqa: E501 + Use case User sets test plan identifier User runs method execution System delete test plan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3868,7 +3868,7 @@ def delete_test_plan( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -3943,7 +3943,7 @@ def get_test_plan_by_id( ): """Get TestPlan by Id # noqa: E501 - Use case User sets test plan identifier User runs method execution System search test plan by the identifier System returns test plan # noqa: E501 + Use case User sets test plan identifier User runs method execution System search test plan by the identifier System returns test plan # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3951,7 +3951,7 @@ def get_test_plan_by_id( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -4026,7 +4026,7 @@ def get_test_suites_by_id( ): """Get TestSuites Tree By Id # noqa: E501 - Use case User sets test plan identifier User runs method execution System finds test suites related to the test plan System returns test suites as a tree model (listed in response example) # noqa: E501 + Use case User sets test plan identifier User runs method execution System finds test suites related to the test plan System returns test suites as a tree model (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4034,7 +4034,7 @@ def get_test_suites_by_id( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -4109,7 +4109,7 @@ def pause( ): """Pause TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System pauses the test plan and updates test plan status System returns no content response # noqa: E501 + Use case User sets test plan identifier User runs method execution System pauses the test plan and updates test plan status System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4117,7 +4117,7 @@ def pause( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -4274,7 +4274,7 @@ def restore_test_plan( ): """Restore TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System restores test plan System returns no content response # noqa: E501 + Use case User sets test plan identifier User runs method execution System restores test plan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4282,7 +4282,7 @@ def restore_test_plan( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -4357,7 +4357,7 @@ def start( ): """Start TestPlan # noqa: E501 - Use case User sets test plan identifier User runs method execution System starts the test plan and updates test plan status System returns no content response # noqa: E501 + Use case User sets test plan identifier User runs method execution System starts the test plan and updates test plan status System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -4365,7 +4365,7 @@ def start( >>> result = thread.get() Args: - id (str): Test plan internal (guid format) or global (int format) identifier + id (str): Test plan internal (guid format) or global (int format) identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -4439,7 +4439,7 @@ def update_test_plan( ): """Update TestPlan # noqa: E501 - Use case User sets test plan properties(listed in request example) User runs method execution System updates test plan System returns no content response # noqa: E501 + Use case User sets test plan properties(listed in request example) User runs method execution System updates test plan System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/test_points_api.py b/src/testit_api_client/api/test_points_api.py index dacecc47..bcc18e11 100644 --- a/src/testit_api_client/api/test_points_api.py +++ b/src/testit_api_client/api/test_points_api.py @@ -45,7 +45,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPoints/{id}/testRuns', 'operation_id': 'api_v2_test_points_id_test_runs_get', @@ -97,7 +97,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPoints/{id}/workItem', 'operation_id': 'api_v2_test_points_id_work_item_get', @@ -149,7 +149,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPoints/search/id', 'operation_id': 'api_v2_test_points_search_id_post', @@ -225,7 +225,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPointShortResponseModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testPoints/search', 'operation_id': 'api_v2_test_points_search_post', diff --git a/src/testit_api_client/api/test_results_api.py b/src/testit_api_client/api/test_results_api.py index efea3312..65a67a68 100644 --- a/src/testit_api_client/api/test_results_api.py +++ b/src/testit_api_client/api/test_results_api.py @@ -54,7 +54,7 @@ def __init__(self, api_client=None): 'response_type': (GetExternalFormApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/external-projects/{externalProjectId}/defects/external-forms', 'operation_id': 'api_v2_test_results_external_projects_external_project_id_defects_external_forms_post', @@ -112,7 +112,7 @@ def __init__(self, api_client=None): 'response_type': (DefectApiModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/external-projects/{externalProjectId}/defects', 'operation_id': 'api_v2_test_results_external_projects_external_project_id_defects_post', @@ -170,7 +170,7 @@ def __init__(self, api_client=None): 'response_type': (TestResultResponse,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/aggregated', 'operation_id': 'api_v2_test_results_id_aggregated_get', @@ -222,7 +222,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments/{attachmentId}', 'operation_id': 'api_v2_test_results_id_attachments_attachment_id_put', @@ -280,7 +280,7 @@ def __init__(self, api_client=None): 'response_type': ([AttachmentApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments/info', 'operation_id': 'api_v2_test_results_id_attachments_info_get', @@ -332,7 +332,7 @@ def __init__(self, api_client=None): 'response_type': (TestResultResponse,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}', 'operation_id': 'api_v2_test_results_id_get', @@ -384,7 +384,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}', 'operation_id': 'api_v2_test_results_id_patch', @@ -442,7 +442,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}', 'operation_id': 'api_v2_test_results_id_put', @@ -500,7 +500,7 @@ def __init__(self, api_client=None): 'response_type': (RerunsApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/reruns', 'operation_id': 'api_v2_test_results_id_reruns_get', @@ -552,7 +552,7 @@ def __init__(self, api_client=None): 'response_type': ([TestResultShortResponse],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/search', 'operation_id': 'api_v2_test_results_search_post', @@ -628,7 +628,7 @@ def __init__(self, api_client=None): 'response_type': (TestResultsStatisticsApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/statistics/filter', 'operation_id': 'api_v2_test_results_statistics_filter_post', @@ -679,7 +679,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments', 'operation_id': 'create_attachment', @@ -738,7 +738,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments/{attachmentId}', 'operation_id': 'delete_attachment', @@ -796,7 +796,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments/{attachmentId}', 'operation_id': 'download_attachment', @@ -899,7 +899,7 @@ def __init__(self, api_client=None): 'response_type': (AttachmentApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments/{attachmentId}/info', 'operation_id': 'get_attachment', @@ -957,7 +957,7 @@ def __init__(self, api_client=None): 'response_type': ([AttachmentApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testResults/{id}/attachments', 'operation_id': 'get_attachments', @@ -1920,7 +1920,7 @@ def create_attachment( ): """Upload and link attachment to TestResult # noqa: E501 - Use case User sets testResultId User attaches a file System creates attachment and links it to the test result System returns attachment identifier # noqa: E501 + Use case User sets testResultId User attaches a file System creates attachment and links it to the test result System returns attachment identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2005,7 +2005,7 @@ def delete_attachment( ): """Remove attachment and unlink from TestResult # noqa: E501 - Use case User sets testResultId and attachmentId User attaches a file User runs method execution System deletes attachment and unlinks it from the test result System returns attachment identifier # noqa: E501 + Use case User sets testResultId and attachmentId User attaches a file User runs method execution System deletes attachment and unlinks it from the test result System returns attachment identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2092,7 +2092,7 @@ def download_attachment( ): """Get attachment of TestResult # noqa: E501 - Use case User sets attachmentId and testResultId [Optional] User sets resize configuration User runs method execution System search attachments by the attachmentId and the testResultId [Optional] If resize configuration is set, System resizes the attachment according to the resize configuration [Optional] Otherwise, System does not resize the attachment System returns attachment as a file # noqa: E501 + Use case User sets attachmentId and testResultId [Optional] User sets resize configuration User runs method execution System search attachments by the attachmentId and the testResultId [Optional] If resize configuration is set, System resizes the attachment according to the resize configuration [Optional] Otherwise, System does not resize the attachment System returns attachment as a file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2184,7 +2184,7 @@ def get_attachment( ): """Get Metadata of TestResult's attachment # noqa: E501 - Use case User sets attachmentId and testResultId User runs method execution System search attachment by the attachmentId and the testResultId System returns attachment data # noqa: E501 + Use case User sets attachmentId and testResultId User runs method execution System search attachment by the attachmentId and the testResultId System returns attachment data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2270,7 +2270,7 @@ def get_attachments( ): """Get all attachments of TestResult # noqa: E501 - Use case User sets testResultId User runs method execution System search all attachments of the test result System returns attachments enumeration # noqa: E501 + Use case User sets testResultId User runs method execution System search all attachments of the test result System returns attachments enumeration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/test_runs_api.py b/src/testit_api_client/api/test_runs_api.py index bff3e9f6..5c7b83b6 100644 --- a/src/testit_api_client/api/test_runs_api.py +++ b/src/testit_api_client/api/test_runs_api.py @@ -60,7 +60,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns', 'operation_id': 'api_v2_test_runs_delete', @@ -111,7 +111,7 @@ def __init__(self, api_client=None): 'response_type': (AutoTestNamespacesCountResponse,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/autoTestsNamespaces', 'operation_id': 'api_v2_test_runs_id_auto_tests_namespaces_get', @@ -163,7 +163,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}', 'operation_id': 'api_v2_test_runs_id_delete', @@ -215,7 +215,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}', 'operation_id': 'api_v2_test_runs_id_patch', @@ -273,7 +273,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/purge', 'operation_id': 'api_v2_test_runs_id_purge_post', @@ -325,7 +325,7 @@ def __init__(self, api_client=None): 'response_type': (ManualRerunApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/reruns', 'operation_id': 'api_v2_test_runs_id_reruns_post', @@ -383,7 +383,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/restore', 'operation_id': 'api_v2_test_runs_id_restore_post', @@ -435,7 +435,7 @@ def __init__(self, api_client=None): 'response_type': (TestResultsStatisticsApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/statistics/filter', 'operation_id': 'api_v2_test_runs_id_statistics_filter_post', @@ -493,7 +493,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPointResultApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/testPoints/results', 'operation_id': 'api_v2_test_runs_id_test_points_results_get', @@ -545,7 +545,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/testResults/bulk', 'operation_id': 'api_v2_test_runs_id_test_results_bulk_put', @@ -603,7 +603,7 @@ def __init__(self, api_client=None): 'response_type': (datetime, none_type,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/testResults/lastModified/modificationDate', 'operation_id': 'api_v2_test_runs_id_test_results_last_modified_modification_date_get', @@ -655,7 +655,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/purge/bulk', 'operation_id': 'api_v2_test_runs_purge_bulk_post', @@ -706,7 +706,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/restore/bulk', 'operation_id': 'api_v2_test_runs_restore_bulk_post', @@ -757,7 +757,7 @@ def __init__(self, api_client=None): 'response_type': ([TestRunShortApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/search', 'operation_id': 'api_v2_test_runs_search_post', @@ -833,7 +833,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/updateMultiple', 'operation_id': 'api_v2_test_runs_update_multiple_post', @@ -884,7 +884,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/complete', 'operation_id': 'complete_test_run', @@ -936,7 +936,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunV2ApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/byAutoTests', 'operation_id': 'create_and_fill_by_auto_tests', @@ -987,7 +987,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunV2ApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/byConfigurations', 'operation_id': 'create_and_fill_by_configurations', @@ -1038,7 +1038,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunV2ApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/byWorkItems', 'operation_id': 'create_and_fill_by_work_items', @@ -1089,7 +1089,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunV2ApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns', 'operation_id': 'create_empty', @@ -1140,7 +1140,7 @@ def __init__(self, api_client=None): 'response_type': (TestRunV2ApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}', 'operation_id': 'get_test_run_by_id', @@ -1192,7 +1192,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/testResults', 'operation_id': 'set_auto_test_results_for_test_run', @@ -1250,7 +1250,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/start', 'operation_id': 'start_test_run', @@ -1302,7 +1302,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns/{id}/stop', 'operation_id': 'stop_test_run', @@ -1354,7 +1354,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testRuns', 'operation_id': 'update_empty', @@ -1407,7 +1407,7 @@ def api_v2_test_runs_delete( ): """Delete multiple test runs # noqa: E501 - Use case User sets selection parameters of test runs System search and delete collection of test runs System returns the number of deleted test runs # noqa: E501 + Use case User sets selection parameters of test runs System search and delete collection of test runs System returns the number of deleted test runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1569,7 +1569,7 @@ def api_v2_test_runs_id_delete( ): """Delete test run # noqa: E501 - Use case User sets test run internal (guid format) identifier System search and delete test run # noqa: E501 + Use case User sets test run internal (guid format) identifier System search and delete test run # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1736,7 +1736,7 @@ def api_v2_test_runs_id_purge_post( ): """Permanently delete test run from archive # noqa: E501 - Use case User sets archived test run internal (guid format) identifier System search and purge archived test run # noqa: E501 + Use case User sets archived test run internal (guid format) identifier System search and purge archived test run # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1902,7 +1902,7 @@ def api_v2_test_runs_id_restore_post( ): """Restore test run from the archive # noqa: E501 - Use case User sets archived test run internal (guid format) identifier System search and restore test run # noqa: E501 + Use case User sets archived test run internal (guid format) identifier System search and restore test run # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2314,7 +2314,7 @@ def api_v2_test_runs_purge_bulk_post( ): """Permanently delete multiple test runs from archive # noqa: E501 - Use case User sets selection parameters of archived test runs System search and delete collection of archived test runs System returns the number of deleted archived test runs # noqa: E501 + Use case User sets selection parameters of archived test runs System search and delete collection of archived test runs System returns the number of deleted archived test runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2393,7 +2393,7 @@ def api_v2_test_runs_restore_bulk_post( ): """Restore multiple test runs from the archive # noqa: E501 - Use case User sets selection parameters of archived test runs System search and restore collection of archived test runs System returns the number of restored test runs # noqa: E501 + Use case User sets selection parameters of archived test runs System search and restore collection of archived test runs System returns the number of restored test runs # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2634,7 +2634,7 @@ def complete_test_run( ): """Complete TestRun # noqa: E501 - Use case User sets test run identifier User runs method execution System completes test run System returns no content response # noqa: E501 + Use case User sets test run identifier User runs method execution System completes test run System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2716,7 +2716,7 @@ def create_and_fill_by_auto_tests( ): """Create test runs based on autotests and configurations # noqa: E501 - This method creates a test run based on an autotest and a configuration. The difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is that in this method there is no need to create a test plan and work items (test cases and checklists). # noqa: E501 + This method creates a test run based on an autotest and a configuration. The difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is that in this method there is no need to create a test plan and work items (test cases and checklists). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2795,7 +2795,7 @@ def create_and_fill_by_configurations( ): """Create test runs picking the needed test points # noqa: E501 - This method creates a test run based on a combination of a configuration and a work item(test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. This method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a jagged array within the \"testPointSelectors\" parameter. # noqa: E501 + This method creates a test run based on a combination of a configuration and a work item(test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. This method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a jagged array within the \"testPointSelectors\" parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2874,7 +2874,7 @@ def create_and_fill_by_work_items( ): """Create test run based on configurations and work items # noqa: E501 - This method creates a test run based on a combination of configuration and work item (test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. # noqa: E501 + This method creates a test run based on a combination of configuration and work item (test case or checklist). Before you create a test run using this method, make sure to create a test plan. Work items must be automated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2953,7 +2953,7 @@ def create_empty( ): """Create empty TestRun # noqa: E501 - Use case User sets test run model (listed in the request example) User runs method execution System creates test run System returns test run model # noqa: E501 + Use case User sets test run model (listed in the request example) User runs method execution System creates test run System returns test run model # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3033,7 +3033,7 @@ def get_test_run_by_id( ): """Get TestRun by Id # noqa: E501 - Use case User sets test run identifier User runs method execution System finds test run System returns test run # noqa: E501 + Use case User sets test run identifier User runs method execution System finds test run System returns test run # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3200,7 +3200,7 @@ def start_test_run( ): """Start TestRun # noqa: E501 - Use case User sets test run identifier User runs method execution System starts test run System returns no content response # noqa: E501 + Use case User sets test run identifier User runs method execution System starts test run System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3283,7 +3283,7 @@ def stop_test_run( ): """Stop TestRun # noqa: E501 - Use case User sets test run identifier User runs method execution System stops test run System returns no content response # noqa: E501 + Use case User sets test run identifier User runs method execution System stops test run System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3365,7 +3365,7 @@ def update_empty( ): """Update empty TestRun # noqa: E501 - Use case User sets test run properties (listed in the request example) User runs method execution System updates test run System returns returns no content response # noqa: E501 + Use case User sets test run properties (listed in the request example) User runs method execution System updates test run System returns returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/test_statuses_api.py b/src/testit_api_client/api/test_statuses_api.py index 776d13f2..808b6da8 100644 --- a/src/testit_api_client/api/test_statuses_api.py +++ b/src/testit_api_client/api/test_statuses_api.py @@ -46,7 +46,7 @@ def __init__(self, api_client=None): 'response_type': (bool,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/code/{code}/exists', 'operation_id': 'api_v2_test_statuses_code_code_exists_get', @@ -100,7 +100,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/{id}', 'operation_id': 'api_v2_test_statuses_id_delete', @@ -152,7 +152,7 @@ def __init__(self, api_client=None): 'response_type': (TestStatusApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/{id}', 'operation_id': 'api_v2_test_statuses_id_get', @@ -206,7 +206,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/{id}', 'operation_id': 'api_v2_test_statuses_id_put', @@ -267,7 +267,7 @@ def __init__(self, api_client=None): 'response_type': (bool,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/name/{name}/exists', 'operation_id': 'api_v2_test_statuses_name_name_exists_get', @@ -321,7 +321,7 @@ def __init__(self, api_client=None): 'response_type': (TestStatusApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses', 'operation_id': 'api_v2_test_statuses_post', @@ -377,7 +377,7 @@ def __init__(self, api_client=None): 'response_type': (TestStatusApiResultIReply,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testStatuses/search', 'operation_id': 'api_v2_test_statuses_search_post', diff --git a/src/testit_api_client/api/test_suites_api.py b/src/testit_api_client/api/test_suites_api.py index 6e46ac14..73e6f582 100644 --- a/src/testit_api_client/api/test_suites_api.py +++ b/src/testit_api_client/api/test_suites_api.py @@ -52,7 +52,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/test-points', 'operation_id': 'add_test_points_to_test_suite', @@ -110,7 +110,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}', 'operation_id': 'api_v2_test_suites_id_patch', @@ -168,7 +168,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/refresh', 'operation_id': 'api_v2_test_suites_id_refresh_post', @@ -220,7 +220,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/workItems', 'operation_id': 'api_v2_test_suites_id_work_items_post', @@ -282,7 +282,7 @@ def __init__(self, api_client=None): 'response_type': (TestSuiteV2GetModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites', 'operation_id': 'api_v2_test_suites_post', @@ -333,7 +333,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites', 'operation_id': 'api_v2_test_suites_put', @@ -384,7 +384,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}', 'operation_id': 'delete_test_suite', @@ -436,7 +436,7 @@ def __init__(self, api_client=None): 'response_type': ([ConfigurationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/configurations', 'operation_id': 'get_configurations_by_test_suite_id', @@ -488,7 +488,7 @@ def __init__(self, api_client=None): 'response_type': ([TestPointByTestSuiteModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/testPoints', 'operation_id': 'get_test_points_by_id', @@ -540,7 +540,7 @@ def __init__(self, api_client=None): 'response_type': ([TestResultV2ShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/testResults', 'operation_id': 'get_test_results_by_id', @@ -592,7 +592,7 @@ def __init__(self, api_client=None): 'response_type': (TestSuiteApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}', 'operation_id': 'get_test_suite_by_id', @@ -644,7 +644,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemShortModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/workItems/search', 'operation_id': 'search_work_items', @@ -727,7 +727,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/testSuites/{id}/configurations', 'operation_id': 'set_configurations_by_test_suite_id', @@ -1280,7 +1280,7 @@ def delete_test_suite( ): """Delete TestSuite # noqa: E501 - Use case User sets test suite identifier User runs method execution System search test suite by identifier System deletes test suite System returns no content response # noqa: E501 + Use case User sets test suite identifier User runs method execution System search test suite by identifier System deletes test suite System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1363,7 +1363,7 @@ def get_configurations_by_test_suite_id( ): """Get Configurations By Id # noqa: E501 - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search configurations related to the test points System returns configurations array # noqa: E501 + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search configurations related to the test points System returns configurations array # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1446,7 +1446,7 @@ def get_test_points_by_id( ): """Get TestPoints By Id # noqa: E501 - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System returns test points array # noqa: E501 + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System returns test points array # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1529,7 +1529,7 @@ def get_test_results_by_id( ): """Get TestResults By Id # noqa: E501 - Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search test results related to the test points System returns test results array # noqa: E501 + Use case User sets test suite identifier User runs method execution System search test suite by identifier System search test points related to the test suite System search test results related to the test points System returns test results array # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1612,7 +1612,7 @@ def get_test_suite_by_id( ): """Get TestSuite by Id # noqa: E501 - Use case User sets test suite identifier User runs method execution System search test suite by identifier System returns test suite # noqa: E501 + Use case User sets test suite identifier User runs method execution System search test suite by identifier System returns test suite # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1695,7 +1695,7 @@ def search_work_items( ): """Search WorkItems # noqa: E501 - Use case User sets test suite identifier [Optional] User sets filter User runs method execution System search test suite by identifier System search test points related to the test suite System search work items related to the test points [Optional] User sets filter, system applies filter System returns work items array # noqa: E501 + Use case User sets test suite identifier [Optional] User sets filter User runs method execution System search test suite by identifier System search test points related to the test suite System search work items related to the test points [Optional] User sets filter, system applies filter System returns work items array # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1784,7 +1784,7 @@ def set_configurations_by_test_suite_id( ): """Set Configurations By TestSuite Id # noqa: E501 - Use case User sets test suite identifier User sets collection of configuration identifiers User runs method execution System search test suite by identifier System search test points related to the test suite System search configuration System restores(if exist) or creates test points with listed configuration System returns no content response # noqa: E501 + Use case User sets test suite identifier User sets collection of configuration identifiers User runs method execution System search test suite by identifier System search test points related to the test suite System search configuration System restores(if exist) or creates test points with listed configuration System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/user_role_assignments_api.py b/src/testit_api_client/api/user_role_assignments_api.py new file mode 100644 index 00000000..199c8c7a --- /dev/null +++ b/src/testit_api_client/api/user_role_assignments_api.py @@ -0,0 +1,327 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class UserRoleAssignmentsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_users_user_id_roles_role_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/users/{userId}/roles/{roleId}', + 'operation_id': 'api_v2_users_user_id_roles_role_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'role_id', + ], + 'required': [ + 'user_id', + 'role_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'role_id': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'role_id': 'roleId', + }, + 'location_map': { + 'user_id': 'path', + 'role_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_users_user_id_roles_role_id_post_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/users/{userId}/roles/{roleId}', + 'operation_id': 'api_v2_users_user_id_roles_role_id_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'role_id', + ], + 'required': [ + 'user_id', + 'role_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'role_id': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'role_id': 'roleId', + }, + 'location_map': { + 'user_id': 'path', + 'role_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def api_v2_users_user_id_roles_role_id_delete( + self, + user_id, + role_id, + **kwargs + ): + """api_v2_users_user_id_roles_role_id_delete # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_users_user_id_roles_role_id_delete(user_id, role_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + role_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['role_id'] = \ + role_id + return self.api_v2_users_user_id_roles_role_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_users_user_id_roles_role_id_post( + self, + user_id, + role_id, + **kwargs + ): + """api_v2_users_user_id_roles_role_id_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_users_user_id_roles_role_id_post(user_id, role_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + role_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['role_id'] = \ + role_id + return self.api_v2_users_user_id_roles_role_id_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/user_storages_api.py b/src/testit_api_client/api/user_storages_api.py new file mode 100644 index 00000000..82594c69 --- /dev/null +++ b/src/testit_api_client/api/user_storages_api.py @@ -0,0 +1,315 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.api_client import ApiClient, Endpoint as _Endpoint +from testit_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.validation_problem_details import ValidationProblemDetails + + +class UserStoragesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_v2_user_storages_resource_get_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/user-storages/{resource}', + 'operation_id': 'api_v2_user_storages_resource_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'resource', + ], + 'required': [ + 'resource', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'resource', + ] + }, + root_map={ + 'validations': { + ('resource',): { + 'max_length': 128, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'resource': + (str,), + }, + 'attribute_map': { + 'resource': 'resource', + }, + 'location_map': { + 'resource': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_user_storages_resource_post_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/user-storages/{resource}', + 'operation_id': 'api_v2_user_storages_resource_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'resource', + ], + 'required': [ + 'resource', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'resource', + ] + }, + root_map={ + 'validations': { + ('resource',): { + 'max_length': 128, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'resource': + (str,), + }, + 'attribute_map': { + 'resource': 'resource', + }, + 'location_map': { + 'resource': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def api_v2_user_storages_resource_get( + self, + resource, + **kwargs + ): + """api_v2_user_storages_resource_get # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_user_storages_resource_get(resource, async_req=True) + >>> result = thread.get() + + Args: + resource (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['resource'] = \ + resource + return self.api_v2_user_storages_resource_get_endpoint.call_with_http_info(**kwargs) + + def api_v2_user_storages_resource_post( + self, + resource, + **kwargs + ): + """api_v2_user_storages_resource_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_user_storages_resource_post(resource, async_req=True) + >>> result = thread.get() + + Args: + resource (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['resource'] = \ + resource + return self.api_v2_user_storages_resource_post_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/users_api.py b/src/testit_api_client/api/users_api.py index 320d5a9c..6d53b830 100644 --- a/src/testit_api_client/api/users_api.py +++ b/src/testit_api_client/api/users_api.py @@ -21,7 +21,9 @@ none_type, validate_and_convert_types ) +from testit_api_client.model.api_v2_users_post_request import ApiV2UsersPostRequest from testit_api_client.model.problem_details import ProblemDetails +from testit_api_client.model.user_api_model import UserApiModel from testit_api_client.model.user_custom_name_validation_response import UserCustomNameValidationResponse from testit_api_client.model.validation_problem_details import ValidationProblemDetails @@ -42,7 +44,7 @@ def __init__(self, api_client=None): 'response_type': (UserCustomNameValidationResponse,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/users/exists', 'operation_id': 'api_v2_users_exists_get', @@ -87,6 +89,161 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.api_v2_users_post_endpoint = _Endpoint( + settings={ + 'response_type': (UserApiModel,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/users', + 'operation_id': 'api_v2_users_post', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'api_v2_users_post_request', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'api_v2_users_post_request': + (ApiV2UsersPostRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'api_v2_users_post_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.api_v2_users_user_id_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/users/{userId}', + 'operation_id': 'api_v2_users_user_id_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + ], + 'required': [ + 'user_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + }, + 'location_map': { + 'user_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_v2_users_user_id_get_endpoint = _Endpoint( + settings={ + 'response_type': (UserApiModel,), + 'auth': [ + 'PrivateToken', + 'Cookies' + ], + 'endpoint_path': '/api/v2/users/{userId}', + 'operation_id': 'api_v2_users_user_id_get', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + ], + 'required': [ + 'user_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + }, + 'location_map': { + 'user_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) def api_v2_users_exists_get( self, @@ -166,3 +323,245 @@ def api_v2_users_exists_get( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.api_v2_users_exists_get_endpoint.call_with_http_info(**kwargs) + def api_v2_users_post( + self, + **kwargs + ): + """api_v2_users_post # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_users_post(async_req=True) + >>> result = thread.get() + + + Keyword Args: + api_v2_users_post_request (ApiV2UsersPostRequest): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + UserApiModel + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.api_v2_users_post_endpoint.call_with_http_info(**kwargs) + + def api_v2_users_user_id_delete( + self, + user_id, + **kwargs + ): + """api_v2_users_user_id_delete # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_users_user_id_delete(user_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + return self.api_v2_users_user_id_delete_endpoint.call_with_http_info(**kwargs) + + def api_v2_users_user_id_get( + self, + user_id, + **kwargs + ): + """api_v2_users_user_id_get # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_v2_users_user_id_get(user_id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + UserApiModel + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + return self.api_v2_users_user_id_get_endpoint.call_with_http_info(**kwargs) + diff --git a/src/testit_api_client/api/webhooks_api.py b/src/testit_api_client/api/webhooks_api.py index 6c757a29..1dd82ee4 100644 --- a/src/testit_api_client/api/webhooks_api.py +++ b/src/testit_api_client/api/webhooks_api.py @@ -51,7 +51,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks', 'operation_id': 'api_v2_webhooks_delete', @@ -102,7 +102,7 @@ def __init__(self, api_client=None): 'response_type': ([WebHookModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks', 'operation_id': 'api_v2_webhooks_get', @@ -152,7 +152,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/{id}', 'operation_id': 'api_v2_webhooks_id_delete', @@ -204,7 +204,7 @@ def __init__(self, api_client=None): 'response_type': (WebHookModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/{id}', 'operation_id': 'api_v2_webhooks_id_get', @@ -256,7 +256,7 @@ def __init__(self, api_client=None): 'response_type': (WebHookModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/{id}', 'operation_id': 'api_v2_webhooks_id_put', @@ -314,7 +314,7 @@ def __init__(self, api_client=None): 'response_type': (WebHookModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks', 'operation_id': 'api_v2_webhooks_post', @@ -365,7 +365,7 @@ def __init__(self, api_client=None): 'response_type': (WebhooksUpdateApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks', 'operation_id': 'api_v2_webhooks_put', @@ -416,7 +416,7 @@ def __init__(self, api_client=None): 'response_type': ([WebHookModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/search', 'operation_id': 'api_v2_webhooks_search_post', @@ -492,7 +492,7 @@ def __init__(self, api_client=None): 'response_type': ([str],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/specialVariables', 'operation_id': 'api_v2_webhooks_special_variables_get', @@ -547,7 +547,7 @@ def __init__(self, api_client=None): 'response_type': (WebhookResponse,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/test', 'operation_id': 'api_v2_webhooks_test_post', diff --git a/src/testit_api_client/api/webhooks_logs_api.py b/src/testit_api_client/api/webhooks_logs_api.py index b838fb18..d51ecb72 100644 --- a/src/testit_api_client/api/webhooks_logs_api.py +++ b/src/testit_api_client/api/webhooks_logs_api.py @@ -42,7 +42,7 @@ def __init__(self, api_client=None): 'response_type': ([WebhookLogApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/logs', 'operation_id': 'api_v2_webhooks_logs_get', @@ -117,7 +117,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/logs/{id}', 'operation_id': 'api_v2_webhooks_logs_id_delete', @@ -169,7 +169,7 @@ def __init__(self, api_client=None): 'response_type': (WebhookLogApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/webhooks/logs/{id}', 'operation_id': 'api_v2_webhooks_logs_id_get', diff --git a/src/testit_api_client/api/work_items_api.py b/src/testit_api_client/api/work_items_api.py index 33aba8ad..09f8ea81 100644 --- a/src/testit_api_client/api/work_items_api.py +++ b/src/testit_api_client/api/work_items_api.py @@ -63,7 +63,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/attachments', 'operation_id': 'api_v2_work_items_id_attachments_post', @@ -122,7 +122,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/checkList/transformTo/testCase', 'operation_id': 'api_v2_work_items_id_check_list_transform_to_test_case_post', @@ -174,7 +174,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemChangeModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/history', 'operation_id': 'api_v2_work_items_id_history_get', @@ -251,7 +251,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/like', 'operation_id': 'api_v2_work_items_id_like_delete', @@ -303,7 +303,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/like', 'operation_id': 'api_v2_work_items_id_like_post', @@ -355,7 +355,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/likes/count', 'operation_id': 'api_v2_work_items_id_likes_count_get', @@ -407,7 +407,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemLikeModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/likes', 'operation_id': 'api_v2_work_items_id_likes_get', @@ -459,7 +459,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}', 'operation_id': 'api_v2_work_items_id_patch', @@ -517,7 +517,7 @@ def __init__(self, api_client=None): 'response_type': ([TestResultHistoryReportApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/testResults/history', 'operation_id': 'api_v2_work_items_id_test_results_history_get', @@ -650,7 +650,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/version/{versionId}/actual', 'operation_id': 'api_v2_work_items_id_version_version_id_actual_post', @@ -708,7 +708,7 @@ def __init__(self, api_client=None): 'response_type': (SearchWorkItemLinkUrlsApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/links/urls/search', 'operation_id': 'api_v2_work_items_links_urls_search_post', @@ -784,7 +784,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemShortModel,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/move', 'operation_id': 'api_v2_work_items_move_post', @@ -835,7 +835,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems', 'operation_id': 'api_v2_work_items_post', @@ -886,7 +886,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems', 'operation_id': 'api_v2_work_items_put', @@ -937,7 +937,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemShortApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/search', 'operation_id': 'api_v2_work_items_search_post', @@ -1013,7 +1013,7 @@ def __init__(self, api_client=None): 'response_type': ([SharedStepReferenceSectionModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{sharedStepId}/references/sections', 'operation_id': 'api_v2_work_items_shared_step_id_references_sections_post', @@ -1096,7 +1096,7 @@ def __init__(self, api_client=None): 'response_type': ([SharedStepReferenceModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{sharedStepId}/references/workItems', 'operation_id': 'api_v2_work_items_shared_step_id_references_work_items_post', @@ -1179,7 +1179,7 @@ def __init__(self, api_client=None): 'response_type': ([SharedStepReferenceModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/sharedSteps/{sharedStepId}/references', 'operation_id': 'api_v2_work_items_shared_steps_shared_step_id_references_get', @@ -1231,7 +1231,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/autoTests', 'operation_id': 'delete_all_work_items_from_auto_test', @@ -1283,7 +1283,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}', 'operation_id': 'delete_work_item', @@ -1335,7 +1335,7 @@ def __init__(self, api_client=None): 'response_type': ([AutoTestModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/autoTests', 'operation_id': 'get_auto_tests_for_work_item', @@ -1387,7 +1387,7 @@ def __init__(self, api_client=None): 'response_type': ([IterationModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/iterations', 'operation_id': 'get_iterations', @@ -1449,7 +1449,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}', 'operation_id': 'get_work_item_by_id', @@ -1511,7 +1511,7 @@ def __init__(self, api_client=None): 'response_type': ([TestResultChronologyModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/chronology', 'operation_id': 'get_work_item_chronology', @@ -1563,7 +1563,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemVersionModel],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/versions', 'operation_id': 'get_work_item_versions', @@ -1625,7 +1625,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/purge', 'operation_id': 'purge_work_item', @@ -1677,7 +1677,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/restore', 'operation_id': 'restore_work_item', @@ -1732,7 +1732,7 @@ def api_v2_work_items_id_attachments_post( ): """Upload and link attachment to WorkItem # noqa: E501 - Use case User sets workItemId User attaches a file System creates attachment and links it to the work item System returns attachment identifier # noqa: E501 + Use case User sets workItemId User attaches a file System creates attachment and links it to the work item System returns attachment identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1816,7 +1816,7 @@ def api_v2_work_items_id_check_list_transform_to_test_case_post( ): """Transform CheckList to TestCase # noqa: E501 - Use case User sets checklist identifier User runs method execution System transform CheckList to TestCase # noqa: E501 + Use case User sets checklist identifier User runs method execution System transform CheckList to TestCase # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1899,7 +1899,7 @@ def api_v2_work_items_id_history_get( ): """Get change history of WorkItem # noqa: E501 - Use case User sets work item identifier User runs method execution System return change history of WorkItem # noqa: E501 + Use case User sets work item identifier User runs method execution System return change history of WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1987,7 +1987,7 @@ def api_v2_work_items_id_like_delete( ): """Delete like from WorkItem # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System delete like from WorkItem # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System delete like from WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2070,7 +2070,7 @@ def api_v2_work_items_id_like_post( ): """Set like to WorkItem # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System set like to WorkItem # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System set like to WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2153,7 +2153,7 @@ def api_v2_work_items_id_likes_count_get( ): """Get likes count of WorkItem # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System return likes count of WorkItem # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System return likes count of WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2236,7 +2236,7 @@ def api_v2_work_items_id_likes_get( ): """Get likes of WorkItem # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System return likes of WorkItem # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System return likes of WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2327,7 +2327,7 @@ def api_v2_work_items_id_patch( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: operation ([Operation]): [optional] @@ -2403,7 +2403,7 @@ def api_v2_work_items_id_test_results_history_get( ): """Get test results history of WorkItem # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System return test results history of WorkItem # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System return test results history of WorkItem # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2502,7 +2502,7 @@ def api_v2_work_items_id_version_version_id_actual_post( ): """Set WorkItem as actual # noqa: E501 - Use case User sets work item identifier User runs method execution System set WorkItem as actual # noqa: E501 + Use case User sets work item identifier User runs method execution System set WorkItem as actual # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2670,7 +2670,7 @@ def api_v2_work_items_move_post( ): """Move WorkItem to another section # noqa: E501 - Use case User sets WorkItem identifier User runs method execution System move WorkItem to another section # noqa: E501 + Use case User sets WorkItem identifier User runs method execution System move WorkItem to another section # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2827,7 +2827,7 @@ def api_v2_work_items_put( ): """Update Test Case, Checklist or Shared Step # noqa: E501 - Use case User sets work item properties (listed in request parameters) User runs method execution System updates work item by identifier System returns updated work item model (listed in response parameters) # noqa: E501 + Use case User sets work item properties (listed in request parameters) User runs method execution System updates work item by identifier System returns updated work item model (listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2990,7 +2990,7 @@ def api_v2_work_items_shared_step_id_references_sections_post( ): """Get SharedStep references in sections # noqa: E501 - Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 + Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3079,7 +3079,7 @@ def api_v2_work_items_shared_step_id_references_work_items_post( ): """Get SharedStep references in work items # noqa: E501 - Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 + Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3168,7 +3168,7 @@ def api_v2_work_items_shared_steps_shared_step_id_references_get( ): """Get SharedStep references # noqa: E501 - Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 + Use case User sets SharedStep identifier User runs method execution System return SharedStep references # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3251,7 +3251,7 @@ def delete_all_work_items_from_auto_test( ): """Delete all links AutoTests from WorkItem by Id or GlobalId # noqa: E501 - Use case User sets work item identifier User runs method execution System search work item by identifier System search and delete all autotests, related to found work item System returns no content response # noqa: E501 + Use case User sets work item identifier User runs method execution System search work item by identifier System search and delete all autotests, related to found work item System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3259,7 +3259,7 @@ def delete_all_work_items_from_auto_test( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: _return_http_data_only (bool): response data without head status @@ -3334,7 +3334,7 @@ def delete_work_item( ): """Delete Test Case, Checklist or Shared Step by Id or GlobalId # noqa: E501 - Use case User sets work item identifier User runs method execution System deletes work item System returns no content response # noqa: E501 + Use case User sets work item identifier User runs method execution System deletes work item System returns no content response # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3342,7 +3342,7 @@ def delete_work_item( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: _return_http_data_only (bool): response data without head status @@ -3417,7 +3417,7 @@ def get_auto_tests_for_work_item( ): """Get all AutoTests linked to WorkItem by Id or GlobalId # noqa: E501 - Use case User sets work item identifier User runs method execution System search work item by identifier System search all autotests, related to found work item System returns list of found autotests # noqa: E501 + Use case User sets work item identifier User runs method execution System search work item by identifier System search all autotests, related to found work item System returns list of found autotests # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3425,7 +3425,7 @@ def get_auto_tests_for_work_item( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: _return_http_data_only (bool): response data without head status @@ -3507,7 +3507,7 @@ def get_iterations( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: version_id (str): WorkItem version (guid format) identifier. [optional] @@ -3584,7 +3584,7 @@ def get_work_item_by_id( ): """Get Test Case, Checklist or Shared Step by Id or GlobalId # noqa: E501 - Use case User sets work item identifier [Optional] User sets work item version identifier [Optional] User sets work item version number User runs method execution System search work item by identifier [Optional] if User sets work item version identifier, system search work item version by identifier. [Optional] if user sets work item version number, system search work item version by number Otherwise, system search last work item version System returns work item # noqa: E501 + Use case User sets work item identifier [Optional] User sets work item version identifier [Optional] User sets work item version number User runs method execution System search work item by identifier [Optional] if User sets work item version identifier, system search work item version by identifier. [Optional] if user sets work item version number, system search work item version by number Otherwise, system search last work item version System returns work item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3592,7 +3592,7 @@ def get_work_item_by_id( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: version_id (str): WorkItem version (guid format) identifier\". [optional] @@ -3669,7 +3669,7 @@ def get_work_item_chronology( ): """Get WorkItem chronology by Id or GlobalId # noqa: E501 - Use case User sets work item identifier User runs method execution System search work item by identifier System search test results of all autotests, related to found work item System sort results by CompletedOn ascending, then by CreatedDate ascending System returns sorted collection of test results # noqa: E501 + Use case User sets work item identifier User runs method execution System search work item by identifier System search test results of all autotests, related to found work item System sort results by CompletedOn ascending, then by CreatedDate ascending System returns sorted collection of test results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3752,7 +3752,7 @@ def get_work_item_versions( ): """Get WorkItem versions # noqa: E501 - Use case User sets work item identifier [Optional] User sets work item version identifier User runs method execution System search work item by identifier [Optional] If User set work item version identifier, System search work item version by version identifier Otherwise, system search all version of work item System returns array of work item version models (listed in response example) # noqa: E501 + Use case User sets work item identifier [Optional] User sets work item version identifier User runs method execution System search work item by identifier [Optional] If User set work item version identifier, System search work item version by version identifier Otherwise, system search all version of work item System returns array of work item version models (listed in response example) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3760,11 +3760,11 @@ def get_work_item_versions( >>> result = thread.get() Args: - id (str): WorkItem internal (guid format) or global(integer format) identifier\" + id (str): WorkItem internal (guid format) or global(integer format) identifier\" Keyword Args: - work_item_version_id (str): WorkItem version (guid format) identifier\". [optional] - version_number (int): WorkItem version (integer format) number\". [optional] + work_item_version_id (str): WorkItem version (guid format) identifier\". [optional] + version_number (int): WorkItem version (integer format) number\". [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/src/testit_api_client/api/work_items_comments_api.py b/src/testit_api_client/api/work_items_comments_api.py index 8082be07..37c10c6e 100644 --- a/src/testit_api_client/api/work_items_comments_api.py +++ b/src/testit_api_client/api/work_items_comments_api.py @@ -44,7 +44,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/comments/{commentId}', 'operation_id': 'api_v2_work_items_comments_comment_id_delete', @@ -96,7 +96,7 @@ def __init__(self, api_client=None): 'response_type': (WorkItemCommentApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/comments', 'operation_id': 'api_v2_work_items_comments_post', @@ -147,7 +147,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/comments', 'operation_id': 'api_v2_work_items_comments_put', @@ -198,7 +198,7 @@ def __init__(self, api_client=None): 'response_type': (int,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/comments/count', 'operation_id': 'api_v2_work_items_id_comments_count_get', @@ -250,7 +250,7 @@ def __init__(self, api_client=None): 'response_type': ([WorkItemCommentApiResult],), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workItems/{id}/comments', 'operation_id': 'api_v2_work_items_id_comments_get', @@ -305,7 +305,7 @@ def api_v2_work_items_comments_comment_id_delete( ): """Delete WorkItem comment # noqa: E501 - Use case User sets comment identifier User runs method execution System delete comment System returns success status code # noqa: E501 + Use case User sets comment identifier User runs method execution System delete comment System returns success status code # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -387,7 +387,7 @@ def api_v2_work_items_comments_post( ): """Create WorkItem comment # noqa: E501 - Use case User sets comment properties (listed in request parameters) User runs method execution System creates comment System returns comment model (listed in response parameters) # noqa: E501 + Use case User sets comment properties (listed in request parameters) User runs method execution System creates comment System returns comment model (listed in response parameters) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/src/testit_api_client/api/workflows_api.py b/src/testit_api_client/api/workflows_api.py index d4b89f4b..f86538b0 100644 --- a/src/testit_api_client/api/workflows_api.py +++ b/src/testit_api_client/api/workflows_api.py @@ -50,7 +50,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/{id}', 'operation_id': 'api_v2_workflows_id_delete', @@ -102,7 +102,7 @@ def __init__(self, api_client=None): 'response_type': (WorkflowApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/{id}', 'operation_id': 'api_v2_workflows_id_get', @@ -154,7 +154,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/{id}', 'operation_id': 'api_v2_workflows_id_patch', @@ -212,7 +212,7 @@ def __init__(self, api_client=None): 'response_type': (WorkflowProjectApiResultIReply,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/{id}/projects/search', 'operation_id': 'api_v2_workflows_id_projects_search_post', @@ -270,7 +270,7 @@ def __init__(self, api_client=None): 'response_type': None, 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/{id}', 'operation_id': 'api_v2_workflows_id_put', @@ -328,7 +328,7 @@ def __init__(self, api_client=None): 'response_type': (WorkflowExistsByNameApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/name/{name}/exists', 'operation_id': 'api_v2_workflows_name_name_exists_get', @@ -380,7 +380,7 @@ def __init__(self, api_client=None): 'response_type': (WorkflowApiResult,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows', 'operation_id': 'api_v2_workflows_post', @@ -431,7 +431,7 @@ def __init__(self, api_client=None): 'response_type': (WorkflowShortApiResultIReply,), 'auth': [ 'PrivateToken', - 'Identity.Application' + 'Cookies' ], 'endpoint_path': '/api/v2/workflows/search', 'operation_id': 'api_v2_workflows_search_post', diff --git a/src/testit_api_client/api_client.py b/src/testit_api_client/api_client.py index 05668a4c..5c6fa17c 100644 --- a/src/testit_api_client/api_client.py +++ b/src/testit_api_client/api_client.py @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/7.5.11/python' + self.user_agent = 'OpenAPI-Generator/7.6.0.post580/python' def __enter__(self): return self @@ -803,11 +803,11 @@ def __call__(self, *args, **kwargs): """ This method is invoked when endpoints are called Example: - api_instance = AttachmentsApi() - api_instance.api_v2_attachments_id_delete # this is an instance of the class Endpoint - api_instance.api_v2_attachments_id_delete() # this invokes api_instance.api_v2_attachments_id_delete.__call__() + api_instance = AIServicesAPIApi() + api_instance.api_v2_external_services_id_ai_models_post # this is an instance of the class Endpoint + api_instance.api_v2_external_services_id_ai_models_post() # this invokes api_instance.api_v2_external_services_id_ai_models_post.__call__() which then invokes the callable functions stored in that endpoint at - api_instance.api_v2_attachments_id_delete.callable or self.callable in this class + api_instance.api_v2_external_services_id_ai_models_post.callable or self.callable in this class """ return self.callable(self, *args, **kwargs) diff --git a/src/testit_api_client/apis/__init__.py b/src/testit_api_client/apis/__init__.py index 35bae8f3..fc88717a 100644 --- a/src/testit_api_client/apis/__init__.py +++ b/src/testit_api_client/apis/__init__.py @@ -6,7 +6,7 @@ # raise a `RecursionError`. # In order to avoid this, import only the API that you directly need like: # -# from testit_api_client.api.attachments_api import AttachmentsApi +# from testit_api_client.api.ai_services_api_api import AIServicesAPIApi # # or import this package, but before doing it, use: # @@ -14,6 +14,7 @@ # sys.setrecursionlimit(n) # Import APIs into API package: +from testit_api_client.api.ai_services_api_api import AIServicesAPIApi from testit_api_client.api.attachments_api import AttachmentsApi from testit_api_client.api.auto_tests_api import AutoTestsApi from testit_api_client.api.background_jobs_api import BackgroundJobsApi @@ -21,12 +22,16 @@ from testit_api_client.api.custom_attribute_templates_api import CustomAttributeTemplatesApi from testit_api_client.api.custom_attributes_api import CustomAttributesApi from testit_api_client.api.external_issues_api import ExternalIssuesApi +from testit_api_client.api.external_services_api import ExternalServicesApi +from testit_api_client.api.failure_categories_api import FailureCategoriesApi from testit_api_client.api.notifications_api import NotificationsApi from testit_api_client.api.open_id_connections_api import OpenIdConnectionsApi from testit_api_client.api.parameters_api import ParametersApi from testit_api_client.api.project_attribute_templates_api import ProjectAttributeTemplatesApi from testit_api_client.api.project_attributes_api import ProjectAttributesApi from testit_api_client.api.project_configurations_api import ProjectConfigurationsApi +from testit_api_client.api.project_external_services_api import ProjectExternalServicesApi +from testit_api_client.api.project_failure_categories_api import ProjectFailureCategoriesApi from testit_api_client.api.project_sections_api import ProjectSectionsApi from testit_api_client.api.project_settings_api import ProjectSettingsApi from testit_api_client.api.project_test_plan_attributes_api import ProjectTestPlanAttributesApi @@ -34,6 +39,7 @@ from testit_api_client.api.project_test_plans_api import ProjectTestPlansApi from testit_api_client.api.project_work_items_api import ProjectWorkItemsApi from testit_api_client.api.projects_api import ProjectsApi +from testit_api_client.api.roles_api import RolesApi from testit_api_client.api.sections_api import SectionsApi from testit_api_client.api.tags_api import TagsApi from testit_api_client.api.test_plans_api import TestPlansApi @@ -42,6 +48,8 @@ from testit_api_client.api.test_runs_api import TestRunsApi from testit_api_client.api.test_statuses_api import TestStatusesApi from testit_api_client.api.test_suites_api import TestSuitesApi +from testit_api_client.api.user_role_assignments_api import UserRoleAssignmentsApi +from testit_api_client.api.user_storages_api import UserStoragesApi from testit_api_client.api.users_api import UsersApi from testit_api_client.api.webhooks_api import WebhooksApi from testit_api_client.api.webhooks_logs_api import WebhooksLogsApi diff --git a/src/testit_api_client/configuration.py b/src/testit_api_client/configuration.py index bf3f86bd..639b4137 100644 --- a/src/testit_api_client/configuration.py +++ b/src/testit_api_client/configuration.py @@ -402,13 +402,13 @@ def auth_settings(self): 'PrivateToken', ), } - if 'Identity.Application' in self.api_key: - auth['Identity.Application'] = { + if 'Cookies' in self.api_key: + auth['Cookies'] = { 'type': 'api_key', 'in': 'cookie', - 'key': 'backoffice', + 'key': 'session', 'value': self.get_api_key_with_prefix( - 'Identity.Application', + 'Cookies', ), } return auth @@ -422,7 +422,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v2.0\n"\ - "SDK Package Version: 7.5.11".\ + "SDK Package Version: 7.6.0.post580".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/src/testit_api_client/model/api_v2_autotests_result_reasons_grouping_search_post_request.py b/src/testit_api_client/model/api_v2_autotests_result_reasons_grouping_search_post_request.py new file mode 100644 index 00000000..44deb7f9 --- /dev/null +++ b/src/testit_api_client/model/api_v2_autotests_result_reasons_grouping_search_post_request.py @@ -0,0 +1,327 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.failure_category_group_search_api_model import FailureCategoryGroupSearchApiModel + from testit_api_client.model.failure_category_group_search_api_model_group import FailureCategoryGroupSearchApiModelGroup + from testit_api_client.model.failure_category_group_search_api_model_inquiry import FailureCategoryGroupSearchApiModelInquiry + globals()['FailureCategoryGroupSearchApiModel'] = FailureCategoryGroupSearchApiModel + globals()['FailureCategoryGroupSearchApiModelGroup'] = FailureCategoryGroupSearchApiModelGroup + globals()['FailureCategoryGroupSearchApiModelInquiry'] = FailureCategoryGroupSearchApiModelInquiry + + +class ApiV2AutotestsResultReasonsGroupingSearchPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'inquiry': (FailureCategoryGroupSearchApiModelInquiry,), # noqa: E501 + 'group': (FailureCategoryGroupSearchApiModelGroup,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'inquiry': 'inquiry', # noqa: E501 + 'group': 'group', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsGroupingSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + inquiry (FailureCategoryGroupSearchApiModelInquiry): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group (FailureCategoryGroupSearchApiModelGroup): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsGroupingSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + inquiry (FailureCategoryGroupSearchApiModelInquiry): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group (FailureCategoryGroupSearchApiModelGroup): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + FailureCategoryGroupSearchApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_autotests_result_reasons_post_request.py b/src/testit_api_client/model/api_v2_autotests_result_reasons_post_request.py new file mode 100644 index 00000000..1e969eb3 --- /dev/null +++ b/src/testit_api_client/model/api_v2_autotests_result_reasons_post_request.py @@ -0,0 +1,338 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.create_failure_category_api_model import CreateFailureCategoryApiModel + from testit_api_client.model.create_failure_class_regex_api_model import CreateFailureClassRegexApiModel + from testit_api_client.model.failure_category import FailureCategory + globals()['CreateFailureCategoryApiModel'] = CreateFailureCategoryApiModel + globals()['CreateFailureClassRegexApiModel'] = CreateFailureClassRegexApiModel + globals()['FailureCategory'] = FailureCategory + + +class ApiV2AutotestsResultReasonsPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'failure_category': (FailureCategory,), # noqa: E501 + 'failure_class_regexes': ([CreateFailureClassRegexApiModel], none_type,), # noqa: E501 + 'project_ids': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'failure_category': 'failureCategory', # noqa: E501 + 'failure_class_regexes': 'failureClassRegexes', # noqa: E501 + 'project_ids': 'projectIds', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsPostRequest - a model defined in OpenAPI + + Keyword Args: + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([CreateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + project_ids ([str], none_type): Projects identifiers. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsPostRequest - a model defined in OpenAPI + + Keyword Args: + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([CreateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + project_ids ([str], none_type): Projects identifiers. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + CreateFailureCategoryApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_autotests_result_reasons_put_request.py b/src/testit_api_client/model/api_v2_autotests_result_reasons_put_request.py new file mode 100644 index 00000000..0f823077 --- /dev/null +++ b/src/testit_api_client/model/api_v2_autotests_result_reasons_put_request.py @@ -0,0 +1,342 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.failure_category import FailureCategory + from testit_api_client.model.update_failure_category_api_model import UpdateFailureCategoryApiModel + from testit_api_client.model.update_failure_class_regex_api_model import UpdateFailureClassRegexApiModel + globals()['FailureCategory'] = FailureCategory + globals()['UpdateFailureCategoryApiModel'] = UpdateFailureCategoryApiModel + globals()['UpdateFailureClassRegexApiModel'] = UpdateFailureClassRegexApiModel + + +class ApiV2AutotestsResultReasonsPutRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'failure_category': (FailureCategory,), # noqa: E501 + 'failure_class_regexes': ([UpdateFailureClassRegexApiModel], none_type,), # noqa: E501 + 'project_ids': ([str], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'failure_category': 'failureCategory', # noqa: E501 + 'failure_class_regexes': 'failureClassRegexes', # noqa: E501 + 'project_ids': 'projectIds', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsPutRequest - a model defined in OpenAPI + + Keyword Args: + id (str): Failure category identifier + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([UpdateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + project_ids ([str], none_type): Projects identifiers. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsPutRequest - a model defined in OpenAPI + + Keyword Args: + id (str): Failure category identifier + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([UpdateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + project_ids ([str], none_type): Projects identifiers. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + UpdateFailureCategoryApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_autotests_result_reasons_search_post_request.py b/src/testit_api_client/model/api_v2_autotests_result_reasons_search_post_request.py new file mode 100644 index 00000000..d3c54057 --- /dev/null +++ b/src/testit_api_client/model/api_v2_autotests_result_reasons_search_post_request.py @@ -0,0 +1,341 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.autotest_result_reason_filter_model import AutotestResultReasonFilterModel + from testit_api_client.model.available_failure_category import AvailableFailureCategory + from testit_api_client.model.int32_range_selector_model import Int32RangeSelectorModel + globals()['AutotestResultReasonFilterModel'] = AutotestResultReasonFilterModel + globals()['AvailableFailureCategory'] = AvailableFailureCategory + globals()['Int32RangeSelectorModel'] = Int32RangeSelectorModel + + +class ApiV2AutotestsResultReasonsSearchPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('failure_categories',): { + }, + ('name',): { + 'max_length': 255, + 'min_length': 0, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'failure_categories': ([AvailableFailureCategory], none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'regex_count': (Int32RangeSelectorModel,), # noqa: E501 + 'is_deleted': (bool, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'failure_categories': 'failureCategories', # noqa: E501 + 'name': 'name', # noqa: E501 + 'regex_count': 'regexCount', # noqa: E501 + 'is_deleted': 'isDeleted', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_categories ([AvailableFailureCategory], none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + regex_count (Int32RangeSelectorModel): [optional] # noqa: E501 + is_deleted (bool, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2AutotestsResultReasonsSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_categories ([AvailableFailureCategory], none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + regex_count (Int32RangeSelectorModel): [optional] # noqa: E501 + is_deleted (bool, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AutotestResultReasonFilterModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_custom_attributes_global_id_put_request.py b/src/testit_api_client/model/api_v2_custom_attributes_global_id_put_request.py index 8b6c230c..fca30f73 100644 --- a/src/testit_api_client/model/api_v2_custom_attributes_global_id_put_request.py +++ b/src/testit_api_client/model/api_v2_custom_attributes_global_id_put_request.py @@ -151,7 +151,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 """ @@ -258,7 +258,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/api_v2_custom_attributes_global_post_request.py b/src/testit_api_client/model/api_v2_custom_attributes_global_post_request.py index 16b3fad1..a63cb8f1 100644 --- a/src/testit_api_client/model/api_v2_custom_attributes_global_post_request.py +++ b/src/testit_api_client/model/api_v2_custom_attributes_global_post_request.py @@ -158,7 +158,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -266,7 +266,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/api_v2_external_services_id_ai_models_post_request.py b/src/testit_api_client/model/api_v2_external_services_id_ai_models_post_request.py new file mode 100644 index 00000000..0ae4b1ae --- /dev/null +++ b/src/testit_api_client/model/api_v2_external_services_id_ai_models_post_request.py @@ -0,0 +1,321 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.get_ai_service_models_api_model import GetAIServiceModelsApiModel + from testit_api_client.model.inquiry import Inquiry + globals()['GetAIServiceModelsApiModel'] = GetAIServiceModelsApiModel + globals()['Inquiry'] = Inquiry + + +class ApiV2ExternalServicesIdAiModelsPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'inquiry': (Inquiry,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'inquiry': 'inquiry', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ExternalServicesIdAiModelsPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + inquiry (Inquiry): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ExternalServicesIdAiModelsPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + inquiry (Inquiry): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + GetAIServiceModelsApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_patch_request.py b/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_patch_request.py new file mode 100644 index 00000000..bf4d706f --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_patch_request.py @@ -0,0 +1,323 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.replace_project_external_service_api_model import ReplaceProjectExternalServiceApiModel + globals()['ReplaceProjectExternalServiceApiModel'] = ReplaceProjectExternalServiceApiModel + + +class ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'new_external_service_id': (str,), # noqa: E501 + 'settings': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'new_external_service_id': 'newExternalServiceId', # noqa: E501 + 'settings': 'settings', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest - a model defined in OpenAPI + + Keyword Args: + new_external_service_id (str): The unique ID of the new external service that will replace the current one + settings (bool, date, datetime, dict, float, int, list, str, none_type): External service settings + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest - a model defined in OpenAPI + + Keyword Args: + new_external_service_id (str): The unique ID of the new external service that will replace the current one + settings (bool, date, datetime, dict, float, int, list, str, none_type): External service settings + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ReplaceProjectExternalServiceApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_put_request.py b/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_put_request.py new file mode 100644 index 00000000..eae92a2e --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_id_external_services_external_service_id_put_request.py @@ -0,0 +1,319 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.enable_project_external_service_api_model import EnableProjectExternalServiceApiModel + globals()['EnableProjectExternalServiceApiModel'] = EnableProjectExternalServiceApiModel + + +class ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'settings': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'settings': 'settings', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest - a model defined in OpenAPI + + Keyword Args: + settings (bool, date, datetime, dict, float, int, list, str, none_type): External service settings + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest - a model defined in OpenAPI + + Keyword Args: + settings (bool, date, datetime, dict, float, int, list, str, none_type): External service settings + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + EnableProjectExternalServiceApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_id_external_services_issues_search_post_request.py b/src/testit_api_client/model/api_v2_projects_id_external_services_issues_search_post_request.py new file mode 100644 index 00000000..1b708886 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_id_external_services_issues_search_post_request.py @@ -0,0 +1,322 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.search_external_issues_api_model import SearchExternalIssuesApiModel + globals()['SearchExternalIssuesApiModel'] = SearchExternalIssuesApiModel + + +class ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('url',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + url (str): Url of external issue + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + url (str): Url of external issue + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + SearchExternalIssuesApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_post_request.py new file mode 100644 index 00000000..baa80064 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_post_request.py @@ -0,0 +1,334 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.create_failure_class_regex_api_model import CreateFailureClassRegexApiModel + from testit_api_client.model.create_project_failure_category_api_model import CreateProjectFailureCategoryApiModel + from testit_api_client.model.failure_category import FailureCategory + globals()['CreateFailureClassRegexApiModel'] = CreateFailureClassRegexApiModel + globals()['CreateProjectFailureCategoryApiModel'] = CreateProjectFailureCategoryApiModel + globals()['FailureCategory'] = FailureCategory + + +class ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'failure_category': (FailureCategory,), # noqa: E501 + 'failure_class_regexes': ([CreateFailureClassRegexApiModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'failure_category': 'failureCategory', # noqa: E501 + 'failure_class_regexes': 'failureClassRegexes', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest - a model defined in OpenAPI + + Keyword Args: + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([CreateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest - a model defined in OpenAPI + + Keyword Args: + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([CreateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + CreateProjectFailureCategoryApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_put_request.py b/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_put_request.py new file mode 100644 index 00000000..587a2362 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_autotests_failure_categories_put_request.py @@ -0,0 +1,338 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.failure_category import FailureCategory + from testit_api_client.model.update_failure_category_project_api_model import UpdateFailureCategoryProjectApiModel + from testit_api_client.model.update_failure_class_regex_api_model import UpdateFailureClassRegexApiModel + globals()['FailureCategory'] = FailureCategory + globals()['UpdateFailureCategoryProjectApiModel'] = UpdateFailureCategoryProjectApiModel + globals()['UpdateFailureClassRegexApiModel'] = UpdateFailureClassRegexApiModel + + +class ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'failure_category': (FailureCategory,), # noqa: E501 + 'failure_class_regexes': ([UpdateFailureClassRegexApiModel], none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'failure_category': 'failureCategory', # noqa: E501 + 'failure_class_regexes': 'failureClassRegexes', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest - a model defined in OpenAPI + + Keyword Args: + id (str): Failure category identifier + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([UpdateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest - a model defined in OpenAPI + + Keyword Args: + id (str): Failure category identifier + name (str): Failure category name + failure_category (FailureCategory): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + failure_class_regexes ([UpdateFailureClassRegexApiModel], none_type): Failure category regexes. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + UpdateFailureCategoryProjectApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_settings_autotests_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_settings_autotests_post_request.py index e1debe9d..469d9cc6 100644 --- a/src/testit_api_client/model/api_v2_projects_project_id_settings_autotests_post_request.py +++ b/src/testit_api_client/model/api_v2_projects_project_id_settings_autotests_post_request.py @@ -189,8 +189,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 flaky_stability_percentage (int): Stability percentage for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 flaky_test_run_count (int): Last test run count for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 work_item_updating_enabled (bool): Autotest to work item updating enabled. [optional] if omitted the server will use the default value of False # noqa: E501 - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -303,8 +303,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 flaky_stability_percentage (int): Stability percentage for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 flaky_test_run_count (int): Last test run count for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 work_item_updating_enabled (bool): Autotest to work item updating enabled. [optional] if omitted the server will use the default value of False # noqa: E501 - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request.py new file mode 100644 index 00000000..10b41def --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request.py @@ -0,0 +1,327 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.test_plan_test_points_analytics_api_model import TestPlanTestPointsAnalyticsApiModel + from testit_api_client.model.test_plan_test_points_extraction_api_model import TestPlanTestPointsExtractionApiModel + from testit_api_client.model.test_plan_test_points_search_api_model import TestPlanTestPointsSearchApiModel + globals()['TestPlanTestPointsAnalyticsApiModel'] = TestPlanTestPointsAnalyticsApiModel + globals()['TestPlanTestPointsExtractionApiModel'] = TestPlanTestPointsExtractionApiModel + globals()['TestPlanTestPointsSearchApiModel'] = TestPlanTestPointsSearchApiModel + + +class ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'filter': (TestPlanTestPointsSearchApiModel,), # noqa: E501 + 'extraction_model': (TestPlanTestPointsExtractionApiModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filter': 'filter', # noqa: E501 + 'extraction_model': 'extractionModel', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + extraction_model (TestPlanTestPointsExtractionApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + extraction_model (TestPlanTestPointsExtractionApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + TestPlanTestPointsAnalyticsApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request.py new file mode 100644 index 00000000..6ed206f6 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request.py @@ -0,0 +1,333 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.test_plan_test_points_api_model import TestPlanTestPointsApiModel + from testit_api_client.model.test_plan_test_points_group_api_model import TestPlanTestPointsGroupApiModel + from testit_api_client.model.test_plan_test_points_inquiry_api_model import TestPlanTestPointsInquiryApiModel + from testit_api_client.model.test_plan_test_points_search_api_model import TestPlanTestPointsSearchApiModel + globals()['TestPlanTestPointsApiModel'] = TestPlanTestPointsApiModel + globals()['TestPlanTestPointsGroupApiModel'] = TestPlanTestPointsGroupApiModel + globals()['TestPlanTestPointsInquiryApiModel'] = TestPlanTestPointsInquiryApiModel + globals()['TestPlanTestPointsSearchApiModel'] = TestPlanTestPointsSearchApiModel + + +class ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'filter': (TestPlanTestPointsSearchApiModel,), # noqa: E501 + 'group': (TestPlanTestPointsGroupApiModel,), # noqa: E501 + 'inquiry': (TestPlanTestPointsInquiryApiModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filter': 'filter', # noqa: E501 + 'group': 'group', # noqa: E501 + 'inquiry': 'inquiry', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + group (TestPlanTestPointsGroupApiModel): [optional] # noqa: E501 + inquiry (TestPlanTestPointsInquiryApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + group (TestPlanTestPointsGroupApiModel): [optional] # noqa: E501 + inquiry (TestPlanTestPointsInquiryApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + TestPlanTestPointsApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request.py new file mode 100644 index 00000000..12338ca7 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request.py @@ -0,0 +1,334 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.test_plan_test_points_extraction_api_model import TestPlanTestPointsExtractionApiModel + from testit_api_client.model.test_plan_test_points_search_api_model import TestPlanTestPointsSearchApiModel + from testit_api_client.model.test_plan_test_points_set_testers_api_model import TestPlanTestPointsSetTestersApiModel + globals()['TestPlanTestPointsExtractionApiModel'] = TestPlanTestPointsExtractionApiModel + globals()['TestPlanTestPointsSearchApiModel'] = TestPlanTestPointsSearchApiModel + globals()['TestPlanTestPointsSetTestersApiModel'] = TestPlanTestPointsSetTestersApiModel + + +class ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('tester_ids',): { + 'min_items': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'tester_ids': ([str],), # noqa: E501 + 'filter': (TestPlanTestPointsSearchApiModel,), # noqa: E501 + 'extraction_model': (TestPlanTestPointsExtractionApiModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'tester_ids': 'testerIds', # noqa: E501 + 'filter': 'filter', # noqa: E501 + 'extraction_model': 'extractionModel', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest - a model defined in OpenAPI + + Keyword Args: + tester_ids ([str]): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + extraction_model (TestPlanTestPointsExtractionApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest - a model defined in OpenAPI + + Keyword Args: + tester_ids ([str]): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + filter (TestPlanTestPointsSearchApiModel): [optional] # noqa: E501 + extraction_model (TestPlanTestPointsExtractionApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + TestPlanTestPointsSetTestersApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_bulk_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_bulk_post_request.py new file mode 100644 index 00000000..475acb37 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_bulk_post_request.py @@ -0,0 +1,335 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.create_work_item_previews_api_model import CreateWorkItemPreviewsApiModel + from testit_api_client.model.previews_issue_link_api_model import PreviewsIssueLinkApiModel + from testit_api_client.model.work_item_preview_api_model import WorkItemPreviewApiModel + globals()['CreateWorkItemPreviewsApiModel'] = CreateWorkItemPreviewsApiModel + globals()['PreviewsIssueLinkApiModel'] = PreviewsIssueLinkApiModel + globals()['WorkItemPreviewApiModel'] = WorkItemPreviewApiModel + + +class ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'section_id': (str,), # noqa: E501 + 'previews': ([WorkItemPreviewApiModel],), # noqa: E501 + 'attributes': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'link': (PreviewsIssueLinkApiModel,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'section_id': 'sectionId', # noqa: E501 + 'previews': 'previews', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + 'link': 'link', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest - a model defined in OpenAPI + + Keyword Args: + section_id (str): + previews ([WorkItemPreviewApiModel]): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): [optional] # noqa: E501 + link (PreviewsIssueLinkApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest - a model defined in OpenAPI + + Keyword Args: + section_id (str): + previews ([WorkItemPreviewApiModel]): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): [optional] # noqa: E501 + link (PreviewsIssueLinkApiModel): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + CreateWorkItemPreviewsApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_post_request.py b/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_post_request.py new file mode 100644 index 00000000..8bc5df63 --- /dev/null +++ b/src/testit_api_client/model/api_v2_projects_project_id_work_items_previews_post_request.py @@ -0,0 +1,351 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.generate_work_item_previews_api_model import GenerateWorkItemPreviewsApiModel + globals()['GenerateWorkItemPreviewsApiModel'] = GenerateWorkItemPreviewsApiModel + + +class ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('temperature',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('preview_limit',): { + 'inclusive_maximum': 30, + 'inclusive_minimum': 1, + }, + ('issue_key',): { + 'max_length': 255, + 'min_length': 0, + }, + ('user_context',): { + 'max_length': 30000, + 'min_length': 0, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'external_service_id': (str,), # noqa: E501 + 'temperature': (float,), # noqa: E501 + 'preview_limit': (int,), # noqa: E501 + 'issue_key': (str, none_type,), # noqa: E501 + 'user_context': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'external_service_id': 'externalServiceId', # noqa: E501 + 'temperature': 'temperature', # noqa: E501 + 'preview_limit': 'previewLimit', # noqa: E501 + 'issue_key': 'issueKey', # noqa: E501 + 'user_context': 'userContext', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest - a model defined in OpenAPI + + Keyword Args: + external_service_id (str): The ID of the external AI service to be used for generation. + temperature (float): Controls randomness of the AI model output. + preview_limit (int): Number of work item previews to generate. + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + issue_key (str, none_type): The key of the issue in an issue tracker (e.g., JIRA-123).. [optional] # noqa: E501 + user_context (str, none_type): Additional user context or description of the issue if no issue key is provided.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest - a model defined in OpenAPI + + Keyword Args: + external_service_id (str): The ID of the external AI service to be used for generation. + temperature (float): Controls randomness of the AI model output. + preview_limit (int): Number of work item previews to generate. + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + issue_key (str, none_type): The key of the issue in an issue tracker (e.g., JIRA-123).. [optional] # noqa: E501 + user_context (str, none_type): Additional user context or description of the issue if no issue key is provided.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + GenerateWorkItemPreviewsApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_users_post_request.py b/src/testit_api_client/model/api_v2_users_post_request.py new file mode 100644 index 00000000..f2953482 --- /dev/null +++ b/src/testit_api_client/model/api_v2_users_post_request.py @@ -0,0 +1,350 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.create_user_api_model import CreateUserApiModel + globals()['CreateUserApiModel'] = CreateUserApiModel + + +class ApiV2UsersPostRequest(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('user_name',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'user_name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'password': (str, none_type,), # noqa: E501 + 'provider_id': (str, none_type,), # noqa: E501 + 'external_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'user_name': 'userName', # noqa: E501 + 'first_name': 'firstName', # noqa: E501 + 'last_name': 'lastName', # noqa: E501 + 'display_name': 'displayName', # noqa: E501 + 'email': 'email', # noqa: E501 + 'password': 'password', # noqa: E501 + 'provider_id': 'providerId', # noqa: E501 + 'external_id': 'externalId', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiV2UsersPostRequest - a model defined in OpenAPI + + Keyword Args: + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str, none_type): [optional] # noqa: E501 + provider_id (str, none_type): [optional] # noqa: E501 + external_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiV2UsersPostRequest - a model defined in OpenAPI + + Keyword Args: + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str, none_type): [optional] # noqa: E501 + provider_id (str, none_type): [optional] # noqa: E501 + external_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + CreateUserApiModel, + ], + 'oneOf': [ + ], + } diff --git a/src/testit_api_client/model/api_v2_work_items_shared_step_id_references_work_items_post_request.py b/src/testit_api_client/model/api_v2_work_items_shared_step_id_references_work_items_post_request.py index e62e69c0..047bd4ac 100644 --- a/src/testit_api_client/model/api_v2_work_items_shared_step_id_references_work_items_post_request.py +++ b/src/testit_api_client/model/api_v2_work_items_shared_step_id_references_work_items_post_request.py @@ -193,7 +193,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 modified_by_ids ([str], none_type): Collection of identifiers of users who applied last modification to work item. [optional] # noqa: E501 states ([WorkItemStates], none_type): Collection of states of work item. [optional] # noqa: E501 priorities ([WorkItemPriorityModel], none_type): Collection of priorities of work item. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 created_date (SharedStepReferenceSectionsQueryFilterModelCreatedDate): [optional] # noqa: E501 modified_date (SharedStepReferenceSectionsQueryFilterModelModifiedDate): [optional] # noqa: E501 is_automated (bool, none_type): Is result must consist of only manual/automated work items. [optional] # noqa: E501 @@ -308,7 +308,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 modified_by_ids ([str], none_type): Collection of identifiers of users who applied last modification to work item. [optional] # noqa: E501 states ([WorkItemStates], none_type): Collection of states of work item. [optional] # noqa: E501 priorities ([WorkItemPriorityModel], none_type): Collection of priorities of work item. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 created_date (SharedStepReferenceSectionsQueryFilterModelCreatedDate): [optional] # noqa: E501 modified_date (SharedStepReferenceSectionsQueryFilterModelModifiedDate): [optional] # noqa: E501 is_automated (bool, none_type): Is result must consist of only manual/automated work items. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/attachment_put_model_auto_test_step_results_model.py b/src/testit_api_client/model/attachment_put_model_auto_test_step_results_model.py index 29b03596..1a917c8d 100644 --- a/src/testit_api_client/model/attachment_put_model_auto_test_step_results_model.py +++ b/src/testit_api_client/model/attachment_put_model_auto_test_step_results_model.py @@ -165,7 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AttachmentPutModelAutoTestStepResultsModel], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentPutModel], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentPutModel], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ @@ -260,7 +260,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AttachmentPutModelAutoTestStepResultsModel], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentPutModel], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentPutModel], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/auto_test_project_settings_api_model.py b/src/testit_api_client/model/auto_test_project_settings_api_model.py index 0f3db42f..2098a1d5 100644 --- a/src/testit_api_client/model/auto_test_project_settings_api_model.py +++ b/src/testit_api_client/model/auto_test_project_settings_api_model.py @@ -184,8 +184,8 @@ def _from_openapi_data(cls, rerun_enabled, rerun_attempts_count, work_item_updat flaky_stability_percentage (int): Stability percentage for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 flaky_test_run_count (int): Last test run count for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 work_item_updating_enabled (bool): Autotest to work item updating enabled. [optional] if omitted the server will use the default value of False # noqa: E501 - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -287,8 +287,8 @@ def __init__(self, rerun_enabled, rerun_attempts_count, work_item_updating_field flaky_stability_percentage (int): Stability percentage for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 flaky_test_run_count (int): Last test run count for autotest flaky computing. [optional] if omitted the server will use the default value of 100 # noqa: E501 work_item_updating_enabled (bool): Autotest to work item updating enabled. [optional] if omitted the server will use the default value of False # noqa: E501 - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings. [optional] if omitted the server will use the default value of 180 # noqa: E501 + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived. [optional] if omitted the server will use the default value of 500 # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/auto_test_project_settings_api_result.py b/src/testit_api_client/model/auto_test_project_settings_api_result.py index e2be535c..9ce0bf81 100644 --- a/src/testit_api_client/model/auto_test_project_settings_api_result.py +++ b/src/testit_api_client/model/auto_test_project_settings_api_result.py @@ -135,8 +135,8 @@ def _from_openapi_data(cls, project_id, is_flaky_auto, flaky_stability_percentag work_item_updating_fields (AutoTestProjectSettingsApiResultWorkItemUpdatingFields): archive_outdated_test_runs_enabled (bool): Indicates whether archiving of outdated test runs is enabled for the project. test_runs_archive_limit_enabled (bool): Indicates whether a limit is enforced on the number of archived test runs. - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -246,8 +246,8 @@ def __init__(self, project_id, is_flaky_auto, flaky_stability_percentage, flaky_ work_item_updating_fields (AutoTestProjectSettingsApiResultWorkItemUpdatingFields): archive_outdated_test_runs_enabled (bool): Indicates whether archiving of outdated test runs is enabled for the project. test_runs_archive_limit_enabled (bool): Indicates whether a limit is enforced on the number of archived test runs. - test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings - max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived + test_runs_retention_period_days (int): The retention period in days for test runs. After this period, outdated test runs may be archived based on project settings + max_active_test_runs_count (int): Maximum number of active test runs to keep. When this limit is exceeded, older test runs are automatically archived Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/src/testit_api_client/model/auto_test_step_result.py b/src/testit_api_client/model/auto_test_step_result.py index ade4f285..8fe63a12 100644 --- a/src/testit_api_client/model/auto_test_step_result.py +++ b/src/testit_api_client/model/auto_test_step_result.py @@ -165,7 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AutoTestStepResult], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentApiResult], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentApiResult], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ @@ -260,7 +260,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AutoTestStepResult], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentApiResult], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentApiResult], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/auto_test_step_result_update_request.py b/src/testit_api_client/model/auto_test_step_result_update_request.py index 8baa4abf..99732457 100644 --- a/src/testit_api_client/model/auto_test_step_result_update_request.py +++ b/src/testit_api_client/model/auto_test_step_result_update_request.py @@ -165,7 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AutoTestStepResultUpdateRequest], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentUpdateRequest], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentUpdateRequest], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ @@ -260,7 +260,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 duration (int, none_type): Expected or actual duration of the test run execution in milliseconds.. [optional] # noqa: E501 outcome (AvailableTestResultOutcome): [optional] # noqa: E501 step_results ([AutoTestStepResultUpdateRequest], none_type): Nested step results. The maximum nesting level is 15.. [optional] # noqa: E501 - attachments ([AttachmentUpdateRequest], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 + attachments ([AttachmentUpdateRequest], none_type): /// Specifies an attachment GUID. Multiple values can be sent. . [optional] # noqa: E501 parameters ({str: (str,)}, none_type): \"parameter\": \"value\" pair with arbitrary custom parameters. Multiple parameters can be sent.. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/create_empty_request.py b/src/testit_api_client/model/create_empty_request.py index 8dde2ec8..ba7121c9 100644 --- a/src/testit_api_client/model/create_empty_request.py +++ b/src/testit_api_client/model/create_empty_request.py @@ -124,7 +124,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """CreateEmptyRequest - a model defined in OpenAPI Keyword Args: - project_id (str): Project unique identifier This property is to link test run with a project + project_id (str): Project unique identifier This property is to link test run with a project _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -234,7 +234,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 """CreateEmptyRequest - a model defined in OpenAPI Keyword Args: - project_id (str): Project unique identifier This property is to link test run with a project + project_id (str): Project unique identifier This property is to link test run with a project _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/src/testit_api_client/model/create_empty_test_run_api_model.py b/src/testit_api_client/model/create_empty_test_run_api_model.py index cb6137f7..938a75ca 100644 --- a/src/testit_api_client/model/create_empty_test_run_api_model.py +++ b/src/testit_api_client/model/create_empty_test_run_api_model.py @@ -117,7 +117,7 @@ def _from_openapi_data(cls, project_id, *args, **kwargs): # noqa: E501 """CreateEmptyTestRunApiModel - a model defined in OpenAPI Args: - project_id (str): Project unique identifier This property is to link test run with a project + project_id (str): Project unique identifier This property is to link test run with a project Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -212,7 +212,7 @@ def __init__(self, project_id, *args, **kwargs): # noqa: E501 """CreateEmptyTestRunApiModel - a model defined in OpenAPI Args: - project_id (str): Project unique identifier This property is to link test run with a project + project_id (str): Project unique identifier This property is to link test run with a project Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/src/testit_api_client/model/create_projects_attribute_request.py b/src/testit_api_client/model/create_projects_attribute_request.py index 6b050f8d..f73e8fdb 100644 --- a/src/testit_api_client/model/create_projects_attribute_request.py +++ b/src/testit_api_client/model/create_projects_attribute_request.py @@ -161,7 +161,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -270,7 +270,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/create_user_api_model.py b/src/testit_api_client/model/create_user_api_model.py new file mode 100644 index 00000000..c62a8629 --- /dev/null +++ b/src/testit_api_client/model/create_user_api_model.py @@ -0,0 +1,302 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + + +class CreateUserApiModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('user_name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'user_name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'password': (str, none_type,), # noqa: E501 + 'provider_id': (str, none_type,), # noqa: E501 + 'external_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'user_name': 'userName', # noqa: E501 + 'first_name': 'firstName', # noqa: E501 + 'last_name': 'lastName', # noqa: E501 + 'display_name': 'displayName', # noqa: E501 + 'email': 'email', # noqa: E501 + 'password': 'password', # noqa: E501 + 'provider_id': 'providerId', # noqa: E501 + 'external_id': 'externalId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, user_name, first_name, last_name, display_name, email, *args, **kwargs): # noqa: E501 + """CreateUserApiModel - a model defined in OpenAPI + + Args: + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str, none_type): [optional] # noqa: E501 + provider_id (str, none_type): [optional] # noqa: E501 + external_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.user_name = user_name + self.first_name = first_name + self.last_name = last_name + self.display_name = display_name + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, user_name, first_name, last_name, display_name, email, *args, **kwargs): # noqa: E501 + """CreateUserApiModel - a model defined in OpenAPI + + Args: + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + password (str, none_type): [optional] # noqa: E501 + provider_id (str, none_type): [optional] # noqa: E501 + external_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.user_name = user_name + self.first_name = first_name + self.last_name = last_name + self.display_name = display_name + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/testit_api_client/model/custom_attribute_api_result.py b/src/testit_api_client/model/custom_attribute_api_result.py index d5f7f275..77b208aa 100644 --- a/src/testit_api_client/model/custom_attribute_api_result.py +++ b/src/testit_api_client/model/custom_attribute_api_result.py @@ -124,7 +124,7 @@ def _from_openapi_data(cls, id, options, type, is_deleted, name, is_enabled, is_ Args: id (str): Unique ID of the attribute - options ([CustomAttributeOptionApiResult]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + options ([CustomAttributeOptionApiResult]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeType): is_deleted (bool): Indicates if the attribute is deleted name (str): Name of the attribute @@ -132,7 +132,7 @@ def _from_openapi_data(cls, id, options, type, is_deleted, name, is_enabled, is_ is_required (bool): Indicates if the attribute value is mandatory to specify is_global (bool): Indicates if the attribute is available across all projects is_system (bool): Indicates if the attribute is system - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -231,7 +231,7 @@ def __init__(self, id, options, type, is_deleted, name, is_enabled, is_required, Args: id (str): Unique ID of the attribute - options ([CustomAttributeOptionApiResult]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + options ([CustomAttributeOptionApiResult]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeType): is_deleted (bool): Indicates if the attribute is deleted name (str): Name of the attribute @@ -239,7 +239,7 @@ def __init__(self, id, options, type, is_deleted, name, is_enabled, is_required, is_required (bool): Indicates if the attribute value is mandatory to specify is_global (bool): Indicates if the attribute is available across all projects is_system (bool): Indicates if the attribute is system - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/src/testit_api_client/model/custom_attribute_model.py b/src/testit_api_client/model/custom_attribute_model.py index 9452d6e2..9c598f33 100644 --- a/src/testit_api_client/model/custom_attribute_model.py +++ b/src/testit_api_client/model/custom_attribute_model.py @@ -128,8 +128,8 @@ def _from_openapi_data(cls, id, targets, options, type, is_deleted, is_system, n Args: id (str): Unique ID of the attribute - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) - options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeTypesEnum): is_deleted (bool): Indicates if the attribute is deleted is_system (bool): Indicates if the attribute is system @@ -235,8 +235,8 @@ def __init__(self, id, targets, options, type, is_deleted, is_system, name, is_e Args: id (str): Unique ID of the attribute - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) - options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeTypesEnum): is_deleted (bool): Indicates if the attribute is deleted is_system (bool): Indicates if the attribute is system diff --git a/src/testit_api_client/model/custom_attribute_post_model.py b/src/testit_api_client/model/custom_attribute_post_model.py index 7edaad89..aea62eef 100644 --- a/src/testit_api_client/model/custom_attribute_post_model.py +++ b/src/testit_api_client/model/custom_attribute_post_model.py @@ -156,7 +156,7 @@ def _from_openapi_data(cls, type, name, is_enabled, is_required, is_global, *arg Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -254,7 +254,7 @@ def __init__(self, type, name, is_enabled, is_required, is_global, *args, **kwar Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/custom_attribute_put_model.py b/src/testit_api_client/model/custom_attribute_put_model.py index f1859302..79720868 100644 --- a/src/testit_api_client/model/custom_attribute_put_model.py +++ b/src/testit_api_client/model/custom_attribute_put_model.py @@ -162,7 +162,7 @@ def _from_openapi_data(cls, id, type, is_deleted, name, is_enabled, is_required, Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -264,7 +264,7 @@ def __init__(self, id, type, is_deleted, name, is_enabled, is_required, is_globa Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/custom_attribute_search_response_model.py b/src/testit_api_client/model/custom_attribute_search_response_model.py index 9d46da32..12b0b1e1 100644 --- a/src/testit_api_client/model/custom_attribute_search_response_model.py +++ b/src/testit_api_client/model/custom_attribute_search_response_model.py @@ -136,8 +136,8 @@ def _from_openapi_data(cls, work_item_usage, test_plan_usage, id, targets, optio work_item_usage ([ProjectShortestModel]): test_plan_usage ([ProjectShortestModel]): id (str): Unique ID of the attribute - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) - options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeTypesEnum): is_deleted (bool): Indicates if the attribute is deleted is_system (bool): Indicates if the attribute is system @@ -247,8 +247,8 @@ def __init__(self, work_item_usage, test_plan_usage, id, targets, options, type, work_item_usage ([ProjectShortestModel]): test_plan_usage ([ProjectShortestModel]): id (str): Unique ID of the attribute - targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) - options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only + targets ([str]): Collection of the attribute targets Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans) + options ([CustomAttributeOptionModel]): Collection of the attribute options Available for attributes of type `options` and `multiple options` only type (CustomAttributeTypesEnum): is_deleted (bool): Indicates if the attribute is deleted is_system (bool): Indicates if the attribute is system diff --git a/src/testit_api_client/model/global_custom_attribute_post_model.py b/src/testit_api_client/model/global_custom_attribute_post_model.py index a7440e2a..5b00bb12 100644 --- a/src/testit_api_client/model/global_custom_attribute_post_model.py +++ b/src/testit_api_client/model/global_custom_attribute_post_model.py @@ -153,7 +153,7 @@ def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,7 +247,7 @@ def __init__(self, name, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 - options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionPostModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/global_custom_attribute_update_model.py b/src/testit_api_client/model/global_custom_attribute_update_model.py index 2fc810f8..4635f877 100644 --- a/src/testit_api_client/model/global_custom_attribute_update_model.py +++ b/src/testit_api_client/model/global_custom_attribute_update_model.py @@ -146,7 +146,7 @@ def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 """ @@ -238,7 +238,7 @@ def __init__(self, name, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 is_enabled (bool, none_type): Indicates whether the attribute is available. [optional] # noqa: E501 is_required (bool, none_type): Indicates whether the attribute value is mandatory to specify. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/demo_project_api_result.py b/src/testit_api_client/model/role_api_model.py similarity index 92% rename from src/testit_api_client/model/demo_project_api_result.py rename to src/testit_api_client/model/role_api_model.py index 04ec7af3..5b9d5e8d 100644 --- a/src/testit_api_client/model/demo_project_api_result.py +++ b/src/testit_api_client/model/role_api_model.py @@ -30,7 +30,7 @@ -class DemoProjectApiResult(ModelNormal): +class RoleApiModel(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -75,7 +75,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'job_id': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'is_system': (bool,), # noqa: E501 } @cached_property @@ -84,7 +86,9 @@ def discriminator(): attribute_map = { - 'job_id': 'jobId', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'is_system': 'isSystem', # noqa: E501 } read_only_vars = { @@ -94,11 +98,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, job_id, *args, **kwargs): # noqa: E501 - """DemoProjectApiResult - a model defined in OpenAPI + def _from_openapi_data(cls, id, name, is_system, *args, **kwargs): # noqa: E501 + """RoleApiModel - a model defined in OpenAPI Args: - job_id (str): Job ID + id (str): + name (str): + is_system (bool): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -162,7 +168,9 @@ def _from_openapi_data(cls, job_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.job_id = job_id + self.id = id + self.name = name + self.is_system = is_system for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -183,11 +191,13 @@ def _from_openapi_data(cls, job_id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, job_id, *args, **kwargs): # noqa: E501 - """DemoProjectApiResult - a model defined in OpenAPI + def __init__(self, id, name, is_system, *args, **kwargs): # noqa: E501 + """RoleApiModel - a model defined in OpenAPI Args: - job_id (str): Job ID + id (str): + name (str): + is_system (bool): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -249,7 +259,9 @@ def __init__(self, job_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.job_id = job_id + self.id = id + self.name = name + self.is_system = is_system for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/src/testit_api_client/model/role_api_model_api_collection.py b/src/testit_api_client/model/role_api_model_api_collection.py new file mode 100644 index 00000000..3c6a069f --- /dev/null +++ b/src/testit_api_client/model/role_api_model_api_collection.py @@ -0,0 +1,274 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from testit_api_client.model.role_api_model import RoleApiModel + globals()['RoleApiModel'] = RoleApiModel + + +class RoleApiModelApiCollection(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([RoleApiModel],), # noqa: E501 + 'total_count': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'total_count': 'totalCount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, total_count, *args, **kwargs): # noqa: E501 + """RoleApiModelApiCollection - a model defined in OpenAPI + + Args: + data ([RoleApiModel]): Items + total_count (int): Total count + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + self.total_count = total_count + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, total_count, *args, **kwargs): # noqa: E501 + """RoleApiModelApiCollection - a model defined in OpenAPI + + Args: + data ([RoleApiModel]): Items + total_count (int): Total count + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + self.total_count = total_count + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/testit_api_client/model/search_work_items_request.py b/src/testit_api_client/model/search_work_items_request.py index 3cdb1206..41a45140 100644 --- a/src/testit_api_client/model/search_work_items_request.py +++ b/src/testit_api_client/model/search_work_items_request.py @@ -253,7 +253,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) tag_names ([str], none_type): Collection of tags. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 name_or_id (str, none_type): Name or identifier (UUID) of work item. [optional] # noqa: E501 include_ids ([str], none_type): Collection of identifiers of work items which need to be included in result regardless of filtering. [optional] # noqa: E501 exclude_ids ([str], none_type): Collection of identifiers of work items which need to be excluded from result regardless of filtering. [optional] # noqa: E501 @@ -385,7 +385,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) tag_names ([str], none_type): Collection of tags. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 name_or_id (str, none_type): Name or identifier (UUID) of work item. [optional] # noqa: E501 include_ids ([str], none_type): Collection of identifiers of work items which need to be included in result regardless of filtering. [optional] # noqa: E501 exclude_ids ([str], none_type): Collection of identifiers of work items which need to be excluded from result regardless of filtering. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/shared_step_references_query_filter_model.py b/src/testit_api_client/model/shared_step_references_query_filter_model.py index bcaa4985..c735f5b8 100644 --- a/src/testit_api_client/model/shared_step_references_query_filter_model.py +++ b/src/testit_api_client/model/shared_step_references_query_filter_model.py @@ -186,7 +186,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 modified_by_ids ([str], none_type): Collection of identifiers of users who applied last modification to work item. [optional] # noqa: E501 states ([WorkItemStates], none_type): Collection of states of work item. [optional] # noqa: E501 priorities ([WorkItemPriorityModel], none_type): Collection of priorities of work item. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 created_date (SharedStepReferenceSectionsQueryFilterModelCreatedDate): [optional] # noqa: E501 modified_date (SharedStepReferenceSectionsQueryFilterModelModifiedDate): [optional] # noqa: E501 is_automated (bool, none_type): Is result must consist of only manual/automated work items. [optional] # noqa: E501 @@ -283,7 +283,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 modified_by_ids ([str], none_type): Collection of identifiers of users who applied last modification to work item. [optional] # noqa: E501 states ([WorkItemStates], none_type): Collection of states of work item. [optional] # noqa: E501 priorities ([WorkItemPriorityModel], none_type): Collection of priorities of work item. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 created_date (SharedStepReferenceSectionsQueryFilterModelCreatedDate): [optional] # noqa: E501 modified_date (SharedStepReferenceSectionsQueryFilterModelModifiedDate): [optional] # noqa: E501 is_automated (bool, none_type): Is result must consist of only manual/automated work items. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/test_point_by_test_suite_model.py b/src/testit_api_client/model/test_point_by_test_suite_model.py index aabdfdb0..3cf67c5b 100644 --- a/src/testit_api_client/model/test_point_by_test_suite_model.py +++ b/src/testit_api_client/model/test_point_by_test_suite_model.py @@ -149,7 +149,7 @@ def _from_openapi_data(cls, id, iteration_id, *args, **kwargs): # noqa: E501 tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ @@ -246,7 +246,7 @@ def __init__(self, id, iteration_id, *args, **kwargs): # noqa: E501 tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/test_point_related_to_test_result.py b/src/testit_api_client/model/test_point_related_to_test_result.py index e6c71429..f02b8c75 100644 --- a/src/testit_api_client/model/test_point_related_to_test_result.py +++ b/src/testit_api_client/model/test_point_related_to_test_result.py @@ -160,7 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ @@ -272,7 +272,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/test_point_short_api_result.py b/src/testit_api_client/model/test_point_short_api_result.py index 74317d13..7b249f81 100644 --- a/src/testit_api_client/model/test_point_short_api_result.py +++ b/src/testit_api_client/model/test_point_short_api_result.py @@ -163,7 +163,7 @@ def _from_openapi_data(cls, id, is_deleted, status_model, iteration_id, test_sui tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ @@ -266,7 +266,7 @@ def __init__(self, id, is_deleted, status_model, iteration_id, test_suite_id, *a tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/test_point_short_model.py b/src/testit_api_client/model/test_point_short_model.py index 231e6b84..c4a64b0f 100644 --- a/src/testit_api_client/model/test_point_short_model.py +++ b/src/testit_api_client/model/test_point_short_model.py @@ -152,7 +152,7 @@ def _from_openapi_data(cls, test_suite_id, id, iteration_id, *args, **kwargs): tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ @@ -251,7 +251,7 @@ def __init__(self, test_suite_id, id, iteration_id, *args, **kwargs): # noqa: E tester_id (str, none_type): Tester who is responded for the test unique internal identifier. [optional] # noqa: E501 work_item_id (str, none_type): Workitem to which test point relates unique identifier. [optional] # noqa: E501 configuration_id (str, none_type): Configuration to which test point relates unique identifier. [optional] # noqa: E501 - status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 + status (str, none_type): Test point status Applies one of these values: Blocked, NoResults, Failed, Passed. [optional] # noqa: E501 last_test_result_id (str, none_type): Last test result unique identifier. [optional] # noqa: E501 work_item_median_duration (int, none_type): Median duration of work item the test point represents. [optional] # noqa: E501 """ diff --git a/src/testit_api_client/model/test_result_history_report_api_result.py b/src/testit_api_client/model/test_result_history_report_api_result.py index b754b5b2..d1b20bf4 100644 --- a/src/testit_api_client/model/test_result_history_report_api_result.py +++ b/src/testit_api_client/model/test_result_history_report_api_result.py @@ -161,7 +161,7 @@ def _from_openapi_data(cls, id, created_date, user_id, is_automated, status, cre Args: id (str): Internal test result identifier created_date (datetime): Test result creation date - user_id (str): Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result + user_id (str): Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result is_automated (bool): Boolean flag defines if test point related to the test result is automated or not status (TestResultHistoryReportApiResultStatus): created_by_id (str): Unique identifier of user who created first test result in the test run @@ -205,15 +205,15 @@ def _from_openapi_data(cls, id, created_date, user_id, is_automated, status, cre test_plan_id (str, none_type): Internal identifier of test plan related to the test result's test run. [optional] # noqa: E501 test_plan_global_id (int, none_type): Global identifier of test plan related to the test result's test run. [optional] # noqa: E501 test_plan_name (str, none_type): Name of test plan related to the test result's test run. [optional] # noqa: E501 - configuration_name (str, none_type): Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name. [optional] # noqa: E501 - outcome (str, none_type): Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run.. [optional] # noqa: E501 - comment (str, none_type): Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run. [optional] # noqa: E501 - links ([LinkApiResult], none_type): Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run.. [optional] # noqa: E501 + configuration_name (str, none_type): Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name. [optional] # noqa: E501 + outcome (str, none_type): Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run.. [optional] # noqa: E501 + comment (str, none_type): Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run. [optional] # noqa: E501 + links ([LinkApiResult], none_type): Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run.. [optional] # noqa: E501 started_on (datetime, none_type): Start date time from test result or from test run (if test run new state is Running or Completed state). [optional] # noqa: E501 completed_on (datetime, none_type): End date time from test result or from test run (if test run new state is In progress, Stopped or Completed). [optional] # noqa: E501 duration (int, none_type): Duration of first created test result in the test run. [optional] # noqa: E501 modified_by_id (str, none_type): Unique identifier of user who applied last modification of first test result in the test run. [optional] # noqa: E501 - attachments ([AttachmentApiResult], none_type): Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run.. [optional] # noqa: E501 + attachments ([AttachmentApiResult], none_type): Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run.. [optional] # noqa: E501 work_item_version_id (str, none_type): Unique identifier of workitem version related to the first test result in the test run. [optional] # noqa: E501 work_item_version_number (int, none_type): Number of workitem version related to the first test result in the test run. [optional] # noqa: E501 launch_source (str, none_type): [optional] # noqa: E501 @@ -282,7 +282,7 @@ def __init__(self, id, created_date, user_id, is_automated, status, created_by_i Args: id (str): Internal test result identifier created_date (datetime): Test result creation date - user_id (str): Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result + user_id (str): Internal identifier of user who stopped test run related to the test result or user who created the test result If test run was stopped, this property equals identifier of user who stopped it. Otherwise, the property equals identifier of user who created the test result is_automated (bool): Boolean flag defines if test point related to the test result is automated or not status (TestResultHistoryReportApiResultStatus): created_by_id (str): Unique identifier of user who created first test result in the test run @@ -326,15 +326,15 @@ def __init__(self, id, created_date, user_id, is_automated, status, created_by_i test_plan_id (str, none_type): Internal identifier of test plan related to the test result's test run. [optional] # noqa: E501 test_plan_global_id (int, none_type): Global identifier of test plan related to the test result's test run. [optional] # noqa: E501 test_plan_name (str, none_type): Name of test plan related to the test result's test run. [optional] # noqa: E501 - configuration_name (str, none_type): Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name. [optional] # noqa: E501 - outcome (str, none_type): Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run.. [optional] # noqa: E501 - comment (str, none_type): Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run. [optional] # noqa: E501 - links ([LinkApiResult], none_type): Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run.. [optional] # noqa: E501 + configuration_name (str, none_type): Configuration name of test point related to the test result or from test result itself If test point related to the test result has configuration, this property will be equal to the test point configuration name. Otherwise, this property will be equal to the test result configuration name. [optional] # noqa: E501 + outcome (str, none_type): Outcome from test result with max modified date or from first created test result Property can contain one of these values: Passed, Failed, InProgress, Blocked, Skipped. If any test result related to the test run is linked with autotest and the run has an outcome, the outcome value equals to the worst outcome of the last modified test result. Otherwise, the outcome equals to the outcome of first created test result in the test run.. [optional] # noqa: E501 + comment (str, none_type): Test result comment If any test result related to the test run is linked with autotest, comment will have default value. Otherwise, the comment equals to the comment of first created test result in the test run. [optional] # noqa: E501 + links ([LinkApiResult], none_type): Test result links If any test result related to the test run is linked with autotest, link will be equal to the links of last modified test result. Otherwise, the links equals to the links of first created test result in the test run.. [optional] # noqa: E501 started_on (datetime, none_type): Start date time from test result or from test run (if test run new state is Running or Completed state). [optional] # noqa: E501 completed_on (datetime, none_type): End date time from test result or from test run (if test run new state is In progress, Stopped or Completed). [optional] # noqa: E501 duration (int, none_type): Duration of first created test result in the test run. [optional] # noqa: E501 modified_by_id (str, none_type): Unique identifier of user who applied last modification of first test result in the test run. [optional] # noqa: E501 - attachments ([AttachmentApiResult], none_type): Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run.. [optional] # noqa: E501 + attachments ([AttachmentApiResult], none_type): Attachments related to the test result If any test result related to the test run is linked with autotest, attachments will be equal to the attachments of last modified test result. Otherwise, the attachments equals to the attachments of first created test result in the test run.. [optional] # noqa: E501 work_item_version_id (str, none_type): Unique identifier of workitem version related to the first test result in the test run. [optional] # noqa: E501 work_item_version_number (int, none_type): Number of workitem version related to the first test result in the test run. [optional] # noqa: E501 launch_source (str, none_type): [optional] # noqa: E501 diff --git a/src/testit_api_client/model/test_run_v2_api_result.py b/src/testit_api_client/model/test_run_v2_api_result.py index ab779f43..ddd2d62f 100644 --- a/src/testit_api_client/model/test_run_v2_api_result.py +++ b/src/testit_api_client/model/test_run_v2_api_result.py @@ -159,7 +159,7 @@ def _from_openapi_data(cls, id, name, state_name, status, project_id, created_da name (str): Test run name state_name (TestRunState): status (TestRunByAutoTestApiResultStatus): - project_id (str): Project unique identifier This property is used to link test run with project. + project_id (str): Project unique identifier This property is used to link test run with project. created_date (datetime): Date and time of test run creation created_by_id (str): Unique identifier of user who created test run attachments ([AttachmentApiResult]): Collection of attachments related to the test run @@ -200,10 +200,10 @@ def _from_openapi_data(cls, id, name, state_name, status, project_id, created_da through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated.. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated.. [optional] # noqa: E501 started_on (datetime, none_type): Date and time of test run start. [optional] # noqa: E501 completed_on (datetime, none_type): Date and time of test run end. [optional] # noqa: E501 - test_plan_id (str, none_type): Test plan unique identifier This property is used to link test run with test plan.. [optional] # noqa: E501 + test_plan_id (str, none_type): Test plan unique identifier This property is used to link test run with test plan.. [optional] # noqa: E501 test_results ([TestResultV2GetModel], none_type): Enumeration of test results related to test run. [optional] # noqa: E501 modified_date (datetime, none_type): Date and time of last test run modification. [optional] # noqa: E501 modified_by_id (str, none_type): Unique identifier of user who applied last test run modification. [optional] # noqa: E501 @@ -280,7 +280,7 @@ def __init__(self, id, name, state_name, status, project_id, created_date, creat name (str): Test run name state_name (TestRunState): status (TestRunByAutoTestApiResultStatus): - project_id (str): Project unique identifier This property is used to link test run with project. + project_id (str): Project unique identifier This property is used to link test run with project. created_date (datetime): Date and time of test run creation created_by_id (str): Unique identifier of user who created test run attachments ([AttachmentApiResult]): Collection of attachments related to the test run @@ -321,10 +321,10 @@ def __init__(self, id, name, state_name, status, project_id, created_date, creat through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated.. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated.. [optional] # noqa: E501 started_on (datetime, none_type): Date and time of test run start. [optional] # noqa: E501 completed_on (datetime, none_type): Date and time of test run end. [optional] # noqa: E501 - test_plan_id (str, none_type): Test plan unique identifier This property is used to link test run with test plan.. [optional] # noqa: E501 + test_plan_id (str, none_type): Test plan unique identifier This property is used to link test run with test plan.. [optional] # noqa: E501 test_results ([TestResultV2GetModel], none_type): Enumeration of test results related to test run. [optional] # noqa: E501 modified_date (datetime, none_type): Date and time of last test run modification. [optional] # noqa: E501 modified_by_id (str, none_type): Unique identifier of user who applied last test run modification. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/test_suite_work_items_search_model.py b/src/testit_api_client/model/test_suite_work_items_search_model.py index e71a4ab3..c0c1f7db 100644 --- a/src/testit_api_client/model/test_suite_work_items_search_model.py +++ b/src/testit_api_client/model/test_suite_work_items_search_model.py @@ -246,7 +246,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) tag_names ([str], none_type): Collection of tags. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 name_or_id (str, none_type): Name or identifier (UUID) of work item. [optional] # noqa: E501 include_ids ([str], none_type): Collection of identifiers of work items which need to be included in result regardless of filtering. [optional] # noqa: E501 exclude_ids ([str], none_type): Collection of identifiers of work items which need to be excluded from result regardless of filtering. [optional] # noqa: E501 @@ -360,7 +360,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) tag_names ([str], none_type): Collection of tags. [optional] # noqa: E501 - entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 + entity_types ([WorkItemTypeModel], none_type): Collection of types of work item Allowed values: `TestCases`, `CheckLists`, `SharedSteps`. [optional] # noqa: E501 name_or_id (str, none_type): Name or identifier (UUID) of work item. [optional] # noqa: E501 include_ids ([str], none_type): Collection of identifiers of work items which need to be included in result regardless of filtering. [optional] # noqa: E501 exclude_ids ([str], none_type): Collection of identifiers of work items which need to be excluded from result regardless of filtering. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/update_empty_request.py b/src/testit_api_client/model/update_empty_request.py index 3f5f95a5..f1570197 100644 --- a/src/testit_api_client/model/update_empty_request.py +++ b/src/testit_api_client/model/update_empty_request.py @@ -160,7 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 attachments ([AssignAttachmentApiModel], none_type): Collection of attachments related to the test run. [optional] # noqa: E501 links ([UpdateLinkApiModel], none_type): Collection of links related to the test run. [optional] # noqa: E501 tags ([str], none_type): Collection of tags to assign to the test run. [optional] # noqa: E501 @@ -270,7 +270,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 attachments ([AssignAttachmentApiModel], none_type): Collection of attachments related to the test run. [optional] # noqa: E501 links ([UpdateLinkApiModel], none_type): Collection of links related to the test run. [optional] # noqa: E501 tags ([str], none_type): Collection of tags to assign to the test run. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/update_empty_test_run_api_model.py b/src/testit_api_client/model/update_empty_test_run_api_model.py index 6ee6472a..1df8b43d 100644 --- a/src/testit_api_client/model/update_empty_test_run_api_model.py +++ b/src/testit_api_client/model/update_empty_test_run_api_model.py @@ -155,7 +155,7 @@ def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 attachments ([AssignAttachmentApiModel], none_type): Collection of attachments related to the test run. [optional] # noqa: E501 links ([UpdateLinkApiModel], none_type): Collection of links related to the test run. [optional] # noqa: E501 tags ([str], none_type): Collection of tags to assign to the test run. [optional] # noqa: E501 @@ -251,7 +251,7 @@ def __init__(self, id, name, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) description (str, none_type): Test run description. [optional] # noqa: E501 - launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 + launch_source (str, none_type): Test run launch source Once launch source is specified it cannot be updated. [optional] # noqa: E501 attachments ([AssignAttachmentApiModel], none_type): Collection of attachments related to the test run. [optional] # noqa: E501 links ([UpdateLinkApiModel], none_type): Collection of links related to the test run. [optional] # noqa: E501 tags ([str], none_type): Collection of tags to assign to the test run. [optional] # noqa: E501 diff --git a/src/testit_api_client/model/update_projects_attribute_request.py b/src/testit_api_client/model/update_projects_attribute_request.py index fa178323..4491c05c 100644 --- a/src/testit_api_client/model/update_projects_attribute_request.py +++ b/src/testit_api_client/model/update_projects_attribute_request.py @@ -167,7 +167,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -278,7 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 + options ([CustomAttributeOptionModel], none_type): Collection of the attribute options Available for attributes of type `options` and `multiple options` only. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/src/testit_api_client/model/user_api_model.py b/src/testit_api_client/model/user_api_model.py new file mode 100644 index 00000000..6f6162df --- /dev/null +++ b/src/testit_api_client/model/user_api_model.py @@ -0,0 +1,300 @@ +""" + API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v2.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from testit_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from testit_api_client.exceptions import ApiAttributeError + + + +class UserApiModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('user_name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'user_name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'provider_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'user_name': 'userName', # noqa: E501 + 'first_name': 'firstName', # noqa: E501 + 'last_name': 'lastName', # noqa: E501 + 'display_name': 'displayName', # noqa: E501 + 'email': 'email', # noqa: E501 + 'provider_id': 'providerId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, user_name, first_name, last_name, display_name, email, *args, **kwargs): # noqa: E501 + """UserApiModel - a model defined in OpenAPI + + Args: + id (str): + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + provider_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.user_name = user_name + self.first_name = first_name + self.last_name = last_name + self.display_name = display_name + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, user_name, first_name, last_name, display_name, email, *args, **kwargs): # noqa: E501 + """UserApiModel - a model defined in OpenAPI + + Args: + id (str): + user_name (str): + first_name (str): + last_name (str): + display_name (str): + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + provider_id (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.user_name = user_name + self.first_name = first_name + self.last_name = last_name + self.display_name = display_name + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/testit_api_client/models/__init__.py b/src/testit_api_client/models/__init__.py index c58d2c07..70052cc9 100644 --- a/src/testit_api_client/models/__init__.py +++ b/src/testit_api_client/models/__init__.py @@ -21,6 +21,10 @@ from testit_api_client.model.api_v2_auto_tests_flaky_bulk_post_request import ApiV2AutoTestsFlakyBulkPostRequest from testit_api_client.model.api_v2_auto_tests_id_test_results_search_post_request import ApiV2AutoTestsIdTestResultsSearchPostRequest from testit_api_client.model.api_v2_auto_tests_search_post_request import ApiV2AutoTestsSearchPostRequest +from testit_api_client.model.api_v2_autotests_result_reasons_grouping_search_post_request import ApiV2AutotestsResultReasonsGroupingSearchPostRequest +from testit_api_client.model.api_v2_autotests_result_reasons_post_request import ApiV2AutotestsResultReasonsPostRequest +from testit_api_client.model.api_v2_autotests_result_reasons_put_request import ApiV2AutotestsResultReasonsPutRequest +from testit_api_client.model.api_v2_autotests_result_reasons_search_post_request import ApiV2AutotestsResultReasonsSearchPostRequest from testit_api_client.model.api_v2_background_jobs_search_post_request import ApiV2BackgroundJobsSearchPostRequest from testit_api_client.model.api_v2_configurations_create_by_parameters_post_request import ApiV2ConfigurationsCreateByParametersPostRequest from testit_api_client.model.api_v2_configurations_delete_bulk_post_request import ApiV2ConfigurationsDeleteBulkPostRequest @@ -34,15 +38,26 @@ from testit_api_client.model.api_v2_custom_attributes_templates_put_request import ApiV2CustomAttributesTemplatesPutRequest from testit_api_client.model.api_v2_custom_attributes_templates_search_post_request import ApiV2CustomAttributesTemplatesSearchPostRequest from testit_api_client.model.api_v2_external_issues_suggestions_post_request import ApiV2ExternalIssuesSuggestionsPostRequest +from testit_api_client.model.api_v2_external_services_id_ai_models_post_request import ApiV2ExternalServicesIdAiModelsPostRequest from testit_api_client.model.api_v2_notifications_search_post_request import ApiV2NotificationsSearchPostRequest from testit_api_client.model.api_v2_parameters_search_groups_post_request import ApiV2ParametersSearchGroupsPostRequest from testit_api_client.model.api_v2_parameters_search_post_request import ApiV2ParametersSearchPostRequest +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_patch_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPatchRequest +from testit_api_client.model.api_v2_projects_id_external_services_external_service_id_put_request import ApiV2ProjectsIdExternalServicesExternalServiceIdPutRequest +from testit_api_client.model.api_v2_projects_id_external_services_issues_search_post_request import ApiV2ProjectsIdExternalServicesIssuesSearchPostRequest from testit_api_client.model.api_v2_projects_project_id_attributes_templates_search_post_request import ApiV2ProjectsProjectIdAttributesTemplatesSearchPostRequest +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_post_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPostRequest +from testit_api_client.model.api_v2_projects_project_id_autotests_failure_categories_put_request import ApiV2ProjectsProjectIdAutotestsFailureCategoriesPutRequest from testit_api_client.model.api_v2_projects_project_id_settings_autotests_post_request import ApiV2ProjectsProjectIdSettingsAutotestsPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_delete_bulk_post_request import ApiV2ProjectsProjectIdTestPlansDeleteBulkPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_search_post_request import ApiV2ProjectsProjectIdTestPlansSearchPostRequest +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_analytics_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAnalyticsPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_rerun_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRerunPostRequest from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_autotests_run_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRunPostRequest +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_grouping_search_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsGroupingSearchPostRequest +from testit_api_client.model.api_v2_projects_project_id_test_plans_test_plan_id_test_points_testers_post_request import ApiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsTestersPostRequest +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_bulk_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsBulkPostRequest +from testit_api_client.model.api_v2_projects_project_id_work_items_previews_post_request import ApiV2ProjectsProjectIdWorkItemsPreviewsPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_grouped_post_request import ApiV2ProjectsProjectIdWorkItemsSearchGroupedPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_id_post_request import ApiV2ProjectsProjectIdWorkItemsSearchIdPostRequest from testit_api_client.model.api_v2_projects_project_id_work_items_search_post_request import ApiV2ProjectsProjectIdWorkItemsSearchPostRequest @@ -71,6 +86,7 @@ from testit_api_client.model.api_v2_test_statuses_search_post_request import ApiV2TestStatusesSearchPostRequest from testit_api_client.model.api_v2_test_suites_post_request import ApiV2TestSuitesPostRequest from testit_api_client.model.api_v2_test_suites_put_request import ApiV2TestSuitesPutRequest +from testit_api_client.model.api_v2_users_post_request import ApiV2UsersPostRequest from testit_api_client.model.api_v2_webhooks_delete_request import ApiV2WebhooksDeleteRequest from testit_api_client.model.api_v2_webhooks_post_request import ApiV2WebhooksPostRequest from testit_api_client.model.api_v2_webhooks_put_request import ApiV2WebhooksPutRequest @@ -220,6 +236,7 @@ from testit_api_client.model.create_test_run_and_fill_by_configurations_api_model import CreateTestRunAndFillByConfigurationsApiModel from testit_api_client.model.create_test_run_and_fill_by_work_items_api_model import CreateTestRunAndFillByWorkItemsApiModel from testit_api_client.model.create_test_status_api_model import CreateTestStatusApiModel +from testit_api_client.model.create_user_api_model import CreateUserApiModel from testit_api_client.model.create_work_item_api_model import CreateWorkItemApiModel from testit_api_client.model.create_work_item_comment_api_model import CreateWorkItemCommentApiModel from testit_api_client.model.create_work_item_previews_api_model import CreateWorkItemPreviewsApiModel @@ -247,7 +264,6 @@ from testit_api_client.model.date_time_range_selector_model import DateTimeRangeSelectorModel from testit_api_client.model.defect_api_model import DefectApiModel from testit_api_client.model.deletion_state import DeletionState -from testit_api_client.model.demo_project_api_result import DemoProjectApiResult from testit_api_client.model.detailed_project_api_result import DetailedProjectApiResult from testit_api_client.model.enable_project_external_service_api_model import EnableProjectExternalServiceApiModel from testit_api_client.model.external_form_allowed_value_model import ExternalFormAllowedValueModel @@ -403,6 +419,8 @@ from testit_api_client.model.rerun_test_result_api_result import RerunTestResultApiResult from testit_api_client.model.rerun_test_result_api_result_status import RerunTestResultApiResultStatus from testit_api_client.model.reruns_api_result import RerunsApiResult +from testit_api_client.model.role_api_model import RoleApiModel +from testit_api_client.model.role_api_model_api_collection import RoleApiModelApiCollection from testit_api_client.model.search_attributes_in_project_request import SearchAttributesInProjectRequest from testit_api_client.model.search_custom_attribute_template_get_model import SearchCustomAttributeTemplateGetModel from testit_api_client.model.search_external_issues_api_model import SearchExternalIssuesApiModel @@ -649,6 +667,7 @@ from testit_api_client.model.update_work_item_api_model import UpdateWorkItemApiModel from testit_api_client.model.update_work_item_comment_api_model import UpdateWorkItemCommentApiModel from testit_api_client.model.update_workflow_api_model import UpdateWorkflowApiModel +from testit_api_client.model.user_api_model import UserApiModel from testit_api_client.model.user_custom_name_validation_response import UserCustomNameValidationResponse from testit_api_client.model.user_name_api_result import UserNameApiResult from testit_api_client.model.validation_problem_details import ValidationProblemDetails