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.

Sign up for GitHub

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

Jump to bottom

Adding JobResult to CompleteJobRequest for gRPC #4808

Merged
merged 3 commits into from
Jan 2, 2025
Merged

Adding JobResult to CompleteJobRequest for gRPC #4808

merged 3 commits into from
Jan 2, 2025

Conversation

ana-vinogradova-camunda
Copy link
Contributor

@ana-vinogradova-camunda ana-vinogradova-camunda commented Dec 23, 2024 •
edited by ce-dmelnych
Loading

Description

Updating gateway-service.md file CompleteJobRequest:

  • added JobResult to CompleteJobRequest
  • added JobResultCorrections to JobResult

closes camunda/camunda#26345

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/).

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 23, 2024 •
edited
Loading

👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/apis-tools/zeebe-api/gateway-service.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@ana-vinogradova-camunda ana-vinogradova-camunda marked this pull request as ready for review December 23, 2024 15:45
@ana-vinogradova-camunda ana-vinogradova-camunda requested a review from a team December 23, 2024 15:45
ce-dmelnych
ce-dmelnych previously approved these changes Dec 23, 2024
View reviewed changes
Copy link
Contributor

@ce-dmelnych ce-dmelnych left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@ce-dmelnych ce-dmelnych added 8.7.0-alpha3 January 2024 alpha release deploy Stand up a temporary docs site with this PR labels Dec 24, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 24, 2024 10:27 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 27, 2024 14:39 Destroyed
@ana-vinogradova-camunda ana-vinogradova-camunda merged commit 09bd942 into main Jan 2, 2025
8 checks passed
@ana-vinogradova-camunda ana-vinogradova-camunda deleted the 26345-update-complete-job-rpc-documentation branch January 2, 2025 09:36
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 2, 2025

🧹 Preview environment for this PR has been torn down.

korthout
korthout reviewed Jan 7, 2025
View reviewed changes
docs/apis-tools/zeebe-api/gateway-service.md
Comment on lines +208 to +212
// * `assignee` - reset by providing an empty string
// * `dueDate` - reset by providing an empty string
// * `followUpDate` - reset by providing an empty string
// * `candidateGroups` - reset by providing an empty list
// * `candidateUsers` - reset by providing an empty list
Copy link
Member

@korthout korthout Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

As multiple listeners may trigger in sequence, corrections may overwrite one-another. the wording reset may imply that a previously made correction can be "reset" (i.e. undone).

🔧 I suggest changing the word reset to unset or clear

@ana-vinogradova-camunda @ce-dmelnych What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point @korthout ! Thank you. I will open a PR for it today 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will use unset for now, but if you prefer the clear option, just let me know.

Copy link
Member

Choose a reason for hiding this comment

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

Let's go for clear, while reviewing other documentation I saw it getting some usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@korthout korthout korthout left review comments

@christinaausley christinaausley christinaausley approved these changes

@ce-dmelnych ce-dmelnych ce-dmelnych left review comments

Assignees

@ana-vinogradova-camunda ana-vinogradova-camunda

Labels
8.7.0-alpha3 January 2024 alpha release deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update complete job rpc documentation
4 participants
@ana-vinogradova-camunda @korthout @christinaausley @ce-dmelnych