Skip to content

Update camunda REST API doc #5594

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

Merged
merged 1 commit into from
Apr 21, 2025
Merged

Update camunda REST API doc #5594

merged 1 commit into from
Apr 21, 2025

Conversation

camunda-docs-pr-automation[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.

@camunda-docs-pr-automation camunda-docs-pr-automation bot added the deploy Stand up a temporary docs site with this PR label Apr 17, 2025
@camunda-docs-pr-automation camunda-docs-pr-automation bot requested review from pepopowitz and a team April 17, 2025 15:07
@akeller akeller moved this to 👀 In Review in Documentation Team Apr 17, 2025
Copy link
Contributor

👋 🤖 🤔 Hello, @camunda-docs-pr-automation[bot]! 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.7/.

  • docs/apis-tools/camunda-api-rest/specifications/cancel-process-instances-batch-operation.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-documents.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/create-element-instance-variables.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-batch-operation.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-element-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-definition-statistics.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-instance-statistics.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-process-instance.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/resolve-incidents-batch-operation.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-ad-hoc-subprocess-activities.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-batch-operations.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-element-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-groups.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-incidents.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-mappings-for-tenant.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-mappings.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/search-process-instances.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.ts

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.

@github-actions github-actions bot temporarily deployed to camunda-docs April 17, 2025 15:17 Destroyed
- $ref: "#/components/schemas/ProcessInstanceFilterFields"
- type: object
properties:
$or:
Copy link
Contributor

Choose a reason for hiding this comment

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

Just confirming that this mix of markdown & html renders well in the docs:

image

@pepopowitz pepopowitz merged commit 1f62ff4 into main Apr 21, 2025
11 of 12 checks passed
@pepopowitz pepopowitz deleted the update-rest-doc branch April 21, 2025 14:57
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Apr 21, 2025
Copy link
Contributor

🧹 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.

2 participants