gateway.proto in zeebe-client-0.11.0

- old
+ new

@@ -13,18 +13,18 @@
   // type="payment-service" />)
   string type = 1;
   // the name of the worker activating the jobs, mostly used for logging purposes
   string worker = 2;
   // a job returned after this call will not be activated by another call until the
-  // timeout has been reached
+  // timeout (in ms) has been reached
   int64 timeout = 3;
   // the maximum jobs to activate by this request
   int32 maxJobsToActivate = 4;
   // a list of variables to fetch as the job variables; if empty, all visible variables at
   // the time of activation for the scope of the job will be returned
   repeated string fetchVariable = 5;
-  // The request will be completed when at least one job is activated or after the requestTimeout.
+  // The request will be completed when at least one job is activated or after the requestTimeout (in ms).
   // if the requestTimeout = 0, a default timeout is used.
   // if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
   int64 requestTimeout = 6;
 }
 
@@ -113,11 +113,11 @@
   int64 workflowInstanceKey = 4;
 }
 
 message CreateWorkflowInstanceWithResultRequest {
   CreateWorkflowInstanceRequest request = 1;
-  // timeout in milliseconds. the request will be closed if the workflow is not completed
+  // timeout (in ms). the request will be closed if the workflow is not completed
   // before the requestTimeout.
   // if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
   int64 requestTimeout = 2;
   // list of names of variables to be included in `CreateWorkflowInstanceWithResultResponse.variables`
   // if empty, all visible variables in the root scope will be returned.
@@ -413,10 +413,10 @@
   rpc FailJob (FailJobRequest) returns (FailJobResponse) {
   }
 
   /*
     Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the workflow by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
-   
+
     Errors:
       NOT_FOUND:
         - no job was found with the given key
 
       FAILED_PRECONDITION: