Merge pull request #4 from testit-tms/release/0.2.0

feat: support TMS 5.2.
testit-tms · Nov 28, 2024 · a37aa73 · a37aa73
2 parents 0319215 + 749f404
commit a37aa73
Show file tree

Hide file tree

Showing 506 changed files with 7,078 additions and 23,878 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/Attachment.md b/docs/Attachment.md
@@ -0,0 +1,18 @@
+
+# Attachment
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **id** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the attachment |  |
+| **fileId** | **kotlin.String** | Unique ID of the attachment file |  |
+| **type** | **kotlin.String** | MIME type of the attachment |  |
+| **propertySize** | **kotlin.Float** | Size in bytes of the attachment file |  |
+| **createdDate** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Creation date of the attachment |  |
+| **createdById** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the attachment creator |  |
+| **name** | **kotlin.String** | Name of the attachment file |  |
+| **modifiedDate** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Last modification date of the attachment |  [optional] |
+| **modifiedById** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the attachment last editor |  [optional] |
+
+
+
diff --git a/docs/AttachmentUpdateRequest.md b/docs/AttachmentUpdateRequest.md
@@ -0,0 +1,10 @@
+
+# AttachmentUpdateRequest
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **id** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the attachment |  |
+
+
+
diff --git a/docs/AttachmentsApi.md b/docs/AttachmentsApi.md
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
 | ------------- | ------------- | ------------- |
 | [**apiV2AttachmentsIdDelete**](AttachmentsApi.md#apiV2AttachmentsIdDelete) | **DELETE** /api/v2/attachments/{id} | Delete attachment file |
 | [**apiV2AttachmentsIdGet**](AttachmentsApi.md#apiV2AttachmentsIdGet) | **GET** /api/v2/attachments/{id} | Download attachment file |
+| [**apiV2AttachmentsIdMetadataGet**](AttachmentsApi.md#apiV2AttachmentsIdMetadataGet) | **GET** /api/v2/attachments/{id}/metadata | Get attachment metadata |
 | [**apiV2AttachmentsOccupiedFileStorageSizeGet**](AttachmentsApi.md#apiV2AttachmentsOccupiedFileStorageSizeGet) | **GET** /api/v2/attachments/occupiedFileStorageSize | Get size of attachments storage in bytes |
 | [**apiV2AttachmentsPost**](AttachmentsApi.md#apiV2AttachmentsPost) | **POST** /api/v2/attachments | Upload new attachment file |
 
@@ -103,6 +104,53 @@ null (empty response body)
 ### Authorization
 
 
+Configure Bearer or PrivateToken:
+    ApiClient.apiKey["Authorization"] = ""
+    ApiClient.apiKeyPrefix["Authorization"] = ""
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a id="apiV2AttachmentsIdMetadataGet"></a>
+# **apiV2AttachmentsIdMetadataGet**
+> AttachmentModel apiV2AttachmentsIdMetadataGet(id)
+
+Get attachment metadata
+
+### Example
+```kotlin
+// Import classes:
+//import ru.testit.kotlin.client.infrastructure.*
+//import ru.testit.kotlin.client.models.*
+
+val apiInstance = AttachmentsApi()
+val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
+try {
+    val result : AttachmentModel = apiInstance.apiV2AttachmentsIdMetadataGet(id)
+    println(result)
+} catch (e: ClientException) {
+    println("4xx response calling AttachmentsApi#apiV2AttachmentsIdMetadataGet")
+    e.printStackTrace()
+} catch (e: ServerException) {
+    println("5xx response calling AttachmentsApi#apiV2AttachmentsIdMetadataGet")
+    e.printStackTrace()
+}
+```
+
+### Parameters
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **id** | **java.util.UUID**|  | |
+
+### Return type
+
+[**AttachmentModel**](AttachmentModel.md)
+
+### Authorization
+
+
 Configure Bearer or PrivateToken:
     ApiClient.apiKey["Authorization"] = ""
     ApiClient.apiKeyPrefix["Authorization"] = ""

diff --git a/docs/AutoTest.md b/docs/AutoTest.md
@@ -0,0 +1,37 @@
+
+# AutoTest
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **externalId** | **kotlin.String** | External ID of the autotest |  |
+| **projectId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest project |  |
+| **name** | **kotlin.String** | Name of the autotest |  |
+| **globalId** | **kotlin.Long** | Global ID of the autotest |  |
+| **isDeleted** | **kotlin.Boolean** | Indicates if the autotest is deleted |  |
+| **mustBeApproved** | **kotlin.Boolean** | Indicates if the autotest has unapproved changes from linked work items |  |
+| **id** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest |  |
+| **createdDate** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Creation date of the autotest |  |
+| **createdById** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the project creator |  |
+| **links** | [**kotlin.collections.List&lt;Link&gt;**](Link.md) | Collection of the autotest links |  [optional] |
+| **namespace** | **kotlin.String** | Name of the autotest namespace |  [optional] |
+| **classname** | **kotlin.String** | Name of the autotest class |  [optional] |
+| **steps** | [**kotlin.collections.List&lt;AutoTestStep&gt;**](AutoTestStep.md) | Collection of the autotest steps |  [optional] |
+| **setup** | [**kotlin.collections.List&lt;AutoTestStep&gt;**](AutoTestStep.md) | Collection of the autotest setup steps |  [optional] |
+| **teardown** | [**kotlin.collections.List&lt;AutoTestStep&gt;**](AutoTestStep.md) | Collection of the autotest teardown steps |  [optional] |
+| **title** | **kotlin.String** | Name of the autotest in autotest&#39;s card |  [optional] |
+| **description** | **kotlin.String** | Description of the autotest in autotest&#39;s card |  [optional] |
+| **labels** | [**kotlin.collections.List&lt;Label&gt;**](Label.md) | Collection of the autotest labels |  [optional] |
+| **isFlaky** | **kotlin.Boolean** | Indicates if the autotest is marked as flaky |  [optional] |
+| **externalKey** | **kotlin.String** | External key of the autotest |  [optional] |
+| **modifiedDate** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Last modification date of the project |  [optional] |
+| **modifiedById** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the project last editor |  [optional] |
+| **lastTestRunId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest last test run |  [optional] |
+| **lastTestRunName** | **kotlin.String** | Name of the autotest last test run |  [optional] |
+| **lastTestResultId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest last test result |  [optional] |
+| **lastTestResultConfiguration** | [**ConfigurationShort**](ConfigurationShort.md) | Configuration of the autotest last test result |  [optional] |
+| **lastTestResultOutcome** | **kotlin.String** | Outcome of the autotest last test result |  [optional] |
+| **stabilityPercentage** | **kotlin.Int** | Stability percentage of the autotest |  [optional] |
+
+
+
diff --git a/docs/AutoTestClassCountApiModel.md b/docs/AutoTestClassCountApiModel.md
@@ -0,0 +1,11 @@
+
+# AutoTestClassCountApiModel
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **count** | **kotlin.Long** |  |  |
+| **name** | **kotlin.String** |  |  [optional] |
+
+
+
diff --git a/docs/AutoTestModel.md b/docs/AutoTestModel.md
@@ -18,6 +18,7 @@
 | **lastTestRunId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest last test run |  [optional] |
 | **lastTestRunName** | **kotlin.String** | Name of the autotest last test run |  [optional] |
 | **lastTestResultId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the autotest last test result |  [optional] |
+| **lastTestResultConfiguration** | [**ConfigurationShortModel**](ConfigurationShortModel.md) | Configuration of the autotest last test result |  [optional] |
 | **lastTestResultOutcome** | **kotlin.String** | Outcome of the autotest last test result |  [optional] |
 | **stabilityPercentage** | **kotlin.Int** | Stability percentage of the autotest |  [optional] |
 | **links** | [**kotlin.collections.List&lt;LinkPutModel&gt;**](LinkPutModel.md) | Collection of the autotest links |  [optional] |

diff --git a/docs/AutoTestNamespaceCountApiModel.md b/docs/AutoTestNamespaceCountApiModel.md
@@ -0,0 +1,12 @@
+
+# AutoTestNamespaceCountApiModel
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **count** | **kotlin.Long** |  |  |
+| **classes** | [**kotlin.collections.List&lt;AutoTestClassCountApiModel&gt;**](AutoTestClassCountApiModel.md) |  |  |
+| **name** | **kotlin.String** |  |  [optional] |
+
+
+
diff --git a/docs/AutoTestNamespacesCountResponse.md b/docs/AutoTestNamespacesCountResponse.md
@@ -0,0 +1,10 @@
+
+# AutoTestNamespacesCountResponse
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **namespaces** | [**kotlin.collections.List&lt;AutoTestNamespaceCountApiModel&gt;**](AutoTestNamespaceCountApiModel.md) |  |  |
+
+
+
diff --git a/docs/AutoTestProjectSettingsGetModel.md b/docs/AutoTestProjectSettingsGetModel.md
@@ -0,0 +1,15 @@
+
+# AutoTestProjectSettingsGetModel
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **projectId** | [**java.util.UUID**](java.util.UUID.md) | Unique ID of the project. |  |
+| **rerunEnabled** | **kotlin.Boolean** | Auto rerun enabled |  |
+| **rerunAttemptsCount** | **kotlin.Int** | Auto rerun attempt count |  |
+| **isFlakyAuto** | **kotlin.Boolean** | Indicates if the status \&quot;Flaky/Stable\&quot; sets automatically |  [optional] |
+| **flakyStabilityPercentage** | **kotlin.Int** | Stability percentage for autotest flaky computing |  [optional] |
+| **flakyTestRunCount** | **kotlin.Int** | Last test run count for autotest flaky computing |  [optional] |
+
+
+
diff --git a/docs/AutoTestProjectSettingsPostModel.md b/docs/AutoTestProjectSettingsPostModel.md
@@ -0,0 +1,14 @@
+
+# AutoTestProjectSettingsPostModel
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **rerunEnabled** | **kotlin.Boolean** | Auto rerun enabled |  |
+| **rerunAttemptsCount** | **kotlin.Int** | Auto rerun attempt count |  |
+| **isFlakyAuto** | **kotlin.Boolean** | Indicates if the status \&quot;Flaky/Stable\&quot; sets automatically |  [optional] |
+| **flakyStabilityPercentage** | **kotlin.Int** | Stability percentage for autotest flaky computing |  [optional] |
+| **flakyTestRunCount** | **kotlin.Int** | Last test run count for autotest flaky computing |  [optional] |
+
+
+
diff --git a/docs/AutotestResultReasonSubGetModel.md → docs/AutoTestResultReasonShort.md b/docs/AutotestResultReasonSubGetModel.md → docs/AutoTestResultReasonShort.md
@@ -1,5 +1,5 @@
 
-# AutotestResultReasonSubGetModel
+# AutoTestResultReasonShort
 
 ## Properties
 | Name | Type | Description | Notes |

diff --git a/docs/AutoTestStep.md b/docs/AutoTestStep.md
@@ -0,0 +1,12 @@
+
+# AutoTestStep
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **title** | **kotlin.String** | Step name. |  |
+| **description** | **kotlin.String** | Detailed step description. It appears when the step is unfolded. |  [optional] |
+| **steps** | [**kotlin.collections.List&lt;AutoTestStep&gt;**](AutoTestStep.md) | Includes a nested step inside another step. The maximum nesting level is 15. |  [optional] |
+
+
+
diff --git a/docs/AutoTestStepResult.md b/docs/AutoTestStepResult.md
@@ -0,0 +1,19 @@
+
+# AutoTestStepResult
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **title** | **kotlin.String** | The name of the step. |  [optional] |
+| **description** | **kotlin.String** | Description of the step result. |  [optional] |
+| **info** | **kotlin.String** | Extended description of the step result. |  [optional] |
+| **startedOn** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Step start date. |  [optional] |
+| **completedOn** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Step end date. |  [optional] |
+| **duration** | **kotlin.Long** | Expected or actual duration of the test run execution in milliseconds. |  [optional] |
+| **outcome** | [**AvailableTestResultOutcome**](AvailableTestResultOutcome.md) | Specifies the result of the autotest execution. |  [optional] |
+| **stepResults** | [**kotlin.collections.List&lt;AutoTestStepResult&gt;**](AutoTestStepResult.md) | Nested step results. The maximum nesting level is 15. |  [optional] |
+| **attachments** | [**kotlin.collections.List&lt;Attachment&gt;**](Attachment.md) | /// &lt;summary&gt;  Specifies an attachment GUID. Multiple values can be sent.  &lt;/summary&gt; |  [optional] |
+| **parameters** | **kotlin.collections.Map&lt;kotlin.String, kotlin.String&gt;** | \&quot;&lt;b&gt;parameter&lt;/b&gt;\&quot;: \&quot;&lt;b&gt;value&lt;/b&gt;\&quot; pair with arbitrary custom parameters. Multiple parameters can be sent. |  [optional] |
+
+
+
diff --git a/docs/AutoTestStepResultUpdateRequest.md b/docs/AutoTestStepResultUpdateRequest.md
@@ -0,0 +1,19 @@
+
+# AutoTestStepResultUpdateRequest
+
+## Properties
+| Name | Type | Description | Notes |
+| ------------ | ------------- | ------------- | ------------- |
+| **title** | **kotlin.String** | The name of the step. |  [optional] |
+| **description** | **kotlin.String** | Description of the step result. |  [optional] |
+| **info** | **kotlin.String** | Extended description of the step result. |  [optional] |
+| **startedOn** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Step start date. |  [optional] |
+| **completedOn** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Step end date. |  [optional] |
+| **duration** | **kotlin.Long** | Expected or actual duration of the test run execution in milliseconds. |  [optional] |
+| **outcome** | [**AvailableTestResultOutcome**](AvailableTestResultOutcome.md) | Specifies the result of the autotest execution. |  [optional] |
+| **stepResults** | [**kotlin.collections.List&lt;AttachmentPutModelAutoTestStepResultsModel&gt;**](AttachmentPutModelAutoTestStepResultsModel.md) | Nested step results. The maximum nesting level is 15. |  [optional] |
+| **attachments** | [**kotlin.collections.List&lt;AttachmentUpdateRequest&gt;**](AttachmentUpdateRequest.md) | /// &lt;summary&gt;  Specifies an attachment GUID. Multiple values can be sent.  &lt;/summary&gt; |  [optional] |
+| **parameters** | **kotlin.collections.Map&lt;kotlin.String, kotlin.String&gt;** | \&quot;&lt;b&gt;parameter&lt;/b&gt;\&quot;: \&quot;&lt;b&gt;value&lt;/b&gt;\&quot; pair with arbitrary custom parameters. Multiple parameters can be sent. |  [optional] |
+
+
+
diff --git a/docs/AutoTestsApi.md b/docs/AutoTestsApi.md
@@ -19,7 +19,6 @@ All URIs are relative to *http://localhost*
 | [**getAutoTestById**](AutoTestsApi.md#getAutoTestById) | **GET** /api/v2/autoTests/{id} | Get autotest by internal or global ID |
 | [**getAutoTestChronology**](AutoTestsApi.md#getAutoTestChronology) | **GET** /api/v2/autoTests/{id}/chronology | Get autotest chronology |
 | [**getTestRuns**](AutoTestsApi.md#getTestRuns) | **GET** /api/v2/autoTests/{id}/testRuns | Get completed tests runs for autotests |
-| [**getWorkItemResults**](AutoTestsApi.md#getWorkItemResults) | **GET** /api/v2/autoTests/{id}/testResultHistory |  |
 | [**getWorkItemsLinkedToAutoTest**](AutoTestsApi.md#getWorkItemsLinkedToAutoTest) | **GET** /api/v2/autoTests/{id}/workItems | Get work items linked to autotest |
 | [**linkAutoTestToWorkItem**](AutoTestsApi.md#linkAutoTestToWorkItem) | **POST** /api/v2/autoTests/{id}/workItems | Link autotest with work items |
 | [**updateAutoTest**](AutoTestsApi.md#updateAutoTest) | **PUT** /api/v2/autoTests | Update autotest |
@@ -831,81 +830,6 @@ try {
 ### Authorization
 
 
-Configure Bearer or PrivateToken:
-    ApiClient.apiKey["Authorization"] = ""
-    ApiClient.apiKeyPrefix["Authorization"] = ""
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a id="getWorkItemResults"></a>
-# **getWorkItemResults**
-> kotlin.collections.List&lt;TestResultHistoryReportModel&gt; getWorkItemResults(id, from, to, configurationIds, testPlanIds, userIds, outcomes, isAutomated, automated, testRunIds, skip, take, orderBy, searchField, searchValue)
-
-
-
-### Example
-```kotlin
-// Import classes:
-//import ru.testit.kotlin.client.infrastructure.*
-//import ru.testit.kotlin.client.models.*
-
-val apiInstance = AutoTestsApi()
-val id : kotlin.String = id_example // kotlin.String | 
-val from : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Take results from this date
-val to : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Take results until this date
-val configurationIds : kotlin.collections.List<java.util.UUID> =  // kotlin.collections.List<java.util.UUID> | Identifiers of test result configurations
-val testPlanIds : kotlin.collections.List<java.util.UUID> =  // kotlin.collections.List<java.util.UUID> | Identifiers of test plans which contain test results
-val userIds : kotlin.collections.List<java.util.UUID> =  // kotlin.collections.List<java.util.UUID> | Identifiers of users who set test results
-val outcomes : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | List of outcomes of test results
-val isAutomated : kotlin.Boolean = true // kotlin.Boolean | OBSOLETE: Use `Automated` instead
-val automated : kotlin.Boolean = true // kotlin.Boolean | If result must consist of only manual/automated test results
-val testRunIds : kotlin.collections.List<java.util.UUID> =  // kotlin.collections.List<java.util.UUID> | Identifiers of test runs which contain test results
-val skip : kotlin.Int = 56 // kotlin.Int | Amount of items to be skipped (offset)
-val take : kotlin.Int = 56 // kotlin.Int | Amount of items to be taken (limit)
-val orderBy : kotlin.String = orderBy_example // kotlin.String | SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)
-val searchField : kotlin.String = searchField_example // kotlin.String | Property name for searching
-val searchValue : kotlin.String = searchValue_example // kotlin.String | Value for searching
-try {
-    val result : kotlin.collections.List<TestResultHistoryReportModel> = apiInstance.getWorkItemResults(id, from, to, configurationIds, testPlanIds, userIds, outcomes, isAutomated, automated, testRunIds, skip, take, orderBy, searchField, searchValue)
-    println(result)
-} catch (e: ClientException) {
-    println("4xx response calling AutoTestsApi#getWorkItemResults")
-    e.printStackTrace()
-} catch (e: ServerException) {
-    println("5xx response calling AutoTestsApi#getWorkItemResults")
-    e.printStackTrace()
-}
-```
-
-### Parameters
-| **id** | **kotlin.String**|  | |
-| **from** | **java.time.OffsetDateTime**| Take results from this date | [optional] |
-| **to** | **java.time.OffsetDateTime**| Take results until this date | [optional] |
-| **configurationIds** | [**kotlin.collections.List&lt;java.util.UUID&gt;**](java.util.UUID.md)| Identifiers of test result configurations | [optional] |
-| **testPlanIds** | [**kotlin.collections.List&lt;java.util.UUID&gt;**](java.util.UUID.md)| Identifiers of test plans which contain test results | [optional] |
-| **userIds** | [**kotlin.collections.List&lt;java.util.UUID&gt;**](java.util.UUID.md)| Identifiers of users who set test results | [optional] |
-| **outcomes** | [**kotlin.collections.List&lt;kotlin.String&gt;**](kotlin.String.md)| List of outcomes of test results | [optional] |
-| **isAutomated** | **kotlin.Boolean**| OBSOLETE: Use &#x60;Automated&#x60; instead | [optional] |
-| **automated** | **kotlin.Boolean**| If result must consist of only manual/automated test results | [optional] |
-| **testRunIds** | [**kotlin.collections.List&lt;java.util.UUID&gt;**](java.util.UUID.md)| Identifiers of test runs which contain test results | [optional] |
-| **skip** | **kotlin.Int**| Amount of items to be skipped (offset) | [optional] |
-| **take** | **kotlin.Int**| Amount of items to be taken (limit) | [optional] |
-| **orderBy** | **kotlin.String**| SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] |
-| **searchField** | **kotlin.String**| Property name for searching | [optional] |
-| Name | Type | Description  | Notes |
-| ------------- | ------------- | ------------- | ------------- |
-| **searchValue** | **kotlin.String**| Value for searching | [optional] |
-
-### Return type
-
-[**kotlin.collections.List&lt;TestResultHistoryReportModel&gt;**](TestResultHistoryReportModel.md)
-
-### Authorization
-
-
 Configure Bearer or PrivateToken:
     ApiClient.apiKey["Authorization"] = ""
     ApiClient.apiKeyPrefix["Authorization"] = ""