Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added release/4.1.0. #35

Merged
merged 2 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Api client for Test IT TMS
![Test IT](https://raw.githubusercontent.com/testit-tms/api-client-python/master/images/banner.png)

[![Release
Status](https://img.shields.io/pypi/v/testit-api-client?style=plastic)](https://pypi.python.org/pypi/testit-api-client)
[![Release Status](https://img.shields.io/pypi/v/testit-api-client?style=plastic)](https://pypi.python.org/pypi/testit-api-client)
[![Downloads](https://img.shields.io/pypi/dm/testit-api-client?style=plastic)](https://pypi.python.org/pypi/testit-api-client)
[![GitHub contributors](https://img.shields.io/github/contributors/testit-tms/api-client-python?style=plastic)](https://github.com/testit-tms/api-client-python)

Expand All @@ -20,6 +19,7 @@ Status](https://img.shields.io/pypi/v/testit-api-client?style=plastic)](https://
| 4.5 | 3.4.0 |
| 4.6 | 3.5.0 |
| 5.0 | 4.0.0 |
| 5.1 | 4.1.0 |

## Installation & Usage
### pip install
Expand Down Expand Up @@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
*AutoTestsApi* | [**link_auto_test_to_work_item**](docs/AutoTestsApi.md#link_auto_test_to_work_item) | **POST** /api/v2/autoTests/{id}/workItems | Link autotest with work items
*AutoTestsApi* | [**update_auto_test**](docs/AutoTestsApi.md#update_auto_test) | **PUT** /api/v2/autoTests | Update autotest
*AutoTestsApi* | [**update_multiple**](docs/AutoTestsApi.md#update_multiple) | **PUT** /api/v2/autoTests/bulk | Update multiple autotests
*BackgroundJobsApi* | [**api_v2_background_jobs_completed_delete**](docs/BackgroundJobsApi.md#api_v2_background_jobs_completed_delete) | **DELETE** /api/v2/backgroundJobs/completed | Delete all completed background jobs
*BackgroundJobsApi* | [**api_v2_background_jobs_get**](docs/BackgroundJobsApi.md#api_v2_background_jobs_get) | **GET** /api/v2/backgroundJobs |
*BackgroundJobsApi* | [**api_v2_background_jobs_id_cancel_post**](docs/BackgroundJobsApi.md#api_v2_background_jobs_id_cancel_post) | **POST** /api/v2/backgroundJobs/{id}/cancel | Cancel current user background job
*BackgroundJobsApi* | [**api_v2_background_jobs_id_get**](docs/BackgroundJobsApi.md#api_v2_background_jobs_id_get) | **GET** /api/v2/backgroundJobs/{id} | Get background job by ID
Expand Down Expand Up @@ -154,11 +155,6 @@ 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
*ProjectExportApi* | [**export**](docs/ProjectExportApi.md#export) | **POST** /api/v2/projects/{projectId}/export | Export project as JSON file
*ProjectExportApi* | [**export_project_json**](docs/ProjectExportApi.md#export_project_json) | **POST** /api/v2/projects/{projectId}/export/json | Export project as JSON file in background job
*ProjectExportApi* | [**export_project_with_test_plans_json**](docs/ProjectExportApi.md#export_project_with_test_plans_json) | **POST** /api/v2/projects/{projectId}/export/testPlans/json | Export project as JSON file with test plans in background job
*ProjectExportApi* | [**export_project_with_test_plans_zip**](docs/ProjectExportApi.md#export_project_with_test_plans_zip) | **POST** /api/v2/projects/{projectId}/export/testPlans/zip | Export project as Zip file with test plans in background job
*ProjectExportApi* | [**export_project_zip**](docs/ProjectExportApi.md#export_project_zip) | **POST** /api/v2/projects/{projectId}/export/zip | Export project as Zip file in background job
*ProjectImportApi* | [**background_import_to_existing_project**](docs/ProjectImportApi.md#background_import_to_existing_project) | **POST** /api/v2/projects/{projectId}/import/json | Import project from JSON file into existing project in background job
*ProjectImportApi* | [**background_import_zip_to_existing_project**](docs/ProjectImportApi.md#background_import_zip_to_existing_project) | **POST** /api/v2/projects/{projectId}/import/zip | Import project from Zip file into existing project in background job
*ProjectImportApi* | [**import_to_existing_project**](docs/ProjectImportApi.md#import_to_existing_project) | **POST** /api/v2/projects/{projectId}/import | Import project from JSON file into existing project
Expand Down Expand Up @@ -186,7 +182,7 @@ Class | Method | HTTP request | Description
*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
*ProjectsApi* | [**api_v2_projects_id_filters_get**](docs/ProjectsApi.md#api_v2_projects_id_filters_get) | **GET** /api/v2/projects/{id}/filters | Get Project filters
*ProjectsApi* | [**api_v2_projects_id_patch**](docs/ProjectsApi.md#api_v2_projects_id_patch) | **PATCH** /api/v2/projects/{id} | Patch project
*ProjectsApi* | [**api_v2_projects_id_purge_post**](docs/ProjectsApi.md#api_v2_projects_id_purge_post) | **POST** /api/v2/projects/{id}/purge | Purge archived project
*ProjectsApi* | [**api_v2_projects_id_purge_post**](docs/ProjectsApi.md#api_v2_projects_id_purge_post) | **POST** /api/v2/projects/{id}/purge | Purge the project
*ProjectsApi* | [**api_v2_projects_id_restore_post**](docs/ProjectsApi.md#api_v2_projects_id_restore_post) | **POST** /api/v2/projects/{id}/restore | Restore archived project
*ProjectsApi* | [**api_v2_projects_id_test_plans_attribute_attribute_id_delete**](docs/ProjectsApi.md#api_v2_projects_id_test_plans_attribute_attribute_id_delete) | **DELETE** /api/v2/projects/{id}/testPlans/attribute/{attributeId} | Delete attribute from project's test plans
*ProjectsApi* | [**api_v2_projects_id_test_plans_attribute_put**](docs/ProjectsApi.md#api_v2_projects_id_test_plans_attribute_put) | **PUT** /api/v2/projects/{id}/testPlans/attribute | Update attribute of project's test plans
Expand All @@ -201,7 +197,6 @@ Class | Method | HTTP request | Description
*ProjectsApi* | [**call_import**](docs/ProjectsApi.md#call_import) | **POST** /api/v2/projects/import | Import project from JSON file
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v2/projects | Create project
*ProjectsApi* | [**delete_project_auto_tests**](docs/ProjectsApi.md#delete_project_auto_tests) | **DELETE** /api/v2/projects/{id}/autoTests | Delete all autotests from project
*ProjectsApi* | [**export_with_test_plans_and_configurations**](docs/ProjectsApi.md#export_with_test_plans_and_configurations) | **POST** /api/v2/projects/{id}/export-by-testPlans | Export project with test plans, test suites and test points as JSON file
*ProjectsApi* | [**get_all_projects**](docs/ProjectsApi.md#get_all_projects) | **GET** /api/v2/projects | Get all projects
*ProjectsApi* | [**get_auto_tests_namespaces**](docs/ProjectsApi.md#get_auto_tests_namespaces) | **GET** /api/v2/projects/{id}/autoTestsNamespaces | Get namespaces of autotests in project
*ProjectsApi* | [**get_project_by_id**](docs/ProjectsApi.md#get_project_by_id) | **GET** /api/v2/projects/{id} | Get project by ID
Expand Down
2 changes: 1 addition & 1 deletion docs/ApiV2CustomAttributesGlobalIdPutRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of attribute |
**options** | [**[CustomAttributeOptionModel], none_type**](CustomAttributeOptionModel.md) | Collection of attribute options <br /> 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]
Expand Down
2 changes: 1 addition & 1 deletion docs/ApiV2CustomAttributesGlobalPostRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <br /> 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)
Expand Down
1 change: 1 addition & 0 deletions docs/ApiV2ProjectsSearchPostRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**global_ids** | **[int], none_type** | Specifies a project global IDs to search for | [optional]
**created_date** | [**ProjectsFilterModelCreatedDate**](ProjectsFilterModelCreatedDate.md) | | [optional]
**created_by_ids** | **[str], none_type** | Specifies an autotest creator IDs to search for | [optional]
**types** | [**[ProjectTypeModel], none_type**](ProjectTypeModel.md) | Collection of project types to search for | [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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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** | **[str], none_type** | Collection of types of work item <br>Allowed values: `TestCases`, `CheckLists`, `SharedSteps` | [optional]
**entity_types** | **[str], none_type** | 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]
Expand Down
45 changes: 34 additions & 11 deletions docs/AttachmentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import time
import testit_api_client
from testit_api_client.api import attachments_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.
Expand Down Expand Up @@ -74,20 +75,25 @@ void (empty response body)
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Attachment file was deleted successfully | - |
**400** | Bad Request | - |
**401** | Unauthorized | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**409** | Conflict | - |
**422** | Attachment file is already 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)

# **api_v2_attachments_id_get**
> file_type api_v2_attachments_id_get(id)
> api_v2_attachments_id_get(id)

Download attachment file

Expand All @@ -99,7 +105,9 @@ Download attachment file
import time
import testit_api_client
from testit_api_client.api import attachments_api
from testit_api_client.model.problem_details import ProblemDetails
from testit_api_client.model.image_resize_type import ImageResizeType
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.
Expand Down Expand Up @@ -132,17 +140,15 @@ with testit_api_client.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
try:
# Download attachment file
api_response = api_instance.api_v2_attachments_id_get(id)
pprint(api_response)
api_instance.api_v2_attachments_id_get(id)
except testit_api_client.ApiException as e:
print("Exception when calling AttachmentsApi->api_v2_attachments_id_get: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# Download attachment file
api_response = api_instance.api_v2_attachments_id_get(id, width=width, height=height, resize_type=resize_type, background_color=background_color, preview=preview)
pprint(api_response)
api_instance.api_v2_attachments_id_get(id, width=width, height=height, resize_type=resize_type, background_color=background_color, preview=preview)
except testit_api_client.ApiException as e:
print("Exception when calling AttachmentsApi->api_v2_attachments_id_get: %s\n" % e)
```
Expand All @@ -161,7 +167,7 @@ Name | Type | Description | Notes

### Return type

**file_type**
void (empty response body)

### Authorization

Expand All @@ -170,14 +176,20 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**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)

Expand All @@ -194,6 +206,8 @@ Get size of attachments storage in bytes
import time
import testit_api_client
from testit_api_client.api import attachments_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.
Expand Down Expand Up @@ -248,7 +262,13 @@ This endpoint does not need any parameter.

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**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)

Expand Down Expand Up @@ -330,9 +350,12 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Created | - |
**400** | <br>- Invalid file contents <br>- Invalid HTTP headers | - |
**400** | - Invalid file contents - Invalid HTTP headers | - |
**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)

Loading
Loading