Skip to content

Commit 5dd4ed3

Browse files
gibiwgibiw
committed
chore: update API client and documentation for new run features
- Bumped version in composer.json to 1.1.1. - Added new endpoints `runUpdateExternalIssue` and `updateRun` to the RunsApi. - Updated documentation for RunsApi to include new methods and parameters. - Introduced new models: RunExternalIssue, RunexternalIssues, RunexternalIssuesLinksInner, and Runupdate. - Enhanced Run model to include configurations and externalIssue properties. - Removed authorId from TestCasebulkCasesInner and TestCaseCreate models.
1 parent b95e43b commit 5dd4ed3

17 files changed

+3062
-91
lines changed

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"Tests\\": "test/"
3939
}
4040
},
41-
"version": "1.1.0",
41+
"version": "1.1.1",
4242
"scripts": {
4343
"test": "phpunit"
4444
},

‎docs/Api/RunsApi.md‎

Lines changed: 135 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ All URIs are relative to https://api.qase.io/v1, except if the operation defines
99
| [**deleteRun()**](RunsApi.md#deleteRun) | **DELETE** /run/{code}/{id} | Delete run |
1010
| [**getRun()**](RunsApi.md#getRun) | **GET** /run/{code}/{id} | Get a specific run |
1111
| [**getRuns()**](RunsApi.md#getRuns) | **GET** /run/{code} | Get all runs |
12+
| [**runUpdateExternalIssue()**](RunsApi.md#runUpdateExternalIssue) | **POST** /run/{code}/external-issue | Update external issues for runs |
13+
| [**updateRun()**](RunsApi.md#updateRun) | **PATCH** /run/{code}/{id} | Update a specific run |
1214
| [**updateRunPublicity()**](RunsApi.md#updateRunPublicity) | **PATCH** /run/{code}/{id}/public | Update publicity of a specific run |
1315

1416

@@ -235,7 +237,7 @@ $apiInstance = new Qase\APIClientV1\Api\RunsApi(
235237
);
236238
$code = 'code_example'; // string | Code of project, where to search entities.
237239
$id = 56; // int | Identifier.
238-
$include = 'include_example'; // string | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects
240+
$include = 'include_example'; // string | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue
239241

240242
try {
241243
$result = $apiInstance->getRun($code, $id, $include);
@@ -251,7 +253,7 @@ try {
251253
| ------------- | ------------- | ------------- | ------------- |
252254
| **code** | **string**| Code of project, where to search entities. | |
253255
| **id** | **int**| Identifier. | |
254-
| **include** | **string**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects | [optional] |
256+
| **include** | **string**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue | [optional] |
255257

256258
### Return type
257259

@@ -308,7 +310,7 @@ $fromStartTime = 56; // int
308310
$toStartTime = 56; // int
309311
$limit = 10; // int | A number of entities in result set.
310312
$offset = 0; // int | How many entities should be skipped.
311-
$include = 'include_example'; // string | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects
313+
$include = 'include_example'; // string | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue
312314

313315
try {
314316
$result = $apiInstance->getRuns($code, $search, $status, $milestone, $environment, $fromStartTime, $toStartTime, $limit, $offset, $include);
@@ -331,7 +333,7 @@ try {
331333
| **toStartTime** | **int**| | [optional] |
332334
| **limit** | **int**| A number of entities in result set. | [optional] [default to 10] |
333335
| **offset** | **int**| How many entities should be skipped. | [optional] [default to 0] |
334-
| **include** | **string**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects | [optional] |
336+
| **include** | **string**| Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects, external_issue | [optional] |
335337

336338
### Return type
337339

@@ -350,6 +352,135 @@ try {
350352
[[Back to Model list]](../../README.md#models)
351353
[[Back to README]](../../README.md)
352354

355+
## `runUpdateExternalIssue()`
356+
357+
```php
358+
runUpdateExternalIssue($code, $runexternalIssues)
359+
```
360+
361+
Update external issues for runs
362+
363+
This method allows you to update links between test runs and external issues (such as Jira tickets). You can use this endpoint to: - Link test runs to external issues by providing the external issue identifier (e.g., \"PROJ-1234\") - Update existing links by providing a new external issue identifier - Remove existing links by setting the external_issue field to null **Important**: Each test run can have only one link with an external issue. If a test run already has an external issue link, providing a new external_issue value will replace the existing link. The endpoint supports both Jira Cloud and Jira Server integrations. Each request can update multiple test run links in a single operation.
364+
365+
### Example
366+
367+
```php
368+
<?php
369+
require_once(__DIR__ . '/vendor/autoload.php');
370+
371+
372+
// Configure API key authorization: TokenAuth
373+
$config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKey('Token', 'YOUR_API_KEY');
374+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
375+
// $config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Token', 'Bearer');
376+
377+
378+
$apiInstance = new Qase\APIClientV1\Api\RunsApi(
379+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
380+
// This is optional, `GuzzleHttp\Client` will be used as default.
381+
new GuzzleHttp\Client(),
382+
$config
383+
);
384+
$code = 'code_example'; // string | Code of project, where to search entities.
385+
$runexternalIssues = new \Qase\APIClientV1\Model\RunexternalIssues(); // \Qase\APIClientV1\Model\RunexternalIssues
386+
387+
try {
388+
$apiInstance->runUpdateExternalIssue($code, $runexternalIssues);
389+
} catch (Exception $e) {
390+
echo 'Exception when calling RunsApi->runUpdateExternalIssue: ', $e->getMessage(), PHP_EOL;
391+
}
392+
```
393+
394+
### Parameters
395+
396+
| Name | Type | Description | Notes |
397+
| ------------- | ------------- | ------------- | ------------- |
398+
| **code** | **string**| Code of project, where to search entities. | |
399+
| **runexternalIssues** | [**\Qase\APIClientV1\Model\RunexternalIssues**](../Model/RunexternalIssues.md)| | |
400+
401+
### Return type
402+
403+
void (empty response body)
404+
405+
### Authorization
406+
407+
[TokenAuth](../../README.md#TokenAuth)
408+
409+
### HTTP request headers
410+
411+
- **Content-Type**: `application/json`
412+
- **Accept**: Not defined
413+
414+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
415+
[[Back to Model list]](../../README.md#models)
416+
[[Back to README]](../../README.md)
417+
418+
## `updateRun()`
419+
420+
```php
421+
updateRun($code, $id, $runupdate): \Qase\APIClientV1\Model\BaseResponse
422+
```
423+
424+
Update a specific run
425+
426+
This method allows to update a specific run.
427+
428+
### Example
429+
430+
```php
431+
<?php
432+
require_once(__DIR__ . '/vendor/autoload.php');
433+
434+
435+
// Configure API key authorization: TokenAuth
436+
$config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKey('Token', 'YOUR_API_KEY');
437+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
438+
// $config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Token', 'Bearer');
439+
440+
441+
$apiInstance = new Qase\APIClientV1\Api\RunsApi(
442+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
443+
// This is optional, `GuzzleHttp\Client` will be used as default.
444+
new GuzzleHttp\Client(),
445+
$config
446+
);
447+
$code = 'code_example'; // string | Code of project, where to search entities.
448+
$id = 56; // int | Identifier.
449+
$runupdate = new \Qase\APIClientV1\Model\Runupdate(); // \Qase\APIClientV1\Model\Runupdate
450+
451+
try {
452+
$result = $apiInstance->updateRun($code, $id, $runupdate);
453+
print_r($result);
454+
} catch (Exception $e) {
455+
echo 'Exception when calling RunsApi->updateRun: ', $e->getMessage(), PHP_EOL;
456+
}
457+
```
458+
459+
### Parameters
460+
461+
| Name | Type | Description | Notes |
462+
| ------------- | ------------- | ------------- | ------------- |
463+
| **code** | **string**| Code of project, where to search entities. | |
464+
| **id** | **int**| Identifier. | |
465+
| **runupdate** | [**\Qase\APIClientV1\Model\Runupdate**](../Model/Runupdate.md)| | |
466+
467+
### Return type
468+
469+
[**\Qase\APIClientV1\Model\BaseResponse**](../Model/BaseResponse.md)
470+
471+
### Authorization
472+
473+
[TokenAuth](../../README.md#TokenAuth)
474+
475+
### HTTP request headers
476+
477+
- **Content-Type**: `application/json`
478+
- **Accept**: `application/json`
479+
480+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
481+
[[Back to Model list]](../../README.md#models)
482+
[[Back to README]](../../README.md)
483+
353484
## `updateRunPublicity()`
354485

355486
```php

‎docs/Model/Run.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,7 @@ Name | Type | Description | Notes
2222
**tags** | [**\Qase\APIClientV1\Model\TagValue[]**](TagValue.md) | | [optional]
2323
**cases** | **int[]** | | [optional]
2424
**planId** | **int** | | [optional]
25+
**configurations** | **int[]** | | [optional]
26+
**externalIssue** | [**\Qase\APIClientV1\Model\RunExternalIssue**](RunExternalIssue.md) | | [optional]
2527

2628
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/RunExternalIssue.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # RunExternalIssue
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **string** | | [optional]
8+
**type** | **string** | | [optional]
9+
**link** | **string** | | [optional]
10+
11+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/RunexternalIssues.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # RunexternalIssues
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**type** | **string** | |
8+
**links** | [**\Qase\APIClientV1\Model\RunexternalIssuesLinksInner[]**](RunexternalIssuesLinksInner.md) | Array of external issue links. Each test run (run_id) can have only one external issue link. |
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/RunexternalIssuesLinksInner.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # RunexternalIssuesLinksInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**runId** | **int** | |
8+
**externalIssue** | **string** | An external issue identifier, e.g. \&quot;PROJ-1234\&quot;. Or null if you want to remove the link. | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/Runupdate.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# # Runupdate
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**title** | **string** | | [optional]
8+
**description** | **string** | | [optional]
9+
**environmentId** | **int** | | [optional]
10+
**environmentSlug** | **string** | | [optional]
11+
**milestoneId** | **int** | | [optional]
12+
**tags** | **string[]** | | [optional]
13+
**configurations** | **int[]** | | [optional]
14+
**customField** | **array<string,string>** | A map of custom fields values (id &#x3D;&gt; value) | [optional]
15+
16+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/TestCaseCreate.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
1414
**type** | **int** | | [optional]
1515
**layer** | **int** | | [optional]
1616
**isFlaky** | **int** | | [optional]
17-
**authorId** | **int** | | [optional]
1817
**suiteId** | **int** | | [optional]
1918
**milestoneId** | **int** | | [optional]
2019
**automation** | **int** | | [optional]

‎docs/Model/TestCasebulkCasesInner.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
1414
**type** | **int** | | [optional]
1515
**layer** | **int** | | [optional]
1616
**isFlaky** | **int** | | [optional]
17-
**authorId** | **int** | | [optional]
1817
**suiteId** | **int** | | [optional]
1918
**milestoneId** | **int** | | [optional]
2019
**automation** | **int** | | [optional]

0 commit comments

Comments
 (0)