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

Closed
wants to merge 2 commits into from
Closed

Update camunda REST API doc #4506

wants to merge 2 commits into from

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 Oct 24, 2024
tmetzke
tmetzke previously approved these changes Oct 24, 2024
@tmetzke tmetzke enabled auto-merge (squash) October 24, 2024 11:22
@tmetzke tmetzke added deploy Stand up a temporary docs site with this PR component:zeebe Issues related with Zeebe project and removed deploy Stand up a temporary docs site with this PR labels Oct 24, 2024
@tmetzke tmetzke disabled auto-merge October 24, 2024 13:23
@tmetzke
Copy link
Member

tmetzke commented Oct 24, 2024

@pepopowitz, any idea why the build-docs check is not running?

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.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/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-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-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/sidebar.js
  • 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.

Copy link
Contributor Author

🚧 The preview environment for the commit 91c9848 is being built. This usually takes 15-20 minutes.

@akeller
Copy link
Member

akeller commented Oct 24, 2024

@pepopowitz, any idea why the build-docs check is not running?

I updated the branch @tmetzke and it looks like it's running as expected.

@pepopowitz
Copy link
Collaborator

@pepopowitz, any idea why the build-docs check is not running?

This is our old friend, #4261, which I have not had a chance to resolve yet.

@tmetzke
Copy link
Member

tmetzke commented Oct 25, 2024

@pepopowitz, any idea why the build-docs check is not running?

This is our old friend, #4261, which I have not had a chance to resolve yet.

Ah, yes, of course, looks like I successfully managed to erase that one from my memory. Looks like one of those issues where you'd hope it resolves itself but somehow nobody magically comes along and solves it 🤷

@pepopowitz
Copy link
Collaborator

I'm going to regenerate this. I'm not sure what's up with the merge conflicts here, and I suspect a fresh PR might clear them up.

@pepopowitz pepopowitz closed this Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants