Skip to content

Commit e47e047

Browse files
committed
update
1 parent 07edb73 commit e47e047

381 files changed

Lines changed: 1223 additions & 457 deletions

File tree

Some content is hidden

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

.openapi-generator/FILES

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ docs/AddApiKeyRequest.md
1313
docs/AddApiKeyResponse.md
1414
docs/AddAttribute.md
1515
docs/AddAttributeRequest.md
16-
docs/AddAttributeResponse.md
1716
docs/AddAttributeSchemaOptional.md
1817
docs/AddAttributeSchemaRequired.md
1918
docs/AddCase.md
@@ -380,6 +379,8 @@ docs/SystemManagementApi.md
380379
docs/TagIndexApi.md
381380
docs/Task.md
382381
docs/TaskStatus.md
382+
docs/UpdateAttribute.md
383+
docs/UpdateAttributeRequest.md
383384
docs/UpdateCase.md
384385
docs/UpdateCaseRequest.md
385386
docs/UpdateCaseResponse.md
@@ -506,7 +507,6 @@ src/main/java/com/formkiq/client/model/AddApiKeyRequest.java
506507
src/main/java/com/formkiq/client/model/AddApiKeyResponse.java
507508
src/main/java/com/formkiq/client/model/AddAttribute.java
508509
src/main/java/com/formkiq/client/model/AddAttributeRequest.java
509-
src/main/java/com/formkiq/client/model/AddAttributeResponse.java
510510
src/main/java/com/formkiq/client/model/AddAttributeSchemaOptional.java
511511
src/main/java/com/formkiq/client/model/AddAttributeSchemaRequired.java
512512
src/main/java/com/formkiq/client/model/AddCase.java
@@ -846,6 +846,8 @@ src/main/java/com/formkiq/client/model/StringFormat.java
846846
src/main/java/com/formkiq/client/model/StringGeneratorType.java
847847
src/main/java/com/formkiq/client/model/Task.java
848848
src/main/java/com/formkiq/client/model/TaskStatus.java
849+
src/main/java/com/formkiq/client/model/UpdateAttribute.java
850+
src/main/java/com/formkiq/client/model/UpdateAttributeRequest.java
849851
src/main/java/com/formkiq/client/model/UpdateCase.java
850852
src/main/java/com/formkiq/client/model/UpdateCaseRequest.java
851853
src/main/java/com/formkiq/client/model/UpdateCaseResponse.java
@@ -936,7 +938,6 @@ src/test/java/com/formkiq/client/model/AddActionTest.java
936938
src/test/java/com/formkiq/client/model/AddApiKeyRequestTest.java
937939
src/test/java/com/formkiq/client/model/AddApiKeyResponseTest.java
938940
src/test/java/com/formkiq/client/model/AddAttributeRequestTest.java
939-
src/test/java/com/formkiq/client/model/AddAttributeResponseTest.java
940941
src/test/java/com/formkiq/client/model/AddAttributeSchemaOptionalTest.java
941942
src/test/java/com/formkiq/client/model/AddAttributeSchemaRequiredTest.java
942943
src/test/java/com/formkiq/client/model/AddAttributeTest.java
@@ -1277,6 +1278,8 @@ src/test/java/com/formkiq/client/model/StringFormatTest.java
12771278
src/test/java/com/formkiq/client/model/StringGeneratorTypeTest.java
12781279
src/test/java/com/formkiq/client/model/TaskStatusTest.java
12791280
src/test/java/com/formkiq/client/model/TaskTest.java
1281+
src/test/java/com/formkiq/client/model/UpdateAttributeRequestTest.java
1282+
src/test/java/com/formkiq/client/model/UpdateAttributeTest.java
12801283
src/test/java/com/formkiq/client/model/UpdateCaseRequestTest.java
12811284
src/test/java/com/formkiq/client/model/UpdateCaseResponseTest.java
12821285
src/test/java/com/formkiq/client/model/UpdateCaseTest.java

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ Class | Method | HTTP request | Description
196196
*AttributesApi* | [**getAttribute**](docs/AttributesApi.md#getAttribute) | **GET** /attributes/{key} | Get Attribute
197197
*AttributesApi* | [**getAttributeAllowedValues**](docs/AttributesApi.md#getAttributeAllowedValues) | **GET** /attributes/{key}/allowedValues | Get Attribute Allowed Values
198198
*AttributesApi* | [**getAttributes**](docs/AttributesApi.md#getAttributes) | **GET** /attributes | Get Attributes listing
199+
*AttributesApi* | [**updateAttribute**](docs/AttributesApi.md#updateAttribute) | **PATCH** /attributes/{key} | Update existing attribute
199200
*CaseManagementApi* | [**addCase**](docs/CaseManagementApi.md#addCase) | **POST** /cases | Add New Case
200201
*CaseManagementApi* | [**addNigo**](docs/CaseManagementApi.md#addNigo) | **POST** /cases/{caseId}/nigos | Add New Nigo
201202
*CaseManagementApi* | [**addTask**](docs/CaseManagementApi.md#addTask) | **POST** /cases/{caseId}/tasks | Add New Task
@@ -388,7 +389,6 @@ Class | Method | HTTP request | Description
388389
- [AddApiKeyResponse](docs/AddApiKeyResponse.md)
389390
- [AddAttribute](docs/AddAttribute.md)
390391
- [AddAttributeRequest](docs/AddAttributeRequest.md)
391-
- [AddAttributeResponse](docs/AddAttributeResponse.md)
392392
- [AddAttributeSchemaOptional](docs/AddAttributeSchemaOptional.md)
393393
- [AddAttributeSchemaRequired](docs/AddAttributeSchemaRequired.md)
394394
- [AddCase](docs/AddCase.md)
@@ -728,6 +728,8 @@ Class | Method | HTTP request | Description
728728
- [StringGeneratorType](docs/StringGeneratorType.md)
729729
- [Task](docs/Task.md)
730730
- [TaskStatus](docs/TaskStatus.md)
731+
- [UpdateAttribute](docs/UpdateAttribute.md)
732+
- [UpdateAttributeRequest](docs/UpdateAttributeRequest.md)
731733
- [UpdateCase](docs/UpdateCase.md)
732734
- [UpdateCaseRequest](docs/UpdateCaseRequest.md)
733735
- [UpdateCaseResponse](docs/UpdateCaseResponse.md)

api/openapi.yaml

Lines changed: 96 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3832,7 +3832,7 @@ paths:
38323832
content:
38333833
application/json:
38343834
schema:
3835-
$ref: '#/components/schemas/AddAttributeResponse'
3835+
$ref: '#/components/schemas/AddResponse'
38363836
description: 201 CREATED
38373837
headers:
38383838
Access-Control-Allow-Origin:
@@ -3950,6 +3950,62 @@ paths:
39503950
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
39513951
x-accepts:
39523952
- application/json
3953+
patch:
3954+
description: Updates existing attribute
3955+
operationId: UpdateAttribute
3956+
parameters:
3957+
- description: Site Identifier
3958+
explode: true
3959+
in: query
3960+
name: siteId
3961+
required: false
3962+
schema:
3963+
type: string
3964+
style: form
3965+
- description: Key Identifier
3966+
explode: false
3967+
in: path
3968+
name: key
3969+
required: true
3970+
schema:
3971+
type: string
3972+
style: simple
3973+
requestBody:
3974+
content:
3975+
application/json:
3976+
schema:
3977+
$ref: '#/components/schemas/UpdateAttributeRequest'
3978+
required: true
3979+
responses:
3980+
"200":
3981+
content:
3982+
application/json:
3983+
schema:
3984+
$ref: '#/components/schemas/UpdateResponse'
3985+
description: 200 OK
3986+
headers:
3987+
Access-Control-Allow-Origin:
3988+
$ref: '#/components/headers/AccessControlAllowOrigin'
3989+
Access-Control-Allow-Methods:
3990+
$ref: '#/components/headers/AccessControlAllowMethods'
3991+
Access-Control-Allow-Headers:
3992+
$ref: '#/components/headers/AccessControlAllowHeaders'
3993+
"400":
3994+
content:
3995+
application/json:
3996+
schema:
3997+
$ref: '#/components/schemas/ValidationErrorsResponse'
3998+
description: 400 OK
3999+
security:
4000+
- ApiAuthorization: []
4001+
summary: Update existing attribute
4002+
tags:
4003+
- Attributes
4004+
x-amazon-apigateway-integration:
4005+
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
4006+
x-content-type: application/json
4007+
x-accepts:
4008+
- application/json
39534009
/attributes/{key}/allowedValues:
39544010
get:
39554011
description: Returns an attribute's allowed values that spans across all classifications
@@ -18116,6 +18172,45 @@ components:
1811618172
- WATERMARK
1811718173
- ENTITY
1811818174
type: string
18175+
UpdateAttributeRequest:
18176+
example:
18177+
attribute:
18178+
watermark:
18179+
imageDocumentId: imageDocumentId
18180+
rotation: 0.8008281904610115
18181+
scale: FIT_BEST
18182+
text: text
18183+
position:
18184+
yOffset: 1.4658129805029452
18185+
xOffset: 6.027456183070403
18186+
yAnchor: TOP
18187+
xAnchor: LEFT
18188+
type: STANDARD
18189+
properties:
18190+
attribute:
18191+
$ref: '#/components/schemas/UpdateAttribute'
18192+
required:
18193+
- attribute
18194+
type: object
18195+
UpdateAttribute:
18196+
example:
18197+
watermark:
18198+
imageDocumentId: imageDocumentId
18199+
rotation: 0.8008281904610115
18200+
scale: FIT_BEST
18201+
text: text
18202+
position:
18203+
yOffset: 1.4658129805029452
18204+
xOffset: 6.027456183070403
18205+
yAnchor: TOP
18206+
xAnchor: LEFT
18207+
type: STANDARD
18208+
properties:
18209+
type:
18210+
$ref: '#/components/schemas/AttributeType'
18211+
watermark:
18212+
$ref: '#/components/schemas/Watermark'
18213+
type: object
1811918214
AddAttributeRequest:
1812018215
example:
1812118216
attribute:
@@ -18166,14 +18261,6 @@ components:
1816618261
required:
1816718262
- key
1816818263
type: object
18169-
AddAttributeResponse:
18170-
example:
18171-
message: message
18172-
properties:
18173-
message:
18174-
description: Response Message
18175-
type: string
18176-
type: object
1817718264
GetDocumentsResponse:
1817818265
example:
1817918266
next: next

docs/AttributesApi.md

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ All URIs are relative to *http://localhost*
99
| [**getAttribute**](AttributesApi.md#getAttribute) | **GET** /attributes/{key} | Get Attribute |
1010
| [**getAttributeAllowedValues**](AttributesApi.md#getAttributeAllowedValues) | **GET** /attributes/{key}/allowedValues | Get Attribute Allowed Values |
1111
| [**getAttributes**](AttributesApi.md#getAttributes) | **GET** /attributes | Get Attributes listing |
12+
| [**updateAttribute**](AttributesApi.md#updateAttribute) | **PATCH** /attributes/{key} | Update existing attribute |
1213

1314

1415
<a id="addAttribute"></a>
1516
# **addAttribute**
16-
> AddAttributeResponse addAttribute(addAttributeRequest, siteId)
17+
> AddResponse addAttribute(addAttributeRequest, siteId)
1718
1819
Add new attribute
1920

@@ -40,7 +41,7 @@ public class Example {
4041
AddAttributeRequest addAttributeRequest = new AddAttributeRequest(); // AddAttributeRequest |
4142
String siteId = "siteId_example"; // String | Site Identifier
4243
try {
43-
AddAttributeResponse result = apiInstance.addAttribute(addAttributeRequest, siteId);
44+
AddResponse result = apiInstance.addAttribute(addAttributeRequest, siteId);
4445
System.out.println(result);
4546
} catch (ApiException e) {
4647
System.err.println("Exception when calling AttributesApi#addAttribute");
@@ -62,7 +63,7 @@ public class Example {
6263

6364
### Return type
6465

65-
[**AddAttributeResponse**](AddAttributeResponse.md)
66+
[**AddResponse**](AddResponse.md)
6667

6768
### Authorization
6869

@@ -350,3 +351,73 @@ No authorization required
350351
|-------------|-------------|------------------|
351352
| **200** | 200 OK | * Access-Control-Allow-Origin - <br> * Access-Control-Allow-Methods - <br> * Access-Control-Allow-Headers - <br> |
352353

354+
<a id="updateAttribute"></a>
355+
# **updateAttribute**
356+
> UpdateResponse updateAttribute(key, updateAttributeRequest, siteId)
357+
358+
Update existing attribute
359+
360+
Updates existing attribute
361+
362+
### Example
363+
```java
364+
// Import classes:
365+
import com.formkiq.client.invoker.ApiClient;
366+
import com.formkiq.client.invoker.ApiException;
367+
import com.formkiq.client.invoker.Configuration;
368+
import com.formkiq.client.invoker.auth.*;
369+
import com.formkiq.client.invoker.models.*;
370+
import com.formkiq.client.api.AttributesApi;
371+
372+
public class Example {
373+
public static void main(String[] args) {
374+
ApiClient defaultClient = Configuration.getDefaultApiClient();
375+
defaultClient.setBasePath("http://localhost");
376+
// Configure AWS Signature V4 authorization
377+
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
378+
379+
AttributesApi apiInstance = new AttributesApi(defaultClient);
380+
String key = "key_example"; // String | Key Identifier
381+
UpdateAttributeRequest updateAttributeRequest = new UpdateAttributeRequest(); // UpdateAttributeRequest |
382+
String siteId = "siteId_example"; // String | Site Identifier
383+
try {
384+
UpdateResponse result = apiInstance.updateAttribute(key, updateAttributeRequest, siteId);
385+
System.out.println(result);
386+
} catch (ApiException e) {
387+
System.err.println("Exception when calling AttributesApi#updateAttribute");
388+
System.err.println("Status code: " + e.getCode());
389+
System.err.println("Reason: " + e.getResponseBody());
390+
System.err.println("Response headers: " + e.getResponseHeaders());
391+
e.printStackTrace();
392+
}
393+
}
394+
}
395+
```
396+
397+
### Parameters
398+
399+
| Name | Type | Description | Notes |
400+
|------------- | ------------- | ------------- | -------------|
401+
| **key** | **String**| Key Identifier | |
402+
| **updateAttributeRequest** | [**UpdateAttributeRequest**](UpdateAttributeRequest.md)| | |
403+
| **siteId** | **String**| Site Identifier | [optional] |
404+
405+
### Return type
406+
407+
[**UpdateResponse**](UpdateResponse.md)
408+
409+
### Authorization
410+
411+
No authorization required
412+
413+
### HTTP request headers
414+
415+
- **Content-Type**: application/json
416+
- **Accept**: application/json
417+
418+
### HTTP response details
419+
| Status code | Description | Response headers |
420+
|-------------|-------------|------------------|
421+
| **200** | 200 OK | * Access-Control-Allow-Origin - <br> * Access-Control-Allow-Methods - <br> * Access-Control-Allow-Headers - <br> |
422+
| **400** | 400 OK | - |
423+

docs/UpdateAttribute.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# UpdateAttribute
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**type** | **AttributeType** | | [optional] |
11+
|**watermark** | [**Watermark**](Watermark.md) | | [optional] |
12+
13+
14+

docs/UpdateAttributeRequest.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# UpdateAttributeRequest
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**attribute** | [**UpdateAttribute**](UpdateAttribute.md) | | |
11+
12+
13+

0 commit comments

Comments
 (0)