Skip to content

Commit 2a95fe3

Browse files
gibiwgibiw
committed
chore: update API documentation and models for attachments and results
- Enhanced documentation for AttachmentsApi, CasesApi, ResultsApi, and RunsApi. - Updated models related to attachments, results, and test cases to reflect new properties and structures. - Added new UuidResponse model to support UUID responses in the API.
1 parent 2218009 commit 2a95fe3

File tree

201 files changed

+6667
-401
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+6667
-401
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.4",
41+
"version": "1.1.5",
4242
"scripts": {
4343
"test": "phpunit"
4444
},

‎composer.lock‎

Lines changed: 107 additions & 63 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/Api/UsersApi.md‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Qase\APIClientV1\UsersApi
2+
3+
All URIs are relative to https://api.qase.io/v1, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**getUser()**](UsersApi.md#getUser) | **GET** /user/{id} | Get a specific user. |
8+
| [**getUsers()**](UsersApi.md#getUsers) | **GET** /user | Get all users. |
9+
10+
11+
## `getUser()`
12+
13+
```php
14+
getUser($id): \Qase\APIClientV1\Model\UserResponse
15+
```
16+
17+
Get a specific user.
18+
19+
This method allows to retrieve a specific user.
20+
21+
### Example
22+
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
28+
// Configure API key authorization: TokenAuth
29+
$config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKey('Token', 'YOUR_API_KEY');
30+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
31+
// $config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Token', 'Bearer');
32+
33+
34+
$apiInstance = new Qase\APIClientV1\Api\UsersApi(
35+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
36+
// This is optional, `GuzzleHttp\Client` will be used as default.
37+
new GuzzleHttp\Client(),
38+
$config
39+
);
40+
$id = 56; // int | Identifier.
41+
42+
try {
43+
$result = $apiInstance->getUser($id);
44+
print_r($result);
45+
} catch (Exception $e) {
46+
echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL;
47+
}
48+
```
49+
50+
### Parameters
51+
52+
| Name | Type | Description | Notes |
53+
| ------------- | ------------- | ------------- | ------------- |
54+
| **id** | **int**| Identifier. | |
55+
56+
### Return type
57+
58+
[**\Qase\APIClientV1\Model\UserResponse**](../Model/UserResponse.md)
59+
60+
### Authorization
61+
62+
[TokenAuth](../../README.md#TokenAuth)
63+
64+
### HTTP request headers
65+
66+
- **Content-Type**: Not defined
67+
- **Accept**: `application/json`
68+
69+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
70+
[[Back to Model list]](../../README.md#models)
71+
[[Back to README]](../../README.md)
72+
73+
## `getUsers()`
74+
75+
```php
76+
getUsers($limit, $offset): \Qase\APIClientV1\Model\UserListResponse
77+
```
78+
79+
Get all users.
80+
81+
This method allows to retrieve all users.
82+
83+
### Example
84+
85+
```php
86+
<?php
87+
require_once(__DIR__ . '/vendor/autoload.php');
88+
89+
90+
// Configure API key authorization: TokenAuth
91+
$config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKey('Token', 'YOUR_API_KEY');
92+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
93+
// $config = Qase\APIClientV1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Token', 'Bearer');
94+
95+
96+
$apiInstance = new Qase\APIClientV1\Api\UsersApi(
97+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
98+
// This is optional, `GuzzleHttp\Client` will be used as default.
99+
new GuzzleHttp\Client(),
100+
$config
101+
);
102+
$limit = 10; // int | A number of entities in result set.
103+
$offset = 0; // int | How many entities should be skipped.
104+
105+
try {
106+
$result = $apiInstance->getUsers($limit, $offset);
107+
print_r($result);
108+
} catch (Exception $e) {
109+
echo 'Exception when calling UsersApi->getUsers: ', $e->getMessage(), PHP_EOL;
110+
}
111+
```
112+
113+
### Parameters
114+
115+
| Name | Type | Description | Notes |
116+
| ------------- | ------------- | ------------- | ------------- |
117+
| **limit** | **int**| A number of entities in result set. | [optional] [default to 10] |
118+
| **offset** | **int**| How many entities should be skipped. | [optional] [default to 0] |
119+
120+
### Return type
121+
122+
[**\Qase\APIClientV1\Model\UserListResponse**](../Model/UserListResponse.md)
123+
124+
### Authorization
125+
126+
[TokenAuth](../../README.md#TokenAuth)
127+
128+
### HTTP request headers
129+
130+
- **Content-Type**: Not defined
131+
- **Accept**: `application/json`
132+
133+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
134+
[[Back to Model list]](../../README.md#models)
135+
[[Back to README]](../../README.md)

‎docs/Model/User.md‎

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

‎docs/Model/UserListResponse.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # UserListResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **bool** | | [optional]
8+
**result** | [**\Qase\APIClientV1\Model\UserListResponseAllOfResult**](UserListResponseAllOfResult.md) | | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/UserListResponseAllOfResult.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # UserListResponseAllOfResult
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **int** | | [optional]
8+
**filtered** | **int** | | [optional]
9+
**count** | **int** | | [optional]
10+
**entities** | [**\Qase\APIClientV1\Model\User[]**](User.md) | | [optional]
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/UserResponse.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # UserResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **bool** | | [optional]
8+
**result** | [**\Qase\APIClientV1\Model\User**](User.md) | | [optional]
9+
10+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

0 commit comments

Comments
 (0)