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
2 changes: 1 addition & 1 deletion qase-api-client/docs/DefectCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**severity** | **int** | |
**milestone_id** | **int** | | [optional]
**attachments** | **List[str]** | | [optional]
**custom_field** | **Dict[str, str]** | A map of custom fields values (id => value) | [optional]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]
**tags** | **List[str]** | | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/DefectUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**severity** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**attachments** | **List[str]** | | [optional]
**custom_field** | **Dict[str, str]** | A map of custom fields values (id => value) | [optional]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]
**tags** | **List[str]** | | [optional]

## Example
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/RunCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**author_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]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]
**start_time** | **str** | | [optional]
**end_time** | **str** | | [optional]
**is_cloud** | **bool** | Indicates if the run is created for the Test Cases produced by AIDEN | [optional]
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/Runupdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**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]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]

## Example

Expand Down
4 changes: 3 additions & 1 deletion qase-api-client/docs/TestCase.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Name | Type | Description | Notes
**layer** | **int** | | [optional]
**is_flaky** | **int** | | [optional]
**behavior** | **int** | | [optional]
**automation** | **int** | | [optional]
**automation** | **int** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. | [optional]
**is_manual** | **int** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional]
**is_to_be_automated** | **int** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional]
**status** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**suite_id** | **int** | | [optional]
Expand Down
6 changes: 4 additions & 2 deletions qase-api-client/docs/TestCaseCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ Name | Type | Description | Notes
**is_flaky** | **int** | | [optional]
**suite_id** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**automation** | **int** | | [optional]
**automation** | **int** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. | [optional]
**is_manual** | **int** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional]
**is_to_be_automated** | **int** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional]
**status** | **int** | | [optional]
**steps_type** | **str** | Determines the format of the steps field. When \"classic\", steps use the standard action/expected_result/data format. When \"gherkin\", steps use the {value: \"Given...\\nWhen...\\nThen...\"} format. | [optional] [default to 'classic']
**attachments** | **List[str]** | A list of Attachment hashes. | [optional]
**steps** | [**List[TestStepCreate]**](TestStepCreate.md) | | [optional]
**tags** | **List[str]** | | [optional]
**params** | **Dict[str, List[str]]** | Deprecated, use `parameters` instead. | [optional]
**parameters** | [**List[TestCaseParameterCreate]**](TestCaseParameterCreate.md) | | [optional]
**custom_field** | **Dict[str, str]** | A map of custom fields values (id => value) | [optional]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Validation: all required fields without a default value must be present and non-empty; unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]
**created_at** | **str** | | [optional]
**updated_at** | **str** | | [optional]

Expand Down
6 changes: 4 additions & 2 deletions qase-api-client/docs/TestCaseUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ Name | Type | Description | Notes
**is_flaky** | **int** | | [optional]
**suite_id** | **int** | | [optional]
**milestone_id** | **int** | | [optional]
**automation** | **int** | | [optional]
**automation** | **int** | Deprecated, use `isManual` and `isToBeAutomated` instead. Encodes the test case automation state as a single integer: `0` = manual, `1` = manual planned to be automated, `2` = automated. If both `automation` and `isManual`/`isToBeAutomated` are provided, `isManual` and `isToBeAutomated` take precedence. | [optional]
**is_manual** | **int** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional]
**is_to_be_automated** | **int** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional]
**status** | **int** | | [optional]
**steps_type** | **str** | Determines the format of the steps field. When \"classic\", steps use the standard action/expected_result/data format. When \"gherkin\", steps use the {value: \"Given...\\nWhen...\\nThen...\"} format. | [optional] [default to 'classic']
**attachments** | **List[str]** | A list of Attachment hashes. | [optional]
**steps** | [**List[TestStepCreate]**](TestStepCreate.md) | | [optional]
**tags** | **List[str]** | | [optional]
**params** | **Dict[str, List[str]]** | Deprecated, use `parameters` instead. | [optional]
**parameters** | [**List[TestCaseParameterCreate]**](TestCaseParameterCreate.md) | | [optional]
**custom_field** | **Dict[str, str]** | A map of custom fields values (id => value) | [optional]
**custom_field** | **Dict[str, str]** | Custom field values keyed by the field's project-scoped `internal_id` (see `GET /custom_field`). Values are always **scalar strings**; arrays, objects or non-scalars are rejected. | Field type | Value format | Example | |----------------------|-------------------------------------------|-------------------------| | `string`, `text` | Plain string | `\"hello\"` | | `number` | Numeric string | `\"42\"` | | `url` | Valid URL | `\"https://qase.io\"` | | `datetime` | Absolute date (ISO 8601 recommended) | `\"2026-04-29T15:00:00Z\"`| | `selectbox`, `radio` | Option `id` as string | `\"1\"` | | `multiselect` | Comma-separated option `id`s (no spaces) | `\"1,2,3\"` | | `checkbox` | `\"1\"` to check, `\"\"` to uncheck | `\"1\"` | | `user` | Team member `internal_id` as string | `\"42\"` | Partial update: only fields present in the payload are validated; required fields not included are not enforced. Send `\"\"` to clear a value. Unknown `internal_id`s are rejected; option-based values must reference an existing option. Note: a `required` checkbox without a default cannot be unchecked via the API — set a default or clear `required` in workspace settings. | [optional]

## Example

Expand Down
Loading
Loading