Skip to content

Conversation

@camunda-docs-pr-automation
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 Jan 8, 2026
@camunda-docs-pr-automation camunda-docs-pr-automation bot requested a review from a team January 8, 2026 15:10
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Jan 8, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

👋 🤖 🤔 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.8/.

  • docs/apis-tools/orchestration-cluster-api-rest/specifications/modify-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-audit-logs.api.mdx
  • docs/apis-tools/orchestration-cluster-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 January 8, 2026 15:16 Destroyed
Copy link
Collaborator

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Skim approval

@mesellings mesellings merged commit dbe260e into main Jan 12, 2026
12 checks passed
@mesellings mesellings deleted the update-rest-doc branch January 12, 2026 17:01
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Jan 12, 2026
@github-actions
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

{
type: "category",
label: "Cluster variable",
label: "Cluster Variable",
Copy link
Contributor

Choose a reason for hiding this comment

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

@mesellings I declined this change in a previous automatic PR because I believe it does not follow our sentence case style. See, for instance, “Decision definition” or “Decision instance” in the same section of the left navigation bar.

I’m wondering why, in this case, the auto PR is triggering this change - all of these section headings seem to be defined in the same way in the related sidebar.ts file (/apis-tools/orchestration-cluster-api-rest/specifications/sidebar.ts), using the "category" type.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah good spot @afgambin - I tend to skim approve these so we don't block the updates, but historically we don't have time to check the API reference docs in the team - let's chat to Tobias and the team at the kickoff and see how we can best tackle this now? It's not ideal, but as the API reference docs exist and are 'good enough', they were one of the things we first dropped priority-wise. I'll also add this as a theme for us to look at as a team.

Copy link
Contributor

Choose a reason for hiding this comment

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

sgtm, thank you!

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