Skip to content
Closed
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
2,213 changes: 1,393 additions & 820 deletions .swagger/cloud-swagger.json → .swagger/5.7-swagger.json

Large diffs are not rendered by default.

14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
| 5.4.1 | 7.0.3.post541 |
| 5.5.0 | 7.2.0.post550 |
| 5.6.0 | 7.4.0.post560 |
| 5.7.0 | 7.5.5.post570 |
| Cloud | 7.5.5 + |

1. For current versions, see the releases tab.
Expand Down Expand Up @@ -195,7 +196,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
Expand All @@ -219,6 +219,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 |
*SearchApi* | [**api_v2_search_global_search_post**](docs/SearchApi.md#api_v2_search_global_search_post) | **POST** /api/v2/search/globalSearch |
*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
Expand Down Expand Up @@ -328,7 +329,12 @@ 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} |
*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
Expand Down Expand Up @@ -444,6 +450,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)
Expand Down Expand Up @@ -589,6 +596,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)
Expand Down Expand Up @@ -616,7 +624,6 @@ Class | Method | HTTP request | Description
- [DateTimeRangeSelectorModel](docs/DateTimeRangeSelectorModel.md)
- [DefectApiModel](docs/DefectApiModel.md)
- [DeletionState](docs/DeletionState.md)
- [DemoProjectApiResult](docs/DemoProjectApiResult.md)
- [EnableProjectExternalServiceApiModel](docs/EnableProjectExternalServiceApiModel.md)
- [ExternalFormAllowedValueModel](docs/ExternalFormAllowedValueModel.md)
- [ExternalFormCreateModel](docs/ExternalFormCreateModel.md)
Expand Down Expand Up @@ -768,6 +775,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)
Expand Down Expand Up @@ -1012,6 +1021,7 @@ Class | Method | HTTP request | Description
- [UpdateWorkItemCommentApiModel](docs/UpdateWorkItemCommentApiModel.md)
- [UpdateWorkItemRequest](docs/UpdateWorkItemRequest.md)
- [UpdateWorkflowApiModel](docs/UpdateWorkflowApiModel.md)
- [UserApiModel](docs/UserApiModel.md)
- [UserCustomNameValidationResponse](docs/UserCustomNameValidationResponse.md)
- [UserNameApiResult](docs/UserNameApiResult.md)
- [ValidationProblemDetails](docs/ValidationProblemDetails.md)
Expand Down
19 changes: 19 additions & 0 deletions docs/ApiV2UsersPostRequest.md
Original file line number Diff line number Diff line change
@@ -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)


2 changes: 1 addition & 1 deletion docs/AttachmentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ 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

Expand Down
18 changes: 18 additions & 0 deletions docs/CreateUserApiModel.md
Original file line number Diff line number Diff line change
@@ -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)


4 changes: 2 additions & 2 deletions docs/LinkShortApiResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**title** | **str** | |
**url** | **str** | |
**type** | **str** | |
**title** | **str, none_type** | | [optional]
**type** | **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)

Expand Down
2 changes: 1 addition & 1 deletion docs/LinkShortModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**title** | **str** | |
**url** | **str** | |
**title** | **str, none_type** | | [optional]
**type** | **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)
Expand Down
1 change: 1 addition & 0 deletions docs/ParameterIterationModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**shared_step_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)

Expand Down
1 change: 1 addition & 0 deletions docs/ParameterShortModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**value** | **str** | Value of the parameter |
**name** | **str** | Key of the parameter |
**project_ids** | **[str]** | |
**shared_step_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)

Expand Down
80 changes: 0 additions & 80 deletions docs/ProjectsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -127,85 +126,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 (Bearer or PrivateToken):

```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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = '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

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

### 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)

Expand Down
6 changes: 4 additions & 2 deletions docs/DemoProjectApiResult.md → docs/RoleApiModel.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
12 changes: 12 additions & 0 deletions docs/RoleApiModelApiCollection.md
Original file line number Diff line number Diff line change
@@ -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)


88 changes: 88 additions & 0 deletions docs/RolesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# 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 (Bearer or PrivateToken):

```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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = '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

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

### 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)

17 changes: 17 additions & 0 deletions docs/UserApiModel.md
Original file line number Diff line number Diff line change
@@ -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)


Loading
Loading