chore: update API clients to latest specification

changelog.md

@@ -1,3 +1,7 @@
+# qase-java 4.1.59
+
+- Updated API clients to the latest specification
+
 # qase-java 4.1.58
 
 - Updated API clients to the latest specification

pom.xml

@@ -7,7 +7,7 @@
     <groupId>io.qase</groupId>
     <artifactId>qase-java</artifactId>
     <packaging>pom</packaging>
-    <version>4.1.58</version>
+    <version>4.1.59</version>
     <modules>
         <module>qase-java-commons</module>
         <module>qase-api-client</module>

qase-api-client/docs/Author.md

@@ -8,7 +8,8 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**id** | **Long** |  |  [optional] |
-|**authorId** | **Long** |  |  [optional] |
+|**uuid** | **UUID** | Author UUID. Use it to reference the author in other API methods. |  [optional] |
+|**authorId** | **Long** | Deprecated, use `uuid` instead. |  [optional] |
 |**entityType** | **String** |  |  [optional] |
 |**entityId** | **Long** |  |  [optional] |
 |**email** | **String** |  |  [optional] |

qase-api-client/docs/AuthorsApi.md

@@ -38,7 +38,7 @@ public class Example {
     //TokenAuth.setApiKeyPrefix("Token");
 
     AuthorsApi apiInstance = new AuthorsApi(defaultClient);
-    Integer id = 56; // Integer | Identifier.
+    String id = "id_example"; // String | Author UUID, or the deprecated integer author ID.
     try {
       AuthorResponse result = apiInstance.getAuthor(id);
       System.out.println(result);
@@ -57,7 +57,7 @@ public class Example {
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **id** | **Integer**| Identifier. | |
+| **id** | **String**| Author UUID, or the deprecated integer author ID. | |
 
 ### Return type
 

qase-api-client/docs/Review.md

@@ -0,0 +1,40 @@
+
+
+# Review
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **Long** | Review ID, unique within the project. |  [optional] |
+|**title** | **String** |  |  [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | `create` — the review proposes a new test case; `edit` — the review proposes changes to an existing test case. |  [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) |  |  [optional] |
+|**caseId** | **Long** | ID of the reviewed test case. Null for new-case draft reviews. |  [optional] |
+|**authorUuid** | **UUID** | Author UUID of the review creator (see `GET /author`). |  [optional] |
+|**reviewers** | [**List<ReviewReviewersInner>**](ReviewReviewersInner.md) |  |  [optional] |
+|**createdAt** | **OffsetDateTime** |  |  [optional] |
+|**updatedAt** | **OffsetDateTime** |  |  [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| EDIT | "edit" |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| OPEN | "open" |
+| MERGED | "merged" |
+| DECLINED | "declined" |
+
+
+

qase-api-client/docs/ReviewBulk.md

@@ -0,0 +1,13 @@
+
+
+# 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. |  |
+
+
+

qase-api-client/docs/ReviewBulkResponse.md

@@ -0,0 +1,14 @@
+
+
+# ReviewBulkResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | **Boolean** |  |  [optional] |
+|**result** | [**ReviewBulkResponseAllOfResult**](ReviewBulkResponseAllOfResult.md) |  |  [optional] |
+
+
+

qase-api-client/docs/ReviewBulkResponseAllOfResult.md

@@ -0,0 +1,13 @@
+
+
+# ReviewBulkResponseAllOfResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**items** | [**List<ReviewBulkResponseAllOfResultItems>**](ReviewBulkResponseAllOfResultItems.md) | Per-item outcomes, in request order. |  [optional] |
+
+
+

qase-api-client/docs/ReviewBulkResponseAllOfResultItems.md

@@ -0,0 +1,15 @@
+
+
+# ReviewBulkResponseAllOfResultItems
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**reviewId** | **Long** | ID of the created review. Null when the item failed. |  [optional] |
+|**caseId** | **Long** | The `case_id` submitted with the item, echoed back for correlation. Null for new-case draft reviews. |  [optional] |
+|**error** | **String** | Failure reason. Null when the item was created. |  [optional] |
+
+
+

qase-api-client/docs/ReviewCaseData.md

@@ -0,0 +1,44 @@
+
+
+# ReviewCaseData
+
+The test case fields proposed by the review.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**title** | **String** |  |  [optional] |
+|**description** | **String** |  |  [optional] |
+|**preconditions** | **String** |  |  [optional] |
+|**postconditions** | **String** |  |  [optional] |
+|**severity** | **Integer** |  |  [optional] |
+|**priority** | **Integer** |  |  [optional] |
+|**behavior** | **Integer** |  |  [optional] |
+|**type** | **Integer** |  |  [optional] |
+|**layer** | **Integer** |  |  [optional] |
+|**isFlaky** | **Integer** |  |  [optional] |
+|**isMuted** | **Boolean** | Mute state of the proposed test case. |  [optional] |
+|**suiteId** | **Long** |  |  [optional] |
+|**milestoneId** | **Long** |  |  [optional] |
+|**isManual** | **Boolean** | `true` if the case is manual, `false` if it is automated. |  [optional] |
+|**isToBeAutomated** | **Boolean** | `true` if a manual case is planned to be automated. |  [optional] |
+|**status** | **Integer** |  |  [optional] |
+|**stepsType** | [**StepsTypeEnum**](#StepsTypeEnum) | 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<String>** | A list of Attachment hashes. |  [optional] |
+|**steps** | [**List<ReviewStepData>**](ReviewStepData.md) | For gherkin steps send the scenario in `value`. |  [optional] |
+|**tags** | **List<String>** |  |  [optional] |
+|**parameters** | [**List<TestCaseParameterCreate>**](TestCaseParameterCreate.md) |  |  [optional] |
+|**customField** | **Map<String, String>** | 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] |
+
+
+
+## Enum: StepsTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CLASSIC | "classic" |
+| GHERKIN | "gherkin" |
+
+
+

qase-api-client/docs/ReviewCreate.md

@@ -0,0 +1,15 @@
+
+
+# ReviewCreate
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**caseId** | **Long** | 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] |
+|**proposedCase** | [**ReviewCaseData**](ReviewCaseData.md) | For `create` reviews `title` and all required project fields are required. For `edit` reviews send only the fields the proposal changes. |  |
+
+
+

qase-api-client/docs/ReviewDetailed.md

@@ -0,0 +1,41 @@
+
+
+# ReviewDetailed
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **Long** | Review ID, unique within the project. |  [optional] |
+|**title** | **String** |  |  [optional] |
+|**type** | [**TypeEnum**](#TypeEnum) | `create` — the review proposes a new test case; `edit` — the review proposes changes to an existing test case. |  [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) |  |  [optional] |
+|**caseId** | **Long** | ID of the reviewed test case. Null for new-case draft reviews. |  [optional] |
+|**authorUuid** | **UUID** | Author UUID of the review creator (see `GET /author`). |  [optional] |
+|**reviewers** | [**List<ReviewReviewersInner>**](ReviewReviewersInner.md) |  |  [optional] |
+|**createdAt** | **OffsetDateTime** |  |  [optional] |
+|**updatedAt** | **OffsetDateTime** |  |  [optional] |
+|**proposedCase** | **Object** | The proposed test case state. Merging the review applies it to the test case. |  [optional] |
+
+
+
+## Enum: TypeEnum
+
+| Name | Value |
+|---- | -----|
+| CREATE | "create" |
+| EDIT | "edit" |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| OPEN | "open" |
+| MERGED | "merged" |
+| DECLINED | "declined" |
+
+
+

qase-api-client/docs/ReviewListResponse.md

@@ -0,0 +1,14 @@
+
+
+# ReviewListResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | **Boolean** |  |  [optional] |
+|**result** | [**ReviewListResponseAllOfResult**](ReviewListResponseAllOfResult.md) |  |  [optional] |
+
+
+

qase-api-client/docs/ReviewListResponseAllOfResult.md

@@ -0,0 +1,16 @@
+
+
+# ReviewListResponseAllOfResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**total** | **Integer** |  |  [optional] |
+|**filtered** | **Integer** |  |  [optional] |
+|**count** | **Integer** |  |  [optional] |
+|**entities** | [**List<Review>**](Review.md) |  |  [optional] |
+
+
+

qase-api-client/docs/ReviewProposedCase.md

@@ -0,0 +1,44 @@
+
+
+# ReviewProposedCase
+
+The test case state proposed by the review. Only the fields the proposal carries are present.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**title** | **String** |  |  [optional] |
+|**description** | **String** |  |  [optional] |
+|**preconditions** | **String** |  |  [optional] |
+|**postconditions** | **String** |  |  [optional] |
+|**severity** | **Integer** |  |  [optional] |
+|**priority** | **Integer** |  |  [optional] |
+|**behavior** | **Integer** |  |  [optional] |
+|**type** | **Integer** |  |  [optional] |
+|**layer** | **Integer** |  |  [optional] |
+|**isFlaky** | **Integer** |  |  [optional] |
+|**isMuted** | **Boolean** |  |  [optional] |
+|**suiteId** | **Long** |  |  [optional] |
+|**milestoneId** | **Long** |  |  [optional] |
+|**isManual** | **Boolean** | `true` if the case is manual, `false` if it is automated. |  [optional] |
+|**isToBeAutomated** | **Boolean** | `true` if a manual case is planned to be automated. |  [optional] |
+|**status** | **Integer** |  |  [optional] |
+|**stepsType** | [**StepsTypeEnum**](#StepsTypeEnum) |  |  [optional] |
+|**attachments** | **List<String>** | Attachment hashes. |  [optional] |
+|**steps** | [**List<ReviewProposedStep>**](ReviewProposedStep.md) |  |  [optional] |
+|**tags** | **List<String>** |  |  [optional] |
+|**parameters** | [**List<TestCaseParameter>**](TestCaseParameter.md) |  |  [optional] |
+|**customFields** | [**List<CustomFieldValue>**](CustomFieldValue.md) |  |  [optional] |
+
+
+
+## Enum: StepsTypeEnum
+
+| Name | Value |
+|---- | -----|
+| CLASSIC | "classic" |
+| GHERKIN | "gherkin" |
+
+
+

qase-api-client/docs/ReviewProposedStep.md

@@ -0,0 +1,19 @@
+
+
+# ReviewProposedStep
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**action** | **String** | Step action text. Used for classic steps. For gherkin steps, use the \"value\" property instead. |  [optional] |
+|**expectedResult** | **String** |  |  [optional] |
+|**data** | **String** |  |  [optional] |
+|**value** | **String** | Gherkin scenario text. Used when steps_type is \"gherkin\". |  [optional] |
+|**shared** | **String** | Hash of the referenced shared step. |  [optional] |
+|**attachments** | **List<String>** | A list of Attachment hashes. |  [optional] |
+|**steps** | **List<Object>** | Nested steps use the same structure. |  [optional] |
+
+
+

qase-api-client/docs/ReviewResponse.md

@@ -0,0 +1,14 @@
+
+
+# ReviewResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**status** | **Boolean** |  |  [optional] |
+|**result** | [**ReviewDetailed**](ReviewDetailed.md) |  |  [optional] |
+
+
+

qase-api-client/docs/ReviewReviewersInner.md

@@ -0,0 +1,24 @@
+
+
+# ReviewReviewersInner
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**authorUuid** | **UUID** | Author UUID of the reviewer (see `GET /author`). |  [optional] |
+|**status** | [**StatusEnum**](#StatusEnum) |  |  [optional] |
+
+
+
+## Enum: StatusEnum
+
+| Name | Value |
+|---- | -----|
+| UNAPPROVED | "unapproved" |
+| APPROVED | "approved" |
+| CHANGES_REQUESTED | "changes_requested" |
+
+
+