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 camunda REST API doc #4581

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Update camunda REST API doc #4581

merged 1 commit into from
Nov 8, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Nov 7, 2024

Description

This is an autogenerated PR by the sync api specs workflow.
This PR contains every changes made to the REST api specs in the monorepo in the last week.
This PR contains also all the generated OpenAPI files related to the changes.

When should this change go live?

  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for the next minor and are in /docs directory (aka /next/).
  • My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

@github-actions github-actions bot added the deploy Stand up a temporary docs site with this PR label Nov 7, 2024
pepopowitz
pepopowitz previously approved these changes Nov 7, 2024
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.

One spelling error to carry upstream; this PR also demonstrates that the recently-merged #4579 works as expected, as it added :::note admonitions in all the places they previously existed. cc @akeller

@@ -949,6 +949,7 @@ paths:
:::note
This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change
in future releases.
:::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice, I think what happened here is that (1) the previous version had the note added by hand, and missed the closing tag...and then (2) this version, which had the note added by the generation process, filled it in correctly.

@@ -3962,6 +3967,14 @@ components:
licenseType:
description: Will return the license type property of the Camunda license
type: string
isCommercial:
description: Will be false when a license contains a non-commerical=true property
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: Will be false when a license contains a non-commerical=true property
description: Will be false when a license contains a non-commercial=true property

spelling error -- I'll fix this upstream.

Copy link
Contributor Author

github-actions bot commented Nov 7, 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.6/.

  • docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/broadcast-signal.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/correlate-message.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-deployment.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-document.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-user.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-document.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/delete-resource.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/evaluate-decision.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-authorizations.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-definitions.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-decision-requirements.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-flow-node-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-incidents.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-process-definitions.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-process-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-authorizations.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-task-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-user-tasks.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-users.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-definition.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-requirements.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-document.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-flow-node-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-license.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-definition-xml.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-definition.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-start-process-form.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-topology.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-user-task-form.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-variable.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/migrate-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/modify-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/pin-clock.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/publish-message.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/report-job-error.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/reset-clock.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-authorization.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-user-task.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.

@camunda-docs-pr-automation camunda-docs-pr-automation bot requested review from pepopowitz and a team November 7, 2024 21:12
@github-actions github-actions bot temporarily deployed to camunda-docs November 7, 2024 21:29 Destroyed
@pepopowitz pepopowitz merged commit 9fd4749 into main Nov 8, 2024
8 checks passed
@pepopowitz pepopowitz deleted the update-rest-doc branch November 8, 2024 18:16
Copy link
Contributor Author

github-actions bot commented Nov 8, 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
Labels
deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants