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

update bpmn process id #4396

Closed
wants to merge 2 commits into from
Closed

update bpmn process id #4396

wants to merge 2 commits into from

Conversation

christinaausley
Copy link
Contributor

Description

bpmnProcessId has been renamed as processDefinitionId

See related Slack thread and discussion.

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

@christinaausley christinaausley added the 8.6.0 October 2024 minor release label Oct 4, 2024
@christinaausley christinaausley self-assigned this Oct 4, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024

👋 🤖 🤔 Hello! 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.5/.

  • docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-incident-by-key-alpha.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-incidents-alpha.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-process-instances-alpha.api.mdx

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.

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Oct 4, 2024
jwulf
jwulf reviewed Oct 4, 2024
View reviewed changes
api/camunda/camunda-openapi.yaml
@@ -1889,9 +1889,9 @@ components:
endDate:
type: string
format: date-time
bpmnProcessId:
Copy link
Member

Choose a reason for hiding this comment

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

@nicpuppa - should this be here?

Copy link
Member

Choose a reason for hiding this comment

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

Looks like has been updated here: https://github.com/camunda/camunda/blob/main/zeebe/gateway-protocol/src/main/proto/rest-api.yaml#L2414

jwulf
jwulf reviewed Oct 4, 2024
View reviewed changes
api/camunda/camunda-openapi.yaml
@@ -1889,9 +1889,9 @@ components:
endDate:
type: string
format: date-time
bpmnProcessId:
processDefinitionId:
Copy link
Member

Choose a reason for hiding this comment

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

@christinaausley I'm not sure we can make this change here - this is the underlying specification and describes the actual operation of the API.

@github-actions github-actions bot temporarily deployed to camunda-docs October 4, 2024 14:27 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs October 4, 2024 14:48 Destroyed
@pepopowitz pepopowitz added the hold This issue is parked, do not merge. label Oct 4, 2024
@pepopowitz
Copy link
Collaborator

I added a hold label to this PR, because from Slack it sounds like these functional changes are not in place at the source yet, at least not for the 8.6 release.

If/when we hear that the 8.6 release has been updated with spec changes, I will come back here and update the spec accordingly.

pepopowitz
pepopowitz reviewed Oct 4, 2024
View reviewed changes
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

I noted one more field name change, which would break the docs for users if

api/camunda/camunda-openapi.yaml
@@ -1935,7 +1935,7 @@ components:
processDefinitionVersion:
type: integer
format: int32
bpmnProcessId:
processDefinitionId:
Copy link
Collaborator

Choose a reason for hiding this comment

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

❌ This is another actual field name change. I don't think this should be here, unless we're certain it's in the actual 8.6 api.

@github-actions github-actions bot temporarily deployed to camunda-docs October 4, 2024 15:07 Destroyed
@christinaausley
Copy link
Contributor Author

Closing based on conversation here.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024

🧹 Preview environment for this PR has been torn down.

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

@jwulf jwulf jwulf left review comments

@pepopowitz pepopowitz pepopowitz left review comments

Assignees

@christinaausley christinaausley

Labels
8.6.0 October 2024 minor release deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@christinaausley @pepopowitz @jwulf