zeebe-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb20414eb306313cc2a6a68b347dc4eaedc85a76e7ca8637352b3f9ab217cfb
-  data.tar.gz: 63d61e008d9c565b94f72dffe68c6a6df52c9432f50ddec5c6d24a24e198dd17
+  metadata.gz: a4ff45546615505deac91e48ec781bf2e2d6d1ce14805aa2c741687effc38560
+  data.tar.gz: 2d06b409be95371bf28fe16bc620b5de9ffe85adc731d4169bd3bdc74bd9c432
 SHA512:
-  metadata.gz: 1f294d138f22cd962acece2ff8b2f4c99fbacb3bbd30cf4226b01ce967e602661ad6cfef73cc67eac5da78196e3afc3a809017e458e004963fbffdce332806d0
-  data.tar.gz: 575548bf57e5d82884b20d7ded08f57dce147cf32c080e4a60d606e650e19b25acabb5cca11b875a2fcf9e4aa04016d62dd25500271ae515a1c9db4d82dfc0da
+  metadata.gz: 3e70ec2dd314f99110ea372df8c5418379c793f7fb02fdb3ab30bd233b84c05fe58bbf8a295d120715258c1044fb83bac282ac13e5ba29b44a53c3b267dc303b
+  data.tar.gz: 89318c917001d3b54a32b246d391dd23700ed68985837f2c118fe7cd1525cc1e4c74d219e2f7045b15e32829c0b953e5a1abe0c3f82caac3339541faef938839

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.0 (February 13, 2019)
+
+NEW FEATURES:
+
+- add support for [Zeebe 0.15.0](https://github.com/zeebe-io/zeebe/releases/tag/0.15.0)
+
 ## 0.2.0 (January 25, 2019)
 
 OTHER:

data/README.md

@@ -13,7 +13,7 @@ Install the gem:
 Run a Zeebe instance locally:
 
 ```sh
-docker run -it --rm -p 26500:26500 camunda/zeebe:0.14.0
+docker run -it --rm -p 26500:26500 camunda/zeebe:0.15.0
 ```
 
 And then try the available [demo script](examples/demo.rb).

data/Rakefile

@@ -13,7 +13,7 @@ task travis: ['zeebe:start', :default, 'zeebe:stop']
 
 desc 'Starts Zeebe Docker container'
 task 'zeebe:start' do
-  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.14.0'
+  sh 'docker run -d --name zeebe --rm -p 26500:26500 camunda/zeebe:0.15.0'
   sleep(5)
 end
 

data/lib/zeebe/client/proto/gateway_pb.rb

@@ -4,72 +4,38 @@
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "gateway_protocol.TopologyRequest" do
-  end
-  add_message "gateway_protocol.Partition" do
-    optional :partitionId, :int32, 1
-    optional :role, :enum, 3, "gateway_protocol.Partition.PartitionBrokerRole"
-  end
-  add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
-    value :LEADER, 0
-    value :FOLLOWER, 1
-  end
-  add_message "gateway_protocol.BrokerInfo" do
-    optional :nodeId, :int32, 1
-    optional :host, :string, 2
-    optional :port, :int32, 3
-    repeated :partitions, :message, 4, "gateway_protocol.Partition"
-  end
-  add_message "gateway_protocol.TopologyResponse" do
-    repeated :brokers, :message, 1, "gateway_protocol.BrokerInfo"
-    optional :clusterSize, :int32, 2
-    optional :partitionsCount, :int32, 3
-    optional :replicationFactor, :int32, 4
-  end
-  add_message "gateway_protocol.WorkflowRequestObject" do
-    optional :name, :string, 1
-    optional :type, :enum, 2, "gateway_protocol.WorkflowRequestObject.ResourceType"
-    optional :definition, :bytes, 3
-  end
-  add_enum "gateway_protocol.WorkflowRequestObject.ResourceType" do
-    value :FILE, 0
-    value :BPMN, 1
-    value :YAML, 2
-  end
-  add_message "gateway_protocol.DeployWorkflowRequest" do
-    repeated :workflows, :message, 1, "gateway_protocol.WorkflowRequestObject"
+  add_message "gateway_protocol.ActivateJobsRequest" do
+    optional :type, :string, 1
+    optional :worker, :string, 2
+    optional :timeout, :int64, 3
+    optional :amount, :int32, 4
+    repeated :fetchVariable, :string, 5
   end
-  add_message "gateway_protocol.WorkflowMetadata" do
-    optional :bpmnProcessId, :string, 1
-    optional :version, :int32, 2
-    optional :workflowKey, :int64, 3
-    optional :resourceName, :string, 4
+  add_message "gateway_protocol.ActivateJobsResponse" do
+    repeated :jobs, :message, 1, "gateway_protocol.ActivatedJob"
   end
-  add_message "gateway_protocol.DeployWorkflowResponse" do
+  add_message "gateway_protocol.ActivatedJob" do
     optional :key, :int64, 1
-    repeated :workflows, :message, 2, "gateway_protocol.WorkflowMetadata"
-  end
-  add_message "gateway_protocol.PublishMessageRequest" do
-    optional :name, :string, 1
-    optional :correlationKey, :string, 2
-    optional :timeToLive, :int64, 3
-    optional :messageId, :string, 4
-    optional :payload, :string, 5
-  end
-  add_message "gateway_protocol.PublishMessageResponse" do
-  end
-  add_message "gateway_protocol.UpdateJobRetriesRequest" do
-    optional :jobKey, :int64, 1
-    optional :retries, :int32, 2
+    optional :type, :string, 2
+    optional :jobHeaders, :message, 3, "gateway_protocol.JobHeaders"
+    optional :customHeaders, :string, 4
+    optional :worker, :string, 5
+    optional :retries, :int32, 6
+    optional :deadline, :int64, 7
+    optional :payload, :string, 8
   end
-  add_message "gateway_protocol.UpdateJobRetriesResponse" do
+  add_message "gateway_protocol.JobHeaders" do
+    optional :workflowInstanceKey, :int64, 1
+    optional :bpmnProcessId, :string, 2
+    optional :workflowDefinitionVersion, :int32, 3
+    optional :workflowKey, :int64, 4
+    optional :elementId, :string, 5
+    optional :elementInstanceKey, :int64, 6
   end
-  add_message "gateway_protocol.FailJobRequest" do
-    optional :jobKey, :int64, 1
-    optional :retries, :int32, 2
-    optional :errorMessage, :string, 3
+  add_message "gateway_protocol.CancelWorkflowInstanceRequest" do
+    optional :workflowInstanceKey, :int64, 1
   end
-  add_message "gateway_protocol.FailJobResponse" do
+  add_message "gateway_protocol.CancelWorkflowInstanceResponse" do
   end
   add_message "gateway_protocol.CompleteJobRequest" do
     optional :jobKey, :int64, 1
@@ -89,22 +55,35 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :version, :int32, 3
     optional :workflowInstanceKey, :int64, 5
   end
-  add_message "gateway_protocol.CancelWorkflowInstanceRequest" do
-    optional :workflowInstanceKey, :int64, 1
+  add_message "gateway_protocol.DeployWorkflowRequest" do
+    repeated :workflows, :message, 1, "gateway_protocol.WorkflowRequestObject"
   end
-  add_message "gateway_protocol.CancelWorkflowInstanceResponse" do
+  add_message "gateway_protocol.WorkflowRequestObject" do
+    optional :name, :string, 1
+    optional :type, :enum, 2, "gateway_protocol.WorkflowRequestObject.ResourceType"
+    optional :definition, :bytes, 3
   end
-  add_message "gateway_protocol.UpdateWorkflowInstancePayloadRequest" do
-    optional :elementInstanceKey, :int64, 1
-    optional :payload, :string, 2
+  add_enum "gateway_protocol.WorkflowRequestObject.ResourceType" do
+    value :FILE, 0
+    value :BPMN, 1
+    value :YAML, 2
   end
-  add_message "gateway_protocol.UpdateWorkflowInstancePayloadResponse" do
+  add_message "gateway_protocol.DeployWorkflowResponse" do
+    optional :key, :int64, 1
+    repeated :workflows, :message, 2, "gateway_protocol.WorkflowMetadata"
   end
-  add_message "gateway_protocol.ListWorkflowsRequest" do
+  add_message "gateway_protocol.WorkflowMetadata" do
     optional :bpmnProcessId, :string, 1
+    optional :version, :int32, 2
+    optional :workflowKey, :int64, 3
+    optional :resourceName, :string, 4
   end
-  add_message "gateway_protocol.ListWorkflowsResponse" do
-    repeated :workflows, :message, 1, "gateway_protocol.WorkflowMetadata"
+  add_message "gateway_protocol.FailJobRequest" do
+    optional :jobKey, :int64, 1
+    optional :retries, :int32, 2
+    optional :errorMessage, :string, 3
+  end
+  add_message "gateway_protocol.FailJobResponse" do
   end
   add_message "gateway_protocol.GetWorkflowRequest" do
     optional :workflowKey, :int64, 1
@@ -118,73 +97,95 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :resourceName, :string, 4
     optional :bpmnXml, :string, 5
   end
-  add_message "gateway_protocol.ActivateJobsRequest" do
-    optional :type, :string, 1
-    optional :worker, :string, 2
-    optional :timeout, :int64, 3
-    optional :amount, :int32, 4
+  add_message "gateway_protocol.ListWorkflowsRequest" do
+    optional :bpmnProcessId, :string, 1
   end
-  add_message "gateway_protocol.JobHeaders" do
-    optional :workflowInstanceKey, :int64, 1
-    optional :bpmnProcessId, :string, 2
-    optional :workflowDefinitionVersion, :int32, 3
-    optional :workflowKey, :int64, 4
-    optional :elementId, :string, 5
-    optional :elementInstanceKey, :int64, 6
+  add_message "gateway_protocol.ListWorkflowsResponse" do
+    repeated :workflows, :message, 1, "gateway_protocol.WorkflowMetadata"
   end
-  add_message "gateway_protocol.ActivatedJob" do
-    optional :key, :int64, 1
-    optional :type, :string, 2
-    optional :jobHeaders, :message, 3, "gateway_protocol.JobHeaders"
-    optional :customHeaders, :string, 4
-    optional :worker, :string, 5
-    optional :retries, :int32, 6
-    optional :deadline, :int64, 7
-    optional :payload, :string, 8
+  add_message "gateway_protocol.PublishMessageRequest" do
+    optional :name, :string, 1
+    optional :correlationKey, :string, 2
+    optional :timeToLive, :int64, 3
+    optional :messageId, :string, 4
+    optional :payload, :string, 5
   end
-  add_message "gateway_protocol.ActivateJobsResponse" do
-    repeated :jobs, :message, 1, "gateway_protocol.ActivatedJob"
+  add_message "gateway_protocol.PublishMessageResponse" do
   end
   add_message "gateway_protocol.ResolveIncidentRequest" do
     optional :incidentKey, :int64, 1
   end
   add_message "gateway_protocol.ResolveIncidentResponse" do
   end
+  add_message "gateway_protocol.TopologyRequest" do
+  end
+  add_message "gateway_protocol.TopologyResponse" do
+    repeated :brokers, :message, 1, "gateway_protocol.BrokerInfo"
+    optional :clusterSize, :int32, 2
+    optional :partitionsCount, :int32, 3
+    optional :replicationFactor, :int32, 4
+  end
+  add_message "gateway_protocol.BrokerInfo" do
+    optional :nodeId, :int32, 1
+    optional :host, :string, 2
+    optional :port, :int32, 3
+    repeated :partitions, :message, 4, "gateway_protocol.Partition"
+  end
+  add_message "gateway_protocol.Partition" do
+    optional :partitionId, :int32, 1
+    optional :role, :enum, 3, "gateway_protocol.Partition.PartitionBrokerRole"
+  end
+  add_enum "gateway_protocol.Partition.PartitionBrokerRole" do
+    value :LEADER, 0
+    value :FOLLOWER, 1
+  end
+  add_message "gateway_protocol.UpdateJobRetriesRequest" do
+    optional :jobKey, :int64, 1
+    optional :retries, :int32, 2
+  end
+  add_message "gateway_protocol.UpdateJobRetriesResponse" do
+  end
+  add_message "gateway_protocol.UpdateWorkflowInstancePayloadRequest" do
+    optional :elementInstanceKey, :int64, 1
+    optional :payload, :string, 2
+  end
+  add_message "gateway_protocol.UpdateWorkflowInstancePayloadResponse" do
+  end
 end
 
 module Zeebe::Client::GatewayProtocol
-  TopologyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyRequest").msgclass
-  Partition = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition").msgclass
-  Partition::PartitionBrokerRole = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerRole").enummodule
-  BrokerInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BrokerInfo").msgclass
-  TopologyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyResponse").msgclass
+  ActivateJobsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsRequest").msgclass
+  ActivateJobsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsResponse").msgclass
+  ActivatedJob = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivatedJob").msgclass
+  JobHeaders = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.JobHeaders").msgclass
+  CancelWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceRequest").msgclass
+  CancelWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceResponse").msgclass
+  CompleteJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
+  CompleteJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
+  CreateWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceRequest").msgclass
+  CreateWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceResponse").msgclass
+  DeployWorkflowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowRequest").msgclass
   WorkflowRequestObject = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject").msgclass
   WorkflowRequestObject::ResourceType = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowRequestObject.ResourceType").enummodule
-  DeployWorkflowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowRequest").msgclass
-  WorkflowMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowMetadata").msgclass
   DeployWorkflowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.DeployWorkflowResponse").msgclass
-  PublishMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageRequest").msgclass
-  PublishMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageResponse").msgclass
-  UpdateJobRetriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesRequest").msgclass
-  UpdateJobRetriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
+  WorkflowMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.WorkflowMetadata").msgclass
   FailJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobRequest").msgclass
   FailJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.FailJobResponse").msgclass
-  CompleteJobRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobRequest").msgclass
-  CompleteJobResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CompleteJobResponse").msgclass
-  CreateWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceRequest").msgclass
-  CreateWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CreateWorkflowInstanceResponse").msgclass
-  CancelWorkflowInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceRequest").msgclass
-  CancelWorkflowInstanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.CancelWorkflowInstanceResponse").msgclass
-  UpdateWorkflowInstancePayloadRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadRequest").msgclass
-  UpdateWorkflowInstancePayloadResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadResponse").msgclass
-  ListWorkflowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsRequest").msgclass
-  ListWorkflowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsResponse").msgclass
   GetWorkflowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.GetWorkflowRequest").msgclass
   GetWorkflowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.GetWorkflowResponse").msgclass
-  ActivateJobsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsRequest").msgclass
-  JobHeaders = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.JobHeaders").msgclass
-  ActivatedJob = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivatedJob").msgclass
-  ActivateJobsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ActivateJobsResponse").msgclass
+  ListWorkflowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsRequest").msgclass
+  ListWorkflowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ListWorkflowsResponse").msgclass
+  PublishMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageRequest").msgclass
+  PublishMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.PublishMessageResponse").msgclass
   ResolveIncidentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ResolveIncidentRequest").msgclass
   ResolveIncidentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.ResolveIncidentResponse").msgclass
+  TopologyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyRequest").msgclass
+  TopologyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.TopologyResponse").msgclass
+  BrokerInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.BrokerInfo").msgclass
+  Partition = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition").msgclass
+  Partition::PartitionBrokerRole = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.Partition.PartitionBrokerRole").enummodule
+  UpdateJobRetriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesRequest").msgclass
+  UpdateJobRetriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateJobRetriesResponse").msgclass
+  UpdateWorkflowInstancePayloadRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadRequest").msgclass
+  UpdateWorkflowInstancePayloadResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("gateway_protocol.UpdateWorkflowInstancePayloadResponse").msgclass
 end

data/lib/zeebe/client/proto/gateway_services_pb.rb

@@ -14,19 +14,142 @@ module Zeebe::Client::GatewayProtocol
       self.unmarshal_class_method = :decode
       self.service_name = 'gateway_protocol.Gateway'
 
-      rpc :Topology, TopologyRequest, TopologyResponse
-      rpc :DeployWorkflow, DeployWorkflowRequest, DeployWorkflowResponse
-      rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
-      rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
-      rpc :FailJob, FailJobRequest, FailJobResponse
+      #
+      # Iterates through all known partitions in a round-robin and activates up to the requested amount
+      # of jobs and streams them back to the client as they are activated.
+      #
+      # Errors:
+      # INVALID_ARGUMENT:
+      # - type is blank (empty string, null)
+      # - worker is blank (empty string, null)
+      # - timeout less than 1
+      # - amount is less than 1
+      rpc :ActivateJobs, ActivateJobsRequest, stream(ActivateJobsResponse)
+      #
+      # Cancels a running workflow instance
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no workflow instance exists with the given key
+      rpc :CancelWorkflowInstance, CancelWorkflowInstanceRequest, CancelWorkflowInstanceResponse
+      #
+      # Completes a job with the given payload, which allows completing the associated service task.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no job exists with the given job key. Note that since jobs are removed once completed,
+      # it could be that this job did exist at some point.
+      #
+      # FAILED_PRECONDITION:
+      # - the job was marked as failed. In that case, the related incident must be resolved before
+      # the job can be activated again and completed.
       rpc :CompleteJob, CompleteJobRequest, CompleteJobResponse
+      #
+      # Creates and starts an instance of the specified workflow. The workflow definition to use to
+      # create the instance can be specified either using its unique key (as returned by
+      # DeployWorkflow), or using the BPMN process ID and a version. Pass -1 as the version to use the
+      # latest deployed version. Note that only workflows with none start events can be started through
+      # this command.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no workflow with the given key exists (if workflowKey was given)
+      # - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
+      # - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
+      #
+      # FAILED_PRECONDITION:
+      # - the workflow definition does not contain a none start event; only workflows with none
+      # start event can be started manually.
+      #
+      # INVALID_ARGUMENT:
+      # - the given payload is not a valid JSON document; all payloads are expected to be
+      # valid JSON documents where the root node is an object.
       rpc :CreateWorkflowInstance, CreateWorkflowInstanceRequest, CreateWorkflowInstanceResponse
-      rpc :CancelWorkflowInstance, CancelWorkflowInstanceRequest, CancelWorkflowInstanceResponse
-      rpc :UpdateWorkflowInstancePayload, UpdateWorkflowInstancePayloadRequest, UpdateWorkflowInstancePayloadResponse
-      rpc :ActivateJobs, ActivateJobsRequest, stream(ActivateJobsResponse)
-      rpc :ListWorkflows, ListWorkflowsRequest, ListWorkflowsResponse
+      #
+      # Deploys one or more workflows to Zeebe. Note that this is an atomic call,
+      # i.e. either all workflows are deployed, or none of them are.
+      #
+      # Errors:
+      # INVALID_ARGUMENT:
+      # - no resources given.
+      # - if at least one resource is invalid. A resource is considered invalid if:
+      # - it is not a BPMN or YAML file (currently detected through the file extension)
+      # - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
+      # - the workflow is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+      rpc :DeployWorkflow, DeployWorkflowRequest, DeployWorkflowResponse
+      #
+      # Marks the job as failed; if the retries argument is positive, then the job will be immediately
+      # activatable again, and a worker could try again to process it. If it is zero or negative however,
+      # an incident will be raised, tagged with the given errorMessage, and the job will not be
+      # activatable until the incident is resolved.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no job was found with the given key
+      #
+      # FAILED_PRECONDITION:
+      # - the job was not activated
+      # - the job is already in a failed state, i.e. ran out of retries
+      rpc :FailJob, FailJobRequest, FailJobResponse
+      #
+      # Fetches the workflow definition either by workflow key, or BPMN process ID and version.
+      # At least one of workflowKey or bpmnProcessId must be specified.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no workflow with the given key exists (if workflowKey was given)
+      # - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
+      # - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
       rpc :GetWorkflow, GetWorkflowRequest, GetWorkflowResponse
+      #
+      # Lists all workflows matching the request criteria currently deployed in the cluster.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no workflows have been deployed yet (if no bpmnProcessId was given)
+      # - no workflow with the given process ID exists (if bpmnProcessId was given)
+      rpc :ListWorkflows, ListWorkflowsRequest, ListWorkflowsResponse
+      #
+      # Publishes a single message. Messages are published to specific partitions computed from their
+      # correlation keys.
+      #
+      # Errors:
+      # ALREADY_EXISTS:
+      # - a message with the same ID was previously published (and is still alive)
+      rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
+      #
+      # Resolves a given incident. This simply marks the incident as resolved; most likely a call to
+      # UpdateJobRetries or UpdateWorkflowInstancePayload will be necessary to actually resolve the
+      # problem, following by this call.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no incident with the given key exists
       rpc :ResolveIncident, ResolveIncidentRequest, ResolveIncidentResponse
+      #
+      # Obtains the current topology of the cluster the gateway is part of.
+      rpc :Topology, TopologyRequest, TopologyResponse
+      #
+      # Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
+      # retries, should the underlying problem be solved.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no job exists with the given key
+      #
+      # INVALID_ARGUMENT:
+      # - retries is not greater than 0
+      rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
+      #
+      # Updates all the variables in the workflow instance scope from the given JSON document.
+      #
+      # Errors:
+      # NOT_FOUND:
+      # - no element with the given elementInstanceKey exists
+      # INVALID_ARGUMENT:
+      # - the given payload is not a valid JSON document; all payloads are expected to be
+      # valid JSON documents where the root node is an object.
+      rpc :UpdateWorkflowInstancePayload, UpdateWorkflowInstancePayloadRequest, UpdateWorkflowInstancePayloadResponse
     end
 
     Stub = Service.rpc_stub_class

data/lib/zeebe/client/version.rb

@@ -1,6 +1,6 @@
 
 module Zeebe
   module Client
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/proto/gateway.proto

@@ -5,92 +5,80 @@ option java_multiple_files = false;
 option java_package = "io.zeebe.gateway.protocol";
 option go_package = "pb";
 
-message TopologyRequest {
-}
-
-message Partition {
-  int32 partitionId = 1;
-  enum PartitionBrokerRole {
-    LEADER = 0;
-    FOLLOWER = 1;
-  }
-  PartitionBrokerRole role = 3;
-}
-
-message BrokerInfo {
-  int32 nodeId = 1;
-  string host = 2;
-  int32 port = 3;
-  repeated Partition partitions = 4;
-}
-
-message TopologyResponse {
-  repeated BrokerInfo brokers = 1;
-  int32 clusterSize = 2;
-  int32 partitionsCount = 3;
-  int32 replicationFactor = 4;
-}
-
-message WorkflowRequestObject {
-  string name = 1;
-  enum ResourceType {
-    // FILE type means the gateway will try to detect the resource type using the file extension of the name
-    FILE = 0;
-    BPMN = 1;
-    YAML = 2;
-  }
-  ResourceType type = 2;
-  bytes definition = 3;
-}
+// For a more complete documentation, refer to Zeebe documentation at:
+// https://docs.zeebe.io/grpc/reference.html
 
-message DeployWorkflowRequest {
-  repeated WorkflowRequestObject workflows = 1;
+message ActivateJobsRequest {
+  // the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+  // 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
+  int64 timeout = 3;
+  // the maximum number of jobs to fetch in a single call
+  int32 amount = 4;
+  // a list of variables to fetch as the job payload; if empty, all visible variables at
+  // the time of activation for the scope of the job will be returned as the job payload
+  repeated string fetchVariable = 5;
 }
 
-message WorkflowMetadata {
-  string bpmnProcessId = 1;
-  int32 version = 2;
-  int64 workflowKey = 3;
-  string resourceName = 4;
+message ActivateJobsResponse {
+  // list of activated jobs
+  repeated ActivatedJob jobs = 1;
 }
 
-message DeployWorkflowResponse {
+message ActivatedJob {
+  // the key, a unique identifier for the job
   int64 key = 1;
-  repeated WorkflowMetadata workflows = 2;
-}
-
-message PublishMessageRequest {
-  string name = 1;
-  string correlationKey = 2;
-  int64 timeToLive = 3;
-  string messageId = 4;
-  /* payload has to be a valid json object as string */
-  string payload = 5;
-}
-
-message PublishMessageResponse {
-}
-
-message UpdateJobRetriesRequest {
-  int64 jobKey = 1;
-  int32 retries = 2;
+  // the type of the job (should match what was requested)
+  string type = 2;
+  // a set of headers tying the job to a workflow instance/task instance
+  JobHeaders jobHeaders = 3;
+  // a set of custom headers defined during modelling; returned as a serialized
+  // JSON document
+  string customHeaders = 4;
+  // the name of the worker which activated this job
+  string worker = 5;
+  // the amount of retries left to this job (should always be positive)
+  int32 retries = 6;
+  // when the job can be activated again, sent as a UNIX epoch timestamp
+  int64 deadline = 7;
+  // JSON document, computed at activation time, consisting of all visible variables to
+  // the task scope
+  string payload = 8;
 }
 
-message UpdateJobRetriesResponse {
+message JobHeaders {
+  // the job's workflow instance key
+  int64 workflowInstanceKey = 1;
+  // the bpmn process ID of the job workflow definition
+  string bpmnProcessId = 2;
+  // the version of the job workflow definition
+  int32 workflowDefinitionVersion = 3;
+  // the key of the job workflow definition
+  int64 workflowKey = 4;
+  // the associated task element ID
+  string elementId = 5;
+  // the unique key identifying the associated task, unique within the scope of the
+  // workflow instance
+  int64 elementInstanceKey = 6;
 }
 
-message FailJobRequest {
-  int64 jobKey = 1;
-  int32 retries = 2;
-  string errorMessage = 3;
+message CancelWorkflowInstanceRequest {
+  // the workflow instance key (as, for example, obtained from
+  // CreateWorkflowInstanceResponse)
+  int64 workflowInstanceKey = 1;
 }
 
-message FailJobResponse {
+message CancelWorkflowInstanceResponse {
 }
 
 message CompleteJobRequest {
+  // the unique job identifier, as obtained from ActivateJobsResponse
   int64 jobKey = 1;
-  /* payload has to be a valid json object as string */
+  // a JSON document representing the variables in the current task scope
   string payload = 2;
 }
 
@@ -98,128 +86,385 @@ message CompleteJobResponse {
 }
 
 message CreateWorkflowInstanceRequest {
+  // the unique key identifying the workflow definition (e.g. returned from a workflow
+  // in the DeployWorkflowResponse message)
   int64 workflowKey = 1;
+  // the BPMN process ID of the workflow definition
   string bpmnProcessId = 2;
-  /* if bpmnProcessId is set version = -1 indicates to use the latest version */
+  // the version of the process; set to -1 to use the latest version
   int32 version = 3;
-  /* payload has to be a valid json object as string */
+  // JSON document that will instantiate the variables for the root variable scope of the
+  // workflow instance; it must be a JSON object, as variables will be mapped in a
+  // key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
+  // "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
+  // valid payload, as the root of the JSON document is an array and not an object.
   string payload = 4;
 }
 
 message CreateWorkflowInstanceResponse {
+  // the key of the workflow definition which was used to create the workflow instance
   int64 workflowKey = 1;
+  // the BPMN process ID of the workflow definition which was used to create the workflow
+  // instance
   string bpmnProcessId = 2;
+  // the version of the workflow definition which was used to create the workflow instance
   int32 version = 3;
+  // the unique identifier of the created workflow instance; to be used wherever a request
+  // needs a workflow instance key (e.g. CancelWorkflowInstanceRequest)
   int64 workflowInstanceKey = 5;
 }
 
-message CancelWorkflowInstanceRequest {
-  int64 workflowInstanceKey = 1;
+message DeployWorkflowRequest {
+  // List of workflow resources to deploy
+  repeated WorkflowRequestObject workflows = 1;
 }
 
-message CancelWorkflowInstanceResponse {
-}
+message WorkflowRequestObject {
+  enum ResourceType {
+    // FILE type means the gateway will try to detect the resource type
+    // using the file extension of the name field
+    FILE = 0;
+    BPMN = 1; // extension 'bpmn'
+    YAML = 2; // extension 'yaml'
+  }
 
-message UpdateWorkflowInstancePayloadRequest {
-  int64 elementInstanceKey = 1;
-  /* payload has to be a valid json object as string */
-  string payload = 2;
+  // the resource basename, e.g. myProcess.bpmn
+  string name = 1;
+  // the resource type; if set to BPMN or YAML then the file extension
+  // is ignored
+  ResourceType type = 2;
+  // the process definition as a UTF8-encoded string
+  bytes definition = 3;
 }
 
-message UpdateWorkflowInstancePayloadResponse {
+message DeployWorkflowResponse {
+  // the unique key identifying the deployment
+  int64 key = 1;
+  // a list of deployed workflows
+  repeated WorkflowMetadata workflows = 2;
 }
 
-message ListWorkflowsRequest {
-  /* optional filter by BPMN process id, if empty all workflows are returned */
+message WorkflowMetadata {
+  // the bpmn process ID, as parsed during deployment; together with the version forms a
+  // unique identifier for a specific workflow definition
   string bpmnProcessId = 1;
+  // the assigned process version
+  int32 version = 2;
+  // the assigned key, which acts as a unique identifier for this workflow
+  int64 workflowKey = 3;
+  // the resource name (see: WorkflowRequestObject.name) from which this workflow was
+  // parsed
+  string resourceName = 4;
 }
 
-message ListWorkflowsResponse {
-  repeated WorkflowMetadata workflows = 1;
+message FailJobRequest {
+  // the unique job identifier, as obtained when activating the job
+  int64 jobKey = 1;
+  // the amount of retries the job should have left
+  int32 retries = 2;
+  // an optional message describing why the job failed
+  // this is particularly useful if a job runs out of retries and an incident is raised,
+  // as it this message can help explain why an incident was raised
+  string errorMessage = 3;
+}
+
+message FailJobResponse {
 }
 
-/* either workflow key or bpmn process id and version has to be specified*/
 message GetWorkflowRequest {
+  // the unique key identifying the workflow definition (e.g. returned from a workflow in
+  // the DeployWorkflowResponse message)
   int64 workflowKey = 1;
-  /* if bpmnProcessId is set version = -1 indicates to use the latest version */
+  // the version of the process; set to -1 to use the latest version
   int32 version = 2;
+  // the BPMN process ID of the workflow definition
   string bpmnProcessId = 3;
 }
 
 message GetWorkflowResponse {
+  // the unique key identifying the workflow definition (e.g. returned from a workflow in
+  // the DeployWorkflowResponse message)
   int64 workflowKey = 1;
+  // the version of the process
   int32 version = 2;
+  // the BPMN process ID of the workflow definition
   string bpmnProcessId = 3;
+  // the name of the resource used to deployed the workflow
   string resourceName = 4;
+  // a BPMN XML representation of the workflow
   string bpmnXml = 5;
 }
 
-message ActivateJobsRequest {
-  string type = 1;
-  string worker = 2;
-  int64 timeout = 3;
-  int32 amount = 4;
+message ListWorkflowsRequest {
+  // optional filter: if specified, only the workflows with this given process ID will be
+  // returned
+  string bpmnProcessId = 1;
 }
 
-message JobHeaders {
-  int64 workflowInstanceKey = 1;
-  string bpmnProcessId = 2;
-  int32 workflowDefinitionVersion = 3;
-  int64 workflowKey = 4;
-  string elementId = 5;
-  int64 elementInstanceKey = 6;
+message ListWorkflowsResponse {
+  // a list of deployed workflows matching the request criteria (if any)
+  repeated WorkflowMetadata workflows = 1;
 }
 
-message ActivatedJob {
-  int64 key = 1;
-  string type = 2;
-  JobHeaders jobHeaders = 3;
-  // json object as string
-  string customHeaders = 4;
-  string worker = 5;
-  int32 retries = 6;
-  // epoch milliseconds
-  int64 deadline = 7;
-  /* json object as string */
-  string payload = 8;
+message PublishMessageRequest {
+  // the name of the message
+  string name = 1;
+  // the correlation key of the message
+  string correlationKey = 2;
+  // how long the message should be buffered on the broker, in milliseconds
+  int64 timeToLive = 3;
+  // the unique ID of the message; can be omitted. only useful to ensure only one message
+  // with the given ID will ever be published (during its lifetime)
+  string messageId = 4;
+  // the message payload as a JSON document; see CreateWorkflowInstanceRequest for the
+  // rules about payloads
+  string payload = 5;
 }
 
-message ActivateJobsResponse {
-  repeated ActivatedJob jobs = 1;
+message PublishMessageResponse {
 }
 
 message ResolveIncidentRequest {
+  // the unique ID of the incident to resolve
   int64 incidentKey = 1;
 }
 
 message ResolveIncidentResponse {
 }
 
-service Gateway {
-  rpc Topology (TopologyRequest) returns (TopologyResponse) {
-  }
-  rpc DeployWorkflow (DeployWorkflowRequest) returns (DeployWorkflowResponse) {
-  }
-  rpc PublishMessage (PublishMessageRequest) returns (PublishMessageResponse) {
+message TopologyRequest {
+}
+message TopologyResponse {
+  // list of brokers part of this cluster
+  repeated BrokerInfo brokers = 1;
+  // how many nodes are in the cluster
+  int32 clusterSize = 2;
+  // how many partitions are spread across the cluster
+  int32 partitionsCount = 3;
+  // configured replication factor for this cluster
+  int32 replicationFactor = 4;
+}
+
+message BrokerInfo {
+  // unique (within a cluster) node ID for the broker
+  int32 nodeId = 1;
+  // hostname of the broker
+  string host = 2;
+  // port for the broker
+  int32 port = 3;
+  // list of partitions managed or replicated on this broker
+  repeated Partition partitions = 4;
+}
+
+message Partition {
+  // Describes the Raft role of the broker for a given partition
+  enum PartitionBrokerRole {
+    LEADER = 0;
+    FOLLOWER = 1;
   }
-  rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
+
+  // the unique ID of this partition
+  int32 partitionId = 1;
+  // the role of the broker for this partition
+  PartitionBrokerRole role = 3;
+}
+
+message UpdateJobRetriesRequest {
+  // the unique job identifier, as obtained through ActivateJobs
+  int64 jobKey = 1;
+  // the new amount of retries for the job; must be positive
+  int32 retries = 2;
+}
+
+message UpdateJobRetriesResponse {
+}
+
+message UpdateWorkflowInstancePayloadRequest {
+  // the unique identifier of a particular element; can be the workflow instance key (as
+  // obtained during instance creation), or a given element, such as a service task (see
+  // elementInstanceKey on the JobHeaders message)
+  int64 elementInstanceKey = 1;
+  // the new payload as a JSON document; see CreateWorkflowInstanceRequest for the rules
+  // about payloads
+  string payload = 2;
+}
+
+message UpdateWorkflowInstancePayloadResponse {
+}
+
+service Gateway {
+  /*
+    Iterates through all known partitions in a round-robin and activates up to the requested amount
+    of jobs and streams them back to the client as they are activated.
+
+    Errors:
+     INVALID_ARGUMENT:
+      - type is blank (empty string, null)
+      - worker is blank (empty string, null)
+      - timeout less than 1
+      - amount is less than 1
+   */
+  rpc ActivateJobs (ActivateJobsRequest) returns (stream ActivateJobsResponse) {
   }
-  rpc FailJob (FailJobRequest) returns (FailJobResponse) {
+
+  /*
+    Cancels a running workflow instance
+
+    Errors:
+      NOT_FOUND:
+        - no workflow instance exists with the given key
+   */
+  rpc CancelWorkflowInstance (CancelWorkflowInstanceRequest) returns (CancelWorkflowInstanceResponse) {
   }
+
+  /*
+    Completes a job with the given payload, which allows completing the associated service task.
+
+    Errors:
+      NOT_FOUND:
+        - no job exists with the given job key. Note that since jobs are removed once completed,
+          it could be that this job did exist at some point.
+
+      FAILED_PRECONDITION:
+        - the job was marked as failed. In that case, the related incident must be resolved before
+          the job can be activated again and completed.
+   */
   rpc CompleteJob (CompleteJobRequest) returns (CompleteJobResponse) {
   }
+
+  /*
+    Creates and starts an instance of the specified workflow. The workflow definition to use to
+    create the instance can be specified either using its unique key (as returned by
+    DeployWorkflow), or using the BPMN process ID and a version. Pass -1 as the version to use the
+    latest deployed version. Note that only workflows with none start events can be started through
+    this command.
+
+    Errors:
+      NOT_FOUND:
+        - no workflow with the given key exists (if workflowKey was given)
+        - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
+        - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
+
+      FAILED_PRECONDITION:
+        - the workflow definition does not contain a none start event; only workflows with none
+          start event can be started manually.
+
+      INVALID_ARGUMENT:
+        - the given payload is not a valid JSON document; all payloads are expected to be
+          valid JSON documents where the root node is an object.
+   */
   rpc CreateWorkflowInstance (CreateWorkflowInstanceRequest) returns (CreateWorkflowInstanceResponse) {
   }
-  rpc CancelWorkflowInstance (CancelWorkflowInstanceRequest) returns (CancelWorkflowInstanceResponse) {
+
+  /*
+    Deploys one or more workflows to Zeebe. Note that this is an atomic call,
+    i.e. either all workflows are deployed, or none of them are.
+
+    Errors:
+      INVALID_ARGUMENT:
+        - no resources given.
+        - if at least one resource is invalid. A resource is considered invalid if:
+          - it is not a BPMN or YAML file (currently detected through the file extension)
+          - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
+          - the workflow is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
+   */
+  rpc DeployWorkflow (DeployWorkflowRequest) returns (DeployWorkflowResponse) {
   }
-  rpc UpdateWorkflowInstancePayload (UpdateWorkflowInstancePayloadRequest) returns (UpdateWorkflowInstancePayloadResponse) {
+
+  /*
+    Marks the job as failed; if the retries argument is positive, then the job will be immediately
+    activatable again, and a worker could try again to process it. If it is zero or negative however,
+    an incident will be raised, tagged with the given errorMessage, and the job will not be
+    activatable until the incident is resolved.
+
+    Errors:
+      NOT_FOUND:
+        - no job was found with the given key
+
+      FAILED_PRECONDITION:
+        - the job was not activated
+        - the job is already in a failed state, i.e. ran out of retries
+   */
+  rpc FailJob (FailJobRequest) returns (FailJobResponse) {
   }
-  rpc ActivateJobs (ActivateJobsRequest) returns (stream ActivateJobsResponse) {
+
+  /*
+    Fetches the workflow definition either by workflow key, or BPMN process ID and version.
+    At least one of workflowKey or bpmnProcessId must be specified.
+
+    Errors:
+      NOT_FOUND:
+        - no workflow with the given key exists (if workflowKey was given)
+        - no workflow with the given process ID exists (if bpmnProcessId was given but version was -1)
+        - no workflow with the given process ID and version exists (if both bpmnProcessId and version were given)
+   */
+  rpc GetWorkflow (GetWorkflowRequest) returns (GetWorkflowResponse) {
   }
+
+  /*
+    Lists all workflows matching the request criteria currently deployed in the cluster.
+
+    Errors:
+      NOT_FOUND:
+        - no workflows have been deployed yet (if no bpmnProcessId was given)
+        - no workflow with the given process ID exists (if bpmnProcessId was given)
+   */
   rpc ListWorkflows (ListWorkflowsRequest) returns (ListWorkflowsResponse) {
   }
-  rpc GetWorkflow (GetWorkflowRequest) returns (GetWorkflowResponse) {
+
+  /*
+    Publishes a single message. Messages are published to specific partitions computed from their
+    correlation keys.
+
+    Errors:
+      ALREADY_EXISTS:
+        - a message with the same ID was previously published (and is still alive)
+   */
+  rpc PublishMessage (PublishMessageRequest) returns (PublishMessageResponse) {
   }
+
+  /*
+    Resolves a given incident. This simply marks the incident as resolved; most likely a call to
+    UpdateJobRetries or UpdateWorkflowInstancePayload will be necessary to actually resolve the
+    problem, following by this call.
+
+    Errors:
+      NOT_FOUND:
+        - no incident with the given key exists
+   */
   rpc ResolveIncident (ResolveIncidentRequest) returns (ResolveIncidentResponse) {
   }
+
+  /*
+    Obtains the current topology of the cluster the gateway is part of.
+   */
+  rpc Topology (TopologyRequest) returns (TopologyResponse) {
+  }
+
+  /*
+    Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
+    retries, should the underlying problem be solved.
+
+    Errors:
+      NOT_FOUND:
+        - no job exists with the given key
+
+      INVALID_ARGUMENT:
+        - retries is not greater than 0
+   */
+  rpc UpdateJobRetries (UpdateJobRetriesRequest) returns (UpdateJobRetriesResponse) {
+  }
+
+  /*
+    Updates all the variables in the workflow instance scope from the given JSON document.
+
+    Errors:
+      NOT_FOUND:
+        - no element with the given elementInstanceKey exists
+      INVALID_ARGUMENT:
+        - the given payload is not a valid JSON document; all payloads are expected to be
+          valid JSON documents where the root node is an object.
+   */
+  rpc UpdateWorkflowInstancePayload (UpdateWorkflowInstancePayloadRequest) returns (UpdateWorkflowInstancePayloadResponse) {
+  }
 }

data/zeebe-client.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.63.0'
+  s.add_development_dependency 'rubocop', '~> 0.64.0'
   s.add_development_dependency 'bundler-audit'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement