Add minor fix to asyncStateId, and empty CommandRequest (#3)

* Add minor fix to asyncStateId, and empty CommandRequest

* Fix status code

* gen file

api-schema/xdb.yaml

@@ -27,6 +27,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ApiErrorResponse'
+        '409':
+          description: Process already started
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiErrorResponse'                
   # xdb workers APIs are hosted by iWF applications via SDKs, for iWF server to call back
   /api/v1/xdb/worker/async-state/wait-until:
     post:
@@ -43,12 +49,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/AsyncStateWaitUntilResponse'
-        '400':
-          description: Invalid input
+        default:
+          description: worker execution failure
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/WorkerErrorResponse'
+                $ref: '#/components/schemas/WorkerErrorResponse'              
   /api/v1/xdb/worker/async-state/execute:
     post:
       summary: "invoking AsyncState.execute API"
@@ -64,8 +70,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/AsyncStateExecuteResponse'
-        '400':
-          description: Invalid input
+        default:
+          description: worker execution failure
           content:
             application/json:
               schema:
@@ -81,7 +87,7 @@ components:
           $ref: '#/components/schemas/Context'
         processType:
           type: string
-        asyncStateId:
+        stateId:
           type: string
         stateInput:
           $ref: '#/components/schemas/EncodedObject'
@@ -93,6 +99,15 @@ components:
           $ref: '#/components/schemas/CommandRequest'
     CommandRequest:
       type: object
+      properties: 
+        waitingType: 
+          $ref: '#/components/schemas/CommandWaitingType'
+    CommandWaitingType:
+      type: string
+      enum:
+        - EmptyCommand # default value, which means not waiting for anything
+        - AnyOfCompletion
+        - AllOfCompletion
     AsyncStateExecuteRequest:
       type: object
       description: the input of the execute API
@@ -188,22 +203,12 @@ components:
       properties:
         detail:
           type: string
-        subStatus:
-          $ref: '#/components/schemas/ErrorSubStatus'
         originalWorkerErrorDetail:
           type: string
         originalWorkerErrorType:
           type: string
         originalWorkerErrorStatus:
           type: integer
-    ErrorSubStatus:
-      type: string
-      enum:
-        - UNCATEGORIZED_SUB_STATUS
-        - EXECUTION_ALREADY_STARTED_SUB_STATUS
-        - EXECUTION_NOT_EXISTS_SUB_STATUS
-        - WORKER_API_ERROR
-        - LONG_POLL_TIME_OUT_SUB_STATUS
     ProcessExecutionStartRequest:
       type: object
       description: the request for starting an process execution

goapi/xdbapi/.openapi-generator/FILES

@@ -12,10 +12,11 @@ docs/AsyncStateExecuteRequest.md
 docs/AsyncStateExecuteResponse.md
 docs/AsyncStateWaitUntilRequest.md
 docs/AsyncStateWaitUntilResponse.md
+docs/CommandRequest.md
+docs/CommandWaitingType.md
 docs/Context.md
 docs/DefaultApi.md
 docs/EncodedObject.md
-docs/ErrorSubStatus.md
 docs/ProcessExecutionStartRequest.md
 docs/ProcessExecutionStartResponse.md
 docs/ProcessIdReusePolicy.md
@@ -34,9 +35,10 @@ model_async_state_execute_request.go
 model_async_state_execute_response.go
 model_async_state_wait_until_request.go
 model_async_state_wait_until_response.go
+model_command_request.go
+model_command_waiting_type.go
 model_context.go
 model_encoded_object.go
-model_error_sub_status.go
 model_process_execution_start_request.go
 model_process_execution_start_response.go
 model_process_id_reuse_policy.go

goapi/xdbapi/README.md

@@ -90,9 +90,10 @@ Class | Method | HTTP request | Description
  - [AsyncStateExecuteResponse](docs/AsyncStateExecuteResponse.md)
  - [AsyncStateWaitUntilRequest](docs/AsyncStateWaitUntilRequest.md)
  - [AsyncStateWaitUntilResponse](docs/AsyncStateWaitUntilResponse.md)
+ - [CommandRequest](docs/CommandRequest.md)
+ - [CommandWaitingType](docs/CommandWaitingType.md)
  - [Context](docs/Context.md)
  - [EncodedObject](docs/EncodedObject.md)
- - [ErrorSubStatus](docs/ErrorSubStatus.md)
  - [ProcessExecutionStartRequest](docs/ProcessExecutionStartRequest.md)
  - [ProcessExecutionStartResponse](docs/ProcessExecutionStartResponse.md)
  - [ProcessIdReusePolicy](docs/ProcessIdReusePolicy.md)

goapi/xdbapi/api/openapi.yaml

@@ -26,6 +26,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/ApiErrorResponse'
           description: Invalid request
+        "409":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiErrorResponse'
+          description: Process already started
       summary: start a process execution
   /api/v1/xdb/worker/async-state/wait-until:
     post:
@@ -41,12 +47,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/AsyncStateWaitUntilResponse'
           description: successful operation
-        "400":
+        default:
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/WorkerErrorResponse'
-          description: Invalid input
+          description: worker execution failure
       summary: invoking AsyncState.waitUntil API
   /api/v1/xdb/worker/async-state/execute:
     post:
@@ -62,19 +68,19 @@ paths:
               schema:
                 $ref: '#/components/schemas/AsyncStateExecuteResponse'
           description: successful operation
-        "400":
+        default:
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/WorkerErrorResponse'
-          description: Invalid input
+          description: worker execution failure
       summary: invoking AsyncState.execute API
 components:
   schemas:
     AsyncStateWaitUntilRequest:
       description: the input of the waitUntil API
       example:
-        asyncStateId: asyncStateId
+        stateId: stateId
         context:
           processStartedTimestamp: 0
           processExecutionId: processExecutionId
@@ -91,21 +97,33 @@ components:
           $ref: '#/components/schemas/Context'
         processType:
           type: string
-        asyncStateId:
+        stateId:
           type: string
         stateInput:
           $ref: '#/components/schemas/EncodedObject'
       type: object
     AsyncStateWaitUntilResponse:
       description: the output of the waitUntil API
       example:
-        commandRequest: "{}"
+        commandRequest:
+          waitingType: null
       properties:
         commandRequest:
-          type: object
+          $ref: '#/components/schemas/CommandRequest'
       type: object
     CommandRequest:
+      example:
+        waitingType: null
+      properties:
+        waitingType:
+          $ref: '#/components/schemas/CommandWaitingType'
       type: object
+    CommandWaitingType:
+      enum:
+      - EmptyCommand
+      - AnyOfCompletion
+      - AllOfCompletion
+      type: string
     AsyncStateExecuteRequest:
       description: the input of the execute API
       example:
@@ -275,23 +293,13 @@ components:
       properties:
         detail:
           type: string
-        subStatus:
-          $ref: '#/components/schemas/ErrorSubStatus'
         originalWorkerErrorDetail:
           type: string
         originalWorkerErrorType:
           type: string
         originalWorkerErrorStatus:
           type: integer
       type: object
-    ErrorSubStatus:
-      enum:
-      - UNCATEGORIZED_SUB_STATUS
-      - EXECUTION_ALREADY_STARTED_SUB_STATUS
-      - EXECUTION_NOT_EXISTS_SUB_STATUS
-      - WORKER_API_ERROR
-      - LONG_POLL_TIME_OUT_SUB_STATUS
-      type: string
     ProcessExecutionStartRequest:
       description: the request for starting an process execution
       example:

goapi/xdbapi/docs/ApiErrorResponse.md

@@ -5,7 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Detail** | Pointer to **string** |  | [optional] 
-**SubStatus** | Pointer to [**ErrorSubStatus**](ErrorSubStatus.md) |  | [optional] 
 **OriginalWorkerErrorDetail** | Pointer to **string** |  | [optional] 
 **OriginalWorkerErrorType** | Pointer to **string** |  | [optional] 
 **OriginalWorkerErrorStatus** | Pointer to **int32** |  | [optional] 
@@ -54,31 +53,6 @@ SetDetail sets Detail field to given value.
 
 HasDetail returns a boolean if a field has been set.
 
-### GetSubStatus
-
-`func (o *ApiErrorResponse) GetSubStatus() ErrorSubStatus`
-
-GetSubStatus returns the SubStatus field if non-nil, zero value otherwise.
-
-### GetSubStatusOk
-
-`func (o *ApiErrorResponse) GetSubStatusOk() (*ErrorSubStatus, bool)`
-
-GetSubStatusOk returns a tuple with the SubStatus field if it's non-nil, zero value otherwise
-and a boolean to check if the value has been set.
-
-### SetSubStatus
-
-`func (o *ApiErrorResponse) SetSubStatus(v ErrorSubStatus)`
-
-SetSubStatus sets SubStatus field to given value.
-
-### HasSubStatus
-
-`func (o *ApiErrorResponse) HasSubStatus() bool`
-
-HasSubStatus returns a boolean if a field has been set.
-
 ### GetOriginalWorkerErrorDetail
 
 `func (o *ApiErrorResponse) GetOriginalWorkerErrorDetail() string`

goapi/xdbapi/docs/AsyncStateWaitUntilRequest.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Context** | Pointer to [**Context**](Context.md) |  | [optional] 
 **ProcessType** | Pointer to **string** |  | [optional] 
-**AsyncStateId** | Pointer to **string** |  | [optional] 
+**StateId** | Pointer to **string** |  | [optional] 
 **StateInput** | Pointer to [**EncodedObject**](EncodedObject.md) |  | [optional] 
 
 ## Methods
@@ -78,30 +78,30 @@ SetProcessType sets ProcessType field to given value.
 
 HasProcessType returns a boolean if a field has been set.
 
-### GetAsyncStateId
+### GetStateId
 
-`func (o *AsyncStateWaitUntilRequest) GetAsyncStateId() string`
+`func (o *AsyncStateWaitUntilRequest) GetStateId() string`
 
-GetAsyncStateId returns the AsyncStateId field if non-nil, zero value otherwise.
+GetStateId returns the StateId field if non-nil, zero value otherwise.
 
-### GetAsyncStateIdOk
+### GetStateIdOk
 
-`func (o *AsyncStateWaitUntilRequest) GetAsyncStateIdOk() (*string, bool)`
+`func (o *AsyncStateWaitUntilRequest) GetStateIdOk() (*string, bool)`
 
-GetAsyncStateIdOk returns a tuple with the AsyncStateId field if it's non-nil, zero value otherwise
+GetStateIdOk returns a tuple with the StateId field if it's non-nil, zero value otherwise
 and a boolean to check if the value has been set.
 
-### SetAsyncStateId
+### SetStateId
 
-`func (o *AsyncStateWaitUntilRequest) SetAsyncStateId(v string)`
+`func (o *AsyncStateWaitUntilRequest) SetStateId(v string)`
 
-SetAsyncStateId sets AsyncStateId field to given value.
+SetStateId sets StateId field to given value.
 
-### HasAsyncStateId
+### HasStateId
 
-`func (o *AsyncStateWaitUntilRequest) HasAsyncStateId() bool`
+`func (o *AsyncStateWaitUntilRequest) HasStateId() bool`
 
-HasAsyncStateId returns a boolean if a field has been set.
+HasStateId returns a boolean if a field has been set.
 
 ### GetStateInput