Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add operationReference field to supported gRPC methods #237

Closed
jwulf opened this issue Aug 30, 2024 · 0 comments
Closed

Add operationReference field to supported gRPC methods #237

jwulf opened this issue Aug 30, 2024 · 0 comments
Assignees
Milestone

Comments

@jwulf
Copy link
Member

jwulf commented Aug 30, 2024

SDK Component

Zeebe gRPC API

Expected Behavior

The following API calls support the operationReference field:

  • CancelProcessInstanceRequest
  • CreateProcessInstanceRequest
  • ResolveIncidentRequest
  • UpdateJobRetriesRequest
  • UpdateJobTimeoutRequest
  • SetVariablesRequest
  • ModifyProcessInstanceRequest
  • MigrateProcessInstanceRequest
  • DeleteResourceRequest

The field is a uint64, which means that it is a number, but cannot be modelled in JavaScript with complete fidelity as the number type.

I think we will support it as a number | LosslessNumber. This allows us to signal to the user that it is a number, and at the same time support the complete range.

In the implementation, we'll call .toString() on the value, and send it that way.

@jwulf jwulf self-assigned this Aug 30, 2024
@jwulf jwulf changed the title Add operationReference field to gRPC methods Add operationReference field to supported gRPC methods Aug 30, 2024
@jwulf jwulf added this to the 8.6 milestone Aug 30, 2024
jwulf added a commit that referenced this issue Aug 30, 2024

Verified

This commit was created on github.com and signed with GitHub’s verified signature.
fixes #237
@jwulf jwulf mentioned this issue Aug 30, 2024
Merged
@jwulf jwulf moved this from 🆕 Inbox to 🏗 In Progress in Documentation Team Sep 4, 2024
@github-project-automation github-project-automation bot moved this to 🆕 Inbox in Documentation Team Sep 4, 2024
@jwulf jwulf closed this as completed in 2e5af66 Oct 24, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in Documentation Team Oct 24, 2024
github-actions bot pushed a commit that referenced this issue Oct 24, 2024
## [8.6.14](v8.6.13...v8.6.14) (2024-10-24)

### Bug Fixes

* **camunda8:** correctly parse autostart parameter of JobWorker ([cb95946](cb95946))
* **camunda8:** type variables in async process instance start as never ([3055734](3055734))
* **lossless-parser:** correctly parse number array ([d69729a](d69729a)), closes [#258](#258)
* **lossless-parser:** throw on encountering Date, Map, or Set ([bb5d8ea](bb5d8ea)), closes [#254](#254)
* **zeebe:** do not override explicit ZEEBE_GRPC_ADDRESS with default ZEEBE_ADDRESS ([cd6080f](cd6080f)), closes [#245](#245)
* **zeebe:** throw on client if array passed as variables to CompleteJob ([40a6316](40a6316)), closes [#247](#247)

### Features

* **camunda8:** add C8RestClient ([8e93c92](8e93c92)), closes [#235](#235)
* **camunda8:** add modifyAuthorization method ([0d97f68](0d97f68))
* **camunda8:** complete deployResources feature ([8043ac9](8043ac9))
* **camunda8:** implement createProcessInstanceWithResult ([4ec4fa1](4ec4fa1))
* **camunda8:** implement deleteResource over REST ([1dcb101](1dcb101)), closes [#251](#251)
* **camunda8:** implement deployResources REST API ([debd212](debd212))
* **camunda8:** implement publishMessage over REST ([057a9fe](057a9fe)), closes [#250](#250)
* **camunda8:** support broadcastSignal over REST ([43f82a4](43f82a4)), closes [#248](#248)
* **camunda8:** support pluggable winston logging for C8RestClient ([d41d3f8](d41d3f8))
* **camunda8:** support updateElementInstanceVariables ([7de82b7](7de82b7)), closes [#249](#249)
* **repo:** support passing middleware ([1b7715e](1b7715e)), closes [#261](#261)
* **zeebe:** add operationReference field to gRPC methods ([2e5af66](2e5af66)), closes [#237](#237)
* **zeebe:** create and cancel process instances over REST ([a49d217](a49d217))
* **zeebe:** lossless parse REST variables and customheaders ([f19a252](f19a252)), closes [#244](#244)
github-actions bot pushed a commit that referenced this issue Oct 24, 2024
## [8.6.14](v8.6.13...v8.6.14) (2024-10-24)

### Bug Fixes

* **camunda8:** correctly parse autostart parameter of JobWorker ([cb95946](cb95946))
* **camunda8:** type variables in async process instance start as never ([3055734](3055734))
* **lossless-parser:** correctly parse number array ([d69729a](d69729a)), closes [#258](#258)
* **lossless-parser:** throw on encountering Date, Map, or Set ([bb5d8ea](bb5d8ea)), closes [#254](#254)
* **zeebe:** do not override explicit ZEEBE_GRPC_ADDRESS with default ZEEBE_ADDRESS ([cd6080f](cd6080f)), closes [#245](#245)
* **zeebe:** throw on client if array passed as variables to CompleteJob ([40a6316](40a6316)), closes [#247](#247)

### Features

* **camunda8:** add C8RestClient ([8e93c92](8e93c92)), closes [#235](#235)
* **camunda8:** add modifyAuthorization method ([0d97f68](0d97f68))
* **camunda8:** complete deployResources feature ([8043ac9](8043ac9))
* **camunda8:** implement createProcessInstanceWithResult ([4ec4fa1](4ec4fa1))
* **camunda8:** implement deleteResource over REST ([1dcb101](1dcb101)), closes [#251](#251)
* **camunda8:** implement deployResources REST API ([debd212](debd212))
* **camunda8:** implement publishMessage over REST ([057a9fe](057a9fe)), closes [#250](#250)
* **camunda8:** support broadcastSignal over REST ([43f82a4](43f82a4)), closes [#248](#248)
* **camunda8:** support pluggable winston logging for C8RestClient ([d41d3f8](d41d3f8))
* **camunda8:** support updateElementInstanceVariables ([7de82b7](7de82b7)), closes [#249](#249)
* **repo:** support passing middleware ([1b7715e](1b7715e)), closes [#261](#261)
* **zeebe:** add operationReference field to gRPC methods ([2e5af66](2e5af66)), closes [#237](#237)
* **zeebe:** create and cancel process instances over REST ([a49d217](a49d217))
* **zeebe:** lossless parse REST variables and customheaders ([f19a252](f19a252)), closes [#244](#244)
petar-slavov pushed a commit to petar-slavov/camunda-8-js-sdk that referenced this issue Mar 14, 2025
## [8.6.14](camunda/camunda-8-js-sdk@v8.6.13...v8.6.14) (2024-10-24)

### Bug Fixes

* **camunda8:** correctly parse autostart parameter of JobWorker ([cb95946](camunda@cb95946))
* **camunda8:** type variables in async process instance start as never ([3055734](camunda@3055734))
* **lossless-parser:** correctly parse number array ([d69729a](camunda@d69729a)), closes [camunda#258](camunda#258)
* **lossless-parser:** throw on encountering Date, Map, or Set ([bb5d8ea](camunda@bb5d8ea)), closes [camunda#254](camunda#254)
* **zeebe:** do not override explicit ZEEBE_GRPC_ADDRESS with default ZEEBE_ADDRESS ([cd6080f](camunda@cd6080f)), closes [camunda#245](camunda#245)
* **zeebe:** throw on client if array passed as variables to CompleteJob ([40a6316](camunda@40a6316)), closes [camunda#247](camunda#247)

### Features

* **camunda8:** add C8RestClient ([8e93c92](camunda@8e93c92)), closes [camunda#235](camunda#235)
* **camunda8:** add modifyAuthorization method ([0d97f68](camunda@0d97f68))
* **camunda8:** complete deployResources feature ([8043ac9](camunda@8043ac9))
* **camunda8:** implement createProcessInstanceWithResult ([4ec4fa1](camunda@4ec4fa1))
* **camunda8:** implement deleteResource over REST ([1dcb101](camunda@1dcb101)), closes [camunda#251](camunda#251)
* **camunda8:** implement deployResources REST API ([debd212](camunda@debd212))
* **camunda8:** implement publishMessage over REST ([057a9fe](camunda@057a9fe)), closes [camunda#250](camunda#250)
* **camunda8:** support broadcastSignal over REST ([43f82a4](camunda@43f82a4)), closes [camunda#248](camunda#248)
* **camunda8:** support pluggable winston logging for C8RestClient ([d41d3f8](camunda@d41d3f8))
* **camunda8:** support updateElementInstanceVariables ([7de82b7](camunda@7de82b7)), closes [camunda#249](camunda#249)
* **repo:** support passing middleware ([1b7715e](camunda@1b7715e)), closes [camunda#261](camunda#261)
* **zeebe:** add operationReference field to gRPC methods ([2e5af66](camunda@2e5af66)), closes [camunda#237](camunda#237)
* **zeebe:** create and cancel process instances over REST ([a49d217](camunda@a49d217))
* **zeebe:** lossless parse REST variables and customheaders ([f19a252](camunda@f19a252)), closes [camunda#244](camunda#244)
petar-slavov pushed a commit to petar-slavov/camunda-8-js-sdk that referenced this issue Mar 14, 2025
## [8.6.14](camunda/camunda-8-js-sdk@v8.6.13...v8.6.14) (2024-10-24)

### Bug Fixes

* **camunda8:** correctly parse autostart parameter of JobWorker ([cb95946](camunda@cb95946))
* **camunda8:** type variables in async process instance start as never ([3055734](camunda@3055734))
* **lossless-parser:** correctly parse number array ([d69729a](camunda@d69729a)), closes [camunda#258](camunda#258)
* **lossless-parser:** throw on encountering Date, Map, or Set ([bb5d8ea](camunda@bb5d8ea)), closes [camunda#254](camunda#254)
* **zeebe:** do not override explicit ZEEBE_GRPC_ADDRESS with default ZEEBE_ADDRESS ([cd6080f](camunda@cd6080f)), closes [camunda#245](camunda#245)
* **zeebe:** throw on client if array passed as variables to CompleteJob ([40a6316](camunda@40a6316)), closes [camunda#247](camunda#247)

### Features

* **camunda8:** add C8RestClient ([8e93c92](camunda@8e93c92)), closes [camunda#235](camunda#235)
* **camunda8:** add modifyAuthorization method ([0d97f68](camunda@0d97f68))
* **camunda8:** complete deployResources feature ([8043ac9](camunda@8043ac9))
* **camunda8:** implement createProcessInstanceWithResult ([4ec4fa1](camunda@4ec4fa1))
* **camunda8:** implement deleteResource over REST ([1dcb101](camunda@1dcb101)), closes [camunda#251](camunda#251)
* **camunda8:** implement deployResources REST API ([debd212](camunda@debd212))
* **camunda8:** implement publishMessage over REST ([057a9fe](camunda@057a9fe)), closes [camunda#250](camunda#250)
* **camunda8:** support broadcastSignal over REST ([43f82a4](camunda@43f82a4)), closes [camunda#248](camunda#248)
* **camunda8:** support pluggable winston logging for C8RestClient ([d41d3f8](camunda@d41d3f8))
* **camunda8:** support updateElementInstanceVariables ([7de82b7](camunda@7de82b7)), closes [camunda#249](camunda#249)
* **repo:** support passing middleware ([1b7715e](camunda@1b7715e)), closes [camunda#261](camunda#261)
* **zeebe:** add operationReference field to gRPC methods ([2e5af66](camunda@2e5af66)), closes [camunda#237](camunda#237)
* **zeebe:** create and cancel process instances over REST ([a49d217](camunda@a49d217))
* **zeebe:** lossless parse REST variables and customheaders ([f19a252](camunda@f19a252)), closes [camunda#244](camunda#244)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant