Skip to content

chore: update API clients to latest specification #975

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.

Sign up for GitHub

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

Merged
gibiw merged 1 commit into from
Jun 10, 2026
Merged

chore: update API clients to latest specification #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**severity** | **number** | | [default to undefined]
**milestone_id** | **number** | | [optional] [default to undefined]
**attachments** | **Array<string>** | | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | 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] [default to undefined]
**tags** | **Array<string>** | | [optional] [default to undefined]

## Example
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/DefectUpdate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**severity** | **number** | | [optional] [default to undefined]
**milestone_id** | **number** | | [optional] [default to undefined]
**attachments** | **Array<string>** | | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | 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] [default to undefined]
**tags** | **Array<string>** | | [optional] [default to undefined]

## Example
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/RunCreate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**author_id** | **number** | | [optional] [default to undefined]
**tags** | **Array<string>** | | [optional] [default to undefined]
**configurations** | **Array<number>** | | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | 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] [default to undefined]
**start_time** | **string** | | [optional] [default to undefined]
**end_time** | **string** | | [optional] [default to undefined]
**is_cloud** | **boolean** | Indicates if the run is created for the Test Cases produced by AIDEN | [optional] [default to undefined]
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/docs/Runupdate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**milestone_id** | **number** | | [optional] [default to undefined]
**tags** | **Array<string>** | | [optional] [default to undefined]
**configurations** | **Array<number>** | | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | 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] [default to undefined]

## Example

Expand Down
6 changes: 5 additions & 1 deletion qase-api-client/docs/TestCase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Name | Type | Description | Notes
**layer** | **number** | | [optional] [default to undefined]
**is_flaky** | **number** | | [optional] [default to undefined]
**behavior** | **number** | | [optional] [default to undefined]
**automation** | **number** | | [optional] [default to undefined]
**automation** | **number** | 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] [default to undefined]
**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined]
**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined]
**status** | **number** | | [optional] [default to undefined]
**milestone_id** | **number** | | [optional] [default to undefined]
**suite_id** | **number** | | [optional] [default to undefined]
Expand Down Expand Up @@ -56,6 +58,8 @@ const instance: TestCase = {
is_flaky,
behavior,
automation,
isManual,
isToBeAutomated,
status,
milestone_id,
suite_id,
Expand Down
8 changes: 6 additions & 2 deletions qase-api-client/docs/TestCaseCreate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ Name | Type | Description | Notes
**is_flaky** | **number** | | [optional] [default to undefined]
**suite_id** | **number** | | [optional] [default to undefined]
**milestone_id** | **number** | | [optional] [default to undefined]
**automation** | **number** | | [optional] [default to undefined]
**automation** | **number** | 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] [default to undefined]
**isManual** | **number** | `1` if the case is manual, `0` if it is automated. Combined with `isToBeAutomated`, replaces the deprecated `automation` field. | [optional] [default to undefined]
**isToBeAutomated** | **number** | `1` if a manual case is planned to be automated, `0` otherwise. Only meaningful when `isManual = 1`; ignored when `isManual = 0`. | [optional] [default to undefined]
**status** | **number** | | [optional] [default to undefined]
**steps_type** | **string** | 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 StepsTypeEnum_CLASSIC]
**attachments** | **Array<string>** | A list of Attachment hashes. | [optional] [default to undefined]
**steps** | [**Array<TestStepCreate>**](TestStepCreate.md) | | [optional] [default to undefined]
**tags** | **Array<string>** | | [optional] [default to undefined]
**params** | **{ [key: string]: Array<string>; }** | Deprecated, use `parameters` instead. | [optional] [default to undefined]
**parameters** | [**Array<TestCaseParameterCreate>**](TestCaseParameterCreate.md) | | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | A map of custom fields values (id => value) | [optional] [default to undefined]
**custom_field** | **{ [key: string]: string; }** | 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] [default to undefined]
**created_at** | **string** | | [optional] [default to undefined]
**updated_at** | **string** | | [optional] [default to undefined]

Expand All @@ -48,6 +50,8 @@ const instance: TestCaseCreate = {
suite_id,
milestone_id,
automation,
isManual,
isToBeAutomated,
status,
steps_type,
attachments,
Expand Down
Loading
Loading