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: 2 additions & 1 deletion qase-api-client/docs/Author.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**author_id** | **int** | | [optional]
**uuid** | **UUID** | Author UUID. Use it to reference the author in other API methods. | [optional]
**author_id** | **int** | Deprecated, use `uuid` instead. | [optional]
**entity_type** | **str** | | [optional]
**entity_id** | **int** | | [optional]
**email** | **str** | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions qase-api-client/docs/AuthorsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ configuration.api_key['TokenAuth'] = os.environ["API_KEY"]
with qase.api_client_v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = qase.api_client_v1.AuthorsApi(api_client)
id = 56 # int | Identifier.
id = 'id_example' # str | Author UUID, or the deprecated integer author ID.

try:
# Get a specific author
Expand All @@ -65,7 +65,7 @@ with qase.api_client_v1.ApiClient(configuration) as api_client:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| Identifier. |
**id** | **str**| Author UUID, or the deprecated integer author ID. |

### Return type

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Review ID, unique within the project. | [optional]
**title** | **str** | | [optional]
**type** | **str** | `create` — the review proposes a new test case; `edit` — the review proposes changes to an existing test case. | [optional]
**status** | **str** | | [optional]
**case_id** | **int** | ID of the reviewed test case. Null for new-case draft reviews. | [optional]
**author_uuid** | **UUID** | Author UUID of the review creator (see `GET /author`). | [optional]
**reviewers** | [**List[ReviewReviewersInner]**](ReviewReviewersInner.md) | | [optional]
**created_at** | **datetime** | | [optional]
**updated_at** | **datetime** | | [optional]

## Example

```python
from qase.api_client_v1.models.review import Review

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

# convert the object into a dict
review_dict = review_instance.to_dict()
# create an instance of Review from a dict
review_from_dict = Review.from_dict(review_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reviews** | [**List[ReviewCreate]**](ReviewCreate.md) | Validated as a whole: if any item is invalid nothing is created. Otherwise each item is processed on its own and reported in the response. |

## Example

```python
from qase.api_client_v1.models.review_bulk import ReviewBulk

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

# convert the object into a dict
review_bulk_dict = review_bulk_instance.to_dict()
# create an instance of ReviewBulk from a dict
review_bulk_from_dict = ReviewBulk.from_dict(review_bulk_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/ReviewBulkResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ReviewBulkResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | | [optional]
**result** | [**ReviewBulkResponseAllOfResult**](ReviewBulkResponseAllOfResult.md) | | [optional]

## Example

```python
from qase.api_client_v1.models.review_bulk_response import ReviewBulkResponse

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

# convert the object into a dict
review_bulk_response_dict = review_bulk_response_instance.to_dict()
# create an instance of ReviewBulkResponse from a dict
review_bulk_response_from_dict = ReviewBulkResponse.from_dict(review_bulk_response_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | [**List[ReviewBulkResponseAllOfResultItems]**](ReviewBulkResponseAllOfResultItems.md) | Per-item outcomes, in request order. | [optional]

## Example

```python
from qase.api_client_v1.models.review_bulk_response_all_of_result import ReviewBulkResponseAllOfResult

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

# convert the object into a dict
review_bulk_response_all_of_result_dict = review_bulk_response_all_of_result_instance.to_dict()
# create an instance of ReviewBulkResponseAllOfResult from a dict
review_bulk_response_all_of_result_from_dict = ReviewBulkResponseAllOfResult.from_dict(review_bulk_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**review_id** | **int** | ID of the created review. Null when the item failed. | [optional]
**case_id** | **int** | The `case_id` submitted with the item, echoed back for correlation. Null for new-case draft reviews. | [optional]
**error** | **str** | Failure reason. Null when the item was created. | [optional]

## Example

```python
from qase.api_client_v1.models.review_bulk_response_all_of_result_items import ReviewBulkResponseAllOfResultItems

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

# convert the object into a dict
review_bulk_response_all_of_result_items_dict = review_bulk_response_all_of_result_items_instance.to_dict()
# create an instance of ReviewBulkResponseAllOfResultItems from a dict
review_bulk_response_all_of_result_items_from_dict = ReviewBulkResponseAllOfResultItems.from_dict(review_bulk_response_all_of_result_items_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)


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

The test case fields proposed by the review.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [optional]
**description** | **str** | | [optional]
**preconditions** | **str** | | [optional]
**postconditions** | **str** | | [optional]
**severity** | **int** | | [optional]
**priority** | **int** | | [optional]
**behavior** | **int** | | [optional]
**type** | **int** | | [optional]
**layer** | **int** | | [optional]
**is_flaky** | **int** | | [optional]
**is_muted** | **bool** | Mute state of the proposed test case. | [optional]
**suite_id** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**is_manual** | **bool** | `true` if the case is manual, `false` if it is automated. | [optional]
**is_to_be_automated** | **bool** | `true` if a manual case is planned to be automated. | [optional]
**status** | **int** | | [optional]
**steps_type** | **str** | Format of the steps field. Omit to keep the current one, `classic` for a new-case draft; changing it requires sending `steps` in the same request. | [optional]
**attachments** | **List[str]** | A list of Attachment hashes. | [optional]
**steps** | [**List[ReviewStepData]**](ReviewStepData.md) | For gherkin steps send the scenario in `value`. | [optional]
**tags** | **List[str]** | | [optional]
**parameters** | [**List[TestCaseParameterCreate]**](TestCaseParameterCreate.md) | | [optional]
**custom_field** | **Dict[str, str]** | Map of custom field ID to value. A `create` review must carry every required custom field. An `edit` review is validated against the current test case, so send only the fields the proposal changes. | [optional]

## Example

```python
from qase.api_client_v1.models.review_case_data import ReviewCaseData

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

# convert the object into a dict
review_case_data_dict = review_case_data_instance.to_dict()
# create an instance of ReviewCaseData from a dict
review_case_data_from_dict = ReviewCaseData.from_dict(review_case_data_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**case_id** | **int** | ID of the reviewed test case. When present an `edit` review is created, otherwise a `create` review with a new-case draft. | [optional]
**reviewers** | **List[UUID]** | Author UUIDs of team members to assign as reviewers (see `GET /author`). | [optional]
**proposed_case** | [**ReviewCaseData**](ReviewCaseData.md) | For `create` reviews `title` and all required project fields are required. For `edit` reviews send only the fields the proposal changes. |

## Example

```python
from qase.api_client_v1.models.review_create import ReviewCreate

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

# convert the object into a dict
review_create_dict = review_create_instance.to_dict()
# create an instance of ReviewCreate from a dict
review_create_from_dict = ReviewCreate.from_dict(review_create_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Review ID, unique within the project. | [optional]
**title** | **str** | | [optional]
**type** | **str** | `create` — the review proposes a new test case; `edit` — the review proposes changes to an existing test case. | [optional]
**status** | **str** | | [optional]
**case_id** | **int** | ID of the reviewed test case. Null for new-case draft reviews. | [optional]
**author_uuid** | **UUID** | Author UUID of the review creator (see `GET /author`). | [optional]
**reviewers** | [**List[ReviewReviewersInner]**](ReviewReviewersInner.md) | | [optional]
**created_at** | **datetime** | | [optional]
**updated_at** | **datetime** | | [optional]
**proposed_case** | **object** | The proposed test case state. Merging the review applies it to the test case. | [optional]

## Example

```python
from qase.api_client_v1.models.review_detailed import ReviewDetailed

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

# convert the object into a dict
review_detailed_dict = review_detailed_instance.to_dict()
# create an instance of ReviewDetailed from a dict
review_detailed_from_dict = ReviewDetailed.from_dict(review_detailed_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/ReviewListResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ReviewListResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | | [optional]
**result** | [**ReviewListResponseAllOfResult**](ReviewListResponseAllOfResult.md) | | [optional]

## Example

```python
from qase.api_client_v1.models.review_list_response import ReviewListResponse

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

# convert the object into a dict
review_list_response_dict = review_list_response_instance.to_dict()
# create an instance of ReviewListResponse from a dict
review_list_response_from_dict = ReviewListResponse.from_dict(review_list_response_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **int** | | [optional]
**filtered** | **int** | | [optional]
**count** | **int** | | [optional]
**entities** | [**List[Review]**](Review.md) | | [optional]

## Example

```python
from qase.api_client_v1.models.review_list_response_all_of_result import ReviewListResponseAllOfResult

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

# convert the object into a dict
review_list_response_all_of_result_dict = review_list_response_all_of_result_instance.to_dict()
# create an instance of ReviewListResponseAllOfResult from a dict
review_list_response_all_of_result_from_dict = ReviewListResponseAllOfResult.from_dict(review_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)


Loading
Loading