Skip to content
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
3 changes: 1 addition & 2 deletions qase-api-client/docs/AttachmentListResponseAllOfResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ print(AttachmentListResponseAllOfResult.to_json())
# convert the object into a dict
attachment_list_response_all_of_result_dict = attachment_list_response_all_of_result_instance.to_dict()
# create an instance of AttachmentListResponseAllOfResult from a dict
attachment_list_response_all_of_result_form_dict = attachment_list_response_all_of_result.from_dict(
attachment_list_response_all_of_result_dict)
attachment_list_response_all_of_result_form_dict = attachment_list_response_all_of_result.from_dict(attachment_list_response_all_of_result_dict)
```
[[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: 2 additions & 0 deletions qase-api-client/docs/Run.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Name | Type | Description | Notes
**tags** | [**List[TagValue]**](TagValue.md) | | [optional]
**cases** | **List[int]** | | [optional]
**plan_id** | **int** | | [optional]
**configurations** | **List[int]** | | [optional]
**external_issue** | [**RunExternalIssue**](RunExternalIssue.md) | | [optional]

## Example

Expand Down
31 changes: 31 additions & 0 deletions qase-api-client/docs/RunExternalIssue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# RunExternalIssue


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**type** | **str** | | [optional]
**link** | **str** | | [optional]

## Example

```python
from qase.api_client_v1.models.run_external_issue import RunExternalIssue

# TODO update the JSON string below
json = "{}"
# create an instance of RunExternalIssue from a JSON string
run_external_issue_instance = RunExternalIssue.from_json(json)
# print the JSON string representation of the object
print(RunExternalIssue.to_json())

# convert the object into a dict
run_external_issue_dict = run_external_issue_instance.to_dict()
# create an instance of RunExternalIssue from a dict
run_external_issue_form_dict = run_external_issue.from_dict(run_external_issue_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions qase-api-client/docs/RunexternalIssues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# RunexternalIssues


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | |
**links** | [**List[RunexternalIssuesLinksInner]**](RunexternalIssuesLinksInner.md) | Array of external issue links. Each test run (run_id) can have only one external issue link. |

## Example

```python
from qase.api_client_v1.models.runexternal_issues import RunexternalIssues

# TODO update the JSON string below
json = "{}"
# create an instance of RunexternalIssues from a JSON string
runexternal_issues_instance = RunexternalIssues.from_json(json)
# print the JSON string representation of the object
print(RunexternalIssues.to_json())

# convert the object into a dict
runexternal_issues_dict = runexternal_issues_instance.to_dict()
# create an instance of RunexternalIssues from a dict
runexternal_issues_form_dict = runexternal_issues.from_dict(runexternal_issues_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions qase-api-client/docs/RunexternalIssuesLinksInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# RunexternalIssuesLinksInner


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**run_id** | **int** | |
**external_issue** | **str** | An external issue identifier, e.g. \"PROJ-1234\". Or null if you want to remove the link. | [optional]

## Example

```python
from qase.api_client_v1.models.runexternal_issues_links_inner import RunexternalIssuesLinksInner

# TODO update the JSON string below
json = "{}"
# create an instance of RunexternalIssuesLinksInner from a JSON string
runexternal_issues_links_inner_instance = RunexternalIssuesLinksInner.from_json(json)
# print the JSON string representation of the object
print(RunexternalIssuesLinksInner.to_json())

# convert the object into a dict
runexternal_issues_links_inner_dict = runexternal_issues_links_inner_instance.to_dict()
# create an instance of RunexternalIssuesLinksInner from a dict
runexternal_issues_links_inner_form_dict = runexternal_issues_links_inner.from_dict(runexternal_issues_links_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


183 changes: 179 additions & 4 deletions qase-api-client/docs/RunsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Method | HTTP request | Description
[**delete_run**](RunsApi.md#delete_run) | **DELETE** /run/{code}/{id} | Delete run
[**get_run**](RunsApi.md#get_run) | **GET** /run/{code}/{id} | Get a specific run
[**get_runs**](RunsApi.md#get_runs) | **GET** /run/{code} | Get all runs
[**run_update_external_issue**](RunsApi.md#run_update_external_issue) | **POST** /run/{code}/external-issue | Update external issues for runs
[**update_run**](RunsApi.md#update_run) | **PATCH** /run/{code}/{id} | Update a specific run
[**update_run_publicity**](RunsApi.md#update_run_publicity) | **PATCH** /run/{code}/{id}/public | Update publicity of a specific run


Expand Down Expand Up @@ -313,7 +315,7 @@ with qase.api_client_v1.ApiClient(configuration) as api_client:
api_instance = qase.api_client_v1.RunsApi(api_client)
code = 'code_example' # str | Code of project, where to search entities.
id = 56 # int | Identifier.
include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)
include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue (optional)

try:
# Get a specific run
Expand All @@ -333,7 +335,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**code** | **str**| Code of project, where to search entities. |
**id** | **int**| Identifier. |
**include** | **str**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects | [optional]
**include** | **str**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue | [optional]

### Return type

Expand Down Expand Up @@ -408,7 +410,7 @@ with qase.api_client_v1.ApiClient(configuration) as api_client:
to_start_time = 56 # int | (optional)
limit = 10 # int | A number of entities in result set. (optional) (default to 10)
offset = 0 # int | How many entities should be skipped. (optional) (default to 0)
include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)
include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue (optional)

try:
# Get all runs
Expand All @@ -435,7 +437,7 @@ Name | Type | Description | Notes
**to_start_time** | **int**| | [optional]
**limit** | **int**| A number of entities in result set. | [optional] [default to 10]
**offset** | **int**| How many entities should be skipped. | [optional] [default to 0]
**include** | **str**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects | [optional]
**include** | **str**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue | [optional]

### Return type

Expand Down Expand Up @@ -463,6 +465,179 @@ Name | Type | Description | Notes

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

# **run_update_external_issue**
> run_update_external_issue(code, runexternal_issues)

Update external issues for runs

This method allows you to update links between test runs and external issues (such as Jira tickets). You can use this endpoint to: - Link test runs to external issues by providing the external issue identifier (e.g., \"PROJ-1234\") - Update existing links by providing a new external issue identifier - Remove existing links by setting the external_issue field to null **Important**: Each test run can have only one link with an external issue. If a test run already has an external issue link, providing a new external_issue value will replace the existing link. The endpoint supports both Jira Cloud and Jira Server integrations. Each request can update multiple test run links in a single operation.

### Example

* Api Key Authentication (TokenAuth):

```python
import qase.api_client_v1
from qase.api_client_v1.models.runexternal_issues import RunexternalIssues
from qase.api_client_v1.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qase.api_client_v1.Configuration(
host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = qase.api_client_v1.RunsApi(api_client)
code = 'code_example' # str | Code of project, where to search entities.
runexternal_issues = qase.api_client_v1.RunexternalIssues() # RunexternalIssues |

try:
# Update external issues for runs
api_instance.run_update_external_issue(code, runexternal_issues)
except Exception as e:
print("Exception when calling RunsApi->run_update_external_issue: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**code** | **str**| Code of project, where to search entities. |
**runexternal_issues** | [**RunexternalIssues**](RunexternalIssues.md)| |

### Return type

void (empty response body)

### Authorization

[TokenAuth](../README.md#TokenAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK. | - |
**400** | Bad Request. | - |
**401** | Unauthorized. | - |
**403** | Forbidden. | - |
**404** | Not Found. | - |
**429** | Too Many Requests. | - |

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

# **update_run**
> BaseResponse update_run(code, id, runupdate)

Update a specific run

This method allows to update a specific run.

### Example

* Api Key Authentication (TokenAuth):

```python
import qase.api_client_v1
from qase.api_client_v1.models.base_response import BaseResponse
from qase.api_client_v1.models.runupdate import Runupdate
from qase.api_client_v1.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qase.api_client_v1.Configuration(
host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = qase.api_client_v1.RunsApi(api_client)
code = 'code_example' # str | Code of project, where to search entities.
id = 56 # int | Identifier.
runupdate = qase.api_client_v1.Runupdate() # Runupdate |

try:
# Update a specific run
api_response = api_instance.update_run(code, id, runupdate)
print("The response of RunsApi->update_run:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RunsApi->update_run: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**code** | **str**| Code of project, where to search entities. |
**id** | **int**| Identifier. |
**runupdate** | [**Runupdate**](Runupdate.md)| |

### Return type

[**BaseResponse**](BaseResponse.md)

### Authorization

[TokenAuth](../README.md#TokenAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A result. | - |
**400** | Bad Request. | - |
**401** | Unauthorized. | - |
**403** | Forbidden. | - |
**404** | Not Found. | - |
**429** | Too Many Requests. | - |

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

# **update_run_publicity**
> RunPublicResponse update_run_publicity(code, id, run_public)

Expand Down
36 changes: 36 additions & 0 deletions qase-api-client/docs/Runupdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Runupdate


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [optional]
**description** | **str** | | [optional]
**environment_id** | **int** | | [optional]
**environment_slug** | **str** | | [optional]
**milestone_id** | **int** | | [optional]
**tags** | **List[str]** | | [optional]
**configurations** | **List[int]** | | [optional]
**custom_field** | **Dict[str, str]** | A map of custom fields values (id => value) | [optional]

## Example

```python
from qase.api_client_v1.models.runupdate import Runupdate

# TODO update the JSON string below
json = "{}"
# create an instance of Runupdate from a JSON string
runupdate_instance = Runupdate.from_json(json)
# print the JSON string representation of the object
print(Runupdate.to_json())

# convert the object into a dict
runupdate_dict = runupdate_instance.to_dict()
# create an instance of Runupdate from a dict
runupdate_form_dict = runupdate.from_dict(runupdate_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 0 additions & 1 deletion qase-api-client/docs/TestCaseCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Name | Type | Description | Notes
**type** | **int** | | [optional]
**layer** | **int** | | [optional]
**is_flaky** | **int** | | [optional]
**author_id** | **int** | | [optional]
**suite_id** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**automation** | **int** | | [optional]
Expand Down
1 change: 0 additions & 1 deletion qase-api-client/docs/TestCasebulkCasesInner.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Name | Type | Description | Notes
**type** | **int** | | [optional]
**layer** | **int** | | [optional]
**is_flaky** | **int** | | [optional]
**author_id** | **int** | | [optional]
**suite_id** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**automation** | **int** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "qase-api-client"
version = "1.2.2"
version = "1.2.3"
description = "Qase TestOps API V1 client for Python"
readme = "README.md"
authors = [{name = "Qase Team", email = "support@qase.io"}]
Expand Down
Loading