Skip to content

chore: update API clients to latest specification #505

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
Aug 11, 2026
Merged

chore: update API clients to latest specification #505

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
16 changes: 8 additions & 8 deletions qase-api-client/docs/CasesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,10 +589,10 @@ with qase.api_client_v1.ApiClient(configuration) as api_client:
suite_id = 56 # int | ID of test suite. (optional)
severity = 'severity_example' # str | A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial (optional)
priority = 'priority_example' # str | A list of priority values separated by comma. Possible values: undefined, high, medium, low (optional)
type = 'type_example' # str | A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance (optional)
behavior = 'behavior_example' # str | A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive (optional)
automation = 'automation_example' # str | A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated (optional)
status = 'status_example' # str | A list of values separated by comma. Possible values: actual, draft deprecated (optional)
type = 'type_example' # str | A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance (optional)
behavior = 'behavior_example' # str | A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive (optional)
automation = 'automation_example' # str | A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated (optional)
status = 'status_example' # str | A list of values separated by comma. Possible values: actual, draft, deprecated (optional)
external_issues_type = 'external_issues_type_example' # str | An integration type. (optional)
external_issues_ids = ['external_issues_ids_example'] # List[str] | A list of issue IDs. (optional)
include = 'include_example' # str | A list of entities to include in response separated by comma. Possible values: external_issues. (optional)
Expand Down Expand Up @@ -621,10 +621,10 @@ Name | Type | Description | Notes
**suite_id** | **int**| ID of test suite. | [optional]
**severity** | **str**| A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial | [optional]
**priority** | **str**| A list of priority values separated by comma. Possible values: undefined, high, medium, low | [optional]
**type** | **str**| A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance | [optional]
**behavior** | **str**| A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive | [optional]
**automation** | **str**| A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated | [optional]
**status** | **str**| A list of values separated by comma. Possible values: actual, draft deprecated | [optional]
**type** | **str**| A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance | [optional]
**behavior** | **str**| A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive | [optional]
**automation** | **str**| A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated | [optional]
**status** | **str**| A list of values separated by comma. Possible values: actual, draft, deprecated | [optional]
**external_issues_type** | **str**| An integration type. | [optional]
**external_issues_ids** | [**List[str]**](str.md)| A list of issue IDs. | [optional]
**include** | **str**| A list of entities to include in response separated by comma. Possible values: external_issues. | [optional]
Expand Down
1 change: 1 addition & 0 deletions qase-api-client/docs/TestStepCreate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **str** | Step action text. Used for classic steps. For gherkin steps, use the \"value\" property instead. | [optional]
**shared** | **str** | Hash of an existing shared step to insert at this position. | [optional]
**expected_result** | **str** | | [optional]
**data** | **str** | | [optional]
**value** | **str** | Gherkin scenario text. Used when steps_type is \"gherkin\". Example: \"Given a user exists\\nWhen they log in\\nThen they see the dashboard\" | [optional]
Expand Down
2 changes: 1 addition & 1 deletion qase-api-client/pyproject.toml
View file
Open in desktop
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 = "2.0.11"
version = "2.0.12"
description = "Qase TestOps API V1 client for Python"
readme = "README.md"
authors = [{name = "Qase Team", email = "support@qase.io"}]
Expand Down
48 changes: 24 additions & 24 deletions qase-api-client/src/qase/api_client_v1/api/cases_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1889,10 +1889,10 @@ def get_cases(
suite_id: Annotated[Optional[StrictInt], Field(description="ID of test suite.")] = None,
severity: Annotated[Optional[StrictStr], Field(description="A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial ")] = None,
priority: Annotated[Optional[StrictStr], Field(description="A list of priority values separated by comma. Possible values: undefined, high, medium, low ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft deprecated ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft, deprecated ")] = None,
external_issues_type: Annotated[Optional[StrictStr], Field(description="An integration type. ")] = None,
external_issues_ids: Annotated[Optional[List[StrictStr]], Field(description="A list of issue IDs.")] = None,
include: Annotated[Optional[StrictStr], Field(description="A list of entities to include in response separated by comma. Possible values: external_issues. ")] = None,
Expand Down Expand Up @@ -1927,13 +1927,13 @@ def get_cases(
:type severity: str
:param priority: A list of priority values separated by comma. Possible values: undefined, high, medium, low
:type priority: str
:param type: A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance
:param type: A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance
:type type: str
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive
:type behavior: str
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated
:type automation: str
:param status: A list of values separated by comma. Possible values: actual, draft deprecated
:param status: A list of values separated by comma. Possible values: actual, draft, deprecated
:type status: str
:param external_issues_type: An integration type.
:type external_issues_type: str
Expand Down Expand Up @@ -2018,10 +2018,10 @@ def get_cases_with_http_info(
suite_id: Annotated[Optional[StrictInt], Field(description="ID of test suite.")] = None,
severity: Annotated[Optional[StrictStr], Field(description="A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial ")] = None,
priority: Annotated[Optional[StrictStr], Field(description="A list of priority values separated by comma. Possible values: undefined, high, medium, low ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft deprecated ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft, deprecated ")] = None,
external_issues_type: Annotated[Optional[StrictStr], Field(description="An integration type. ")] = None,
external_issues_ids: Annotated[Optional[List[StrictStr]], Field(description="A list of issue IDs.")] = None,
include: Annotated[Optional[StrictStr], Field(description="A list of entities to include in response separated by comma. Possible values: external_issues. ")] = None,
Expand Down Expand Up @@ -2056,13 +2056,13 @@ def get_cases_with_http_info(
:type severity: str
:param priority: A list of priority values separated by comma. Possible values: undefined, high, medium, low
:type priority: str
:param type: A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance
:param type: A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance
:type type: str
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive
:type behavior: str
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated
:type automation: str
:param status: A list of values separated by comma. Possible values: actual, draft deprecated
:param status: A list of values separated by comma. Possible values: actual, draft, deprecated
:type status: str
:param external_issues_type: An integration type.
:type external_issues_type: str
Expand Down Expand Up @@ -2147,10 +2147,10 @@ def get_cases_without_preload_content(
suite_id: Annotated[Optional[StrictInt], Field(description="ID of test suite.")] = None,
severity: Annotated[Optional[StrictStr], Field(description="A list of severity values separated by comma. Possible values: undefined, blocker, critical, major, normal, minor, trivial ")] = None,
priority: Annotated[Optional[StrictStr], Field(description="A list of priority values separated by comma. Possible values: undefined, high, medium, low ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft deprecated ")] = None,
type: Annotated[Optional[StrictStr], Field(description="A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance ")] = None,
behavior: Annotated[Optional[StrictStr], Field(description="A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive ")] = None,
automation: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated ")] = None,
status: Annotated[Optional[StrictStr], Field(description="A list of values separated by comma. Possible values: actual, draft, deprecated ")] = None,
external_issues_type: Annotated[Optional[StrictStr], Field(description="An integration type. ")] = None,
external_issues_ids: Annotated[Optional[List[StrictStr]], Field(description="A list of issue IDs.")] = None,
include: Annotated[Optional[StrictStr], Field(description="A list of entities to include in response separated by comma. Possible values: external_issues. ")] = None,
Expand Down Expand Up @@ -2185,13 +2185,13 @@ def get_cases_without_preload_content(
:type severity: str
:param priority: A list of priority values separated by comma. Possible values: undefined, high, medium, low
:type priority: str
:param type: A list of type values separated by comma. Possible values: other, functional smoke, regression, security, usability, performance, acceptance
:param type: A list of type values separated by comma. Possible values: other, functional, smoke, regression, security, usability, performance, acceptance
:type type: str
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive negative, destructive
:param behavior: A list of behavior values separated by comma. Possible values: undefined, positive, negative, destructive
:type behavior: str
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated to-be-automated
:param automation: A list of values separated by comma. Possible values: is-not-automated, automated, to-be-automated
:type automation: str
:param status: A list of values separated by comma. Possible values: actual, draft deprecated
:param status: A list of values separated by comma. Possible values: actual, draft, deprecated
:type status: str
:param external_issues_type: An integration type.
:type external_issues_type: str
Expand Down
4 changes: 3 additions & 1 deletion qase-api-client/src/qase/api_client_v1/models/test_step_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ class TestStepCreate(BaseModel):
TestStepCreate
""" # noqa: E501
action: Optional[StrictStr] = Field(default=None, description="Step action text. Used for classic steps. For gherkin steps, use the \"value\" property instead.")
shared: Optional[StrictStr] = Field(default=None, description="Hash of an existing shared step to insert at this position.")
expected_result: Optional[StrictStr] = None
data: Optional[StrictStr] = None
value: Optional[StrictStr] = Field(default=None, description="Gherkin scenario text. Used when steps_type is \"gherkin\". Example: \"Given a user exists\\nWhen they log in\\nThen they see the dashboard\"")
position: Optional[StrictInt] = None
attachments: Optional[List[StrictStr]] = Field(default=None, description="A list of Attachment hashes.")
steps: Optional[List[Dict[str, Any]]] = Field(default=None, description="Nested steps may be passed here. Use same structure for them.")
__properties: ClassVar[List[str]] = ["action", "expected_result", "data", "value", "position", "attachments", "steps"]
__properties: ClassVar[List[str]] = ["action", "shared", "expected_result", "data", "value", "position", "attachments", "steps"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -88,6 +89,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:

_obj = cls.model_validate({
"action": obj.get("action"),
"shared": obj.get("shared"),
"expected_result": obj.get("expected_result"),
"data": obj.get("data"),
"value": obj.get("value"),
Expand Down
Loading