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 #4292

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Update camunda REST API doc #4292

merged 2 commits into from
Sep 12, 2024

Conversation

github-actions[bot]
Copy link
Contributor

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 Sep 12, 2024
@tmetzke tmetzke requested review from pepopowitz and a team September 12, 2024 14:41
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.

Only one very small detail I noticed in the updated spec!!! I'll merge after I get CI to run on this PR (#4261 is still a problem).

api/camunda/camunda-openapi.yaml Show resolved Hide resolved
Copy link
Contributor Author

👋 🤖 🤔 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/broadcast-signal.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/cancel-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/correlate-a-message.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-document-link-experimental.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-resource.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/deploy-resources.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/find-all-users.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-decision-definition-xml-experimental.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/patch-authorization.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/pin-internal-clock-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/publish-a-message.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-decision-requirements-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-incident-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-process-instances-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/reset-internal-clock-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.js
  • docs/apis-tools/camunda-api-rest/specifications/update-element-instance-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/upload-document-experimental.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.

@pepopowitz pepopowitz enabled auto-merge (squash) September 12, 2024 18:46
@pepopowitz pepopowitz self-assigned this Sep 12, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 12, 2024 18:49 Destroyed
@pepopowitz pepopowitz merged commit fcb5d44 into main Sep 12, 2024
7 checks passed
@pepopowitz pepopowitz deleted the update-rest-doc branch September 12, 2024 18:49
Copy link
Contributor Author

The preview environment relating to the commit 213f636 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4292/index.html

@pepopowitz
Copy link
Collaborator

✅ all follow-ups taken care of.

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.

2 participants