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

update gateway service protobuf references #4452

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Conversation

christinaausley
Copy link
Contributor

Description

Closes #3367.

Updates protobuf references based on https://github.com/camunda/camunda/blob/86828ff3fd3caef48b3229c1f717466b35c955eb/gateway-protocol/src/main/proto/gateway.proto

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

To backport upon approval

@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content theme:api-streamline Issues related to the theme of streamlining APIs labels Oct 10, 2024
@christinaausley christinaausley self-assigned this Oct 10, 2024
Copy link
Contributor

github-actions bot commented Oct 10, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

Comment on lines -163 to -164
// a reference key chosen by the user and will be part of all records resulting from this operation
optional uint64 operationReference = 2;
Copy link
Member

@akeller akeller Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed these reference keys were removed. Is there more context here? Is this not something we want to recommend, or is there an alternative now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were removed in the protobuf, but I'll leave it up to @korthout if we want to keep this in the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will check on the background, but generally if they are gone from the protobuf, we should remove them from the docs too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akeller As @megglos is out on parental leave for about a month, I think we can go ahead and merge this. If he returns and decides to add the reference keys we can certainly pop them back in!

@megglos megglos requested review from megglos and removed request for korthout October 25, 2024 14:18
@christinaausley christinaausley merged commit 0fb2903 into main Nov 21, 2024
7 checks passed
@christinaausley christinaausley deleted the update-zeebe-grpc branch November 21, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content theme:api-streamline Issues related to the theme of streamlining APIs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

CreateProcessInstanceWithResultRequest.fetchVariables missed in Zeebe GRPC docs
3 participants