Update camunda REST API doc #4534
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
github-actions
bot
force-pushed
the
update-rest-doc
branch
from
f5ecb4b
to
3ecef47
Compare
|
👋 🤖 🤔 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/.
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
force-pushed
the
update-rest-doc
branch
from
0c77e53
to
eb0fdf0
Compare
| tags: | ||
| - name: Authorization | ||
| - name: Clock | ||
| - name: Cluster | ||
| - name: Decision definition | ||
| - name: Decision instance | ||
| - name: Decision requirements | ||
| - name: Document | ||
| - name: Element instance | ||
| - name: Flow node instance | ||
| - name: Incident | ||
| - name: Job | ||
| - name: License | ||
| - name: Message | ||
| - name: Process definition | ||
| - name: Process instance | ||
| - name: Resource | ||
| - name: Signal | ||
| - name: User | ||
| - name: User task | ||
| - name: Variable |
There was a problem hiding this comment.
❤️
As @tmetzke pointed out in the PR at the source, a side-effect of defining these tags is that the sidebar nav will always generate in this order.
| responses: | ||
| "200": | ||
| description: > | ||
| The user task varialbes search successful response. |
There was a problem hiding this comment.
| The user task varialbes search successful response. | |
| The user task variables search successful response. |
spelling error. I'll correct this at the source.
api/camunda/camunda-openapi.yaml
Outdated
| summary: Pin internal clock (alpha) | ||
| description: | | ||
| Set a precise, static time for the Zeebe engine’s internal clock. | ||
| When the clock is pinned, it remains at the specified time and does not advance. | ||
| To change the time, the clock must be pinned again with a new timestamp. | ||
|
|
||
| :::note | ||
| This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change | ||
| This endpoint is an [alpha feature](/reference/alpha-features.md) and may be subject to change |
There was a problem hiding this comment.
This is reverting changes in #4465. I'll need to adjust this in this in this PR, because it is a broken link. I'll also propagate the changes from #4465 upstream.
@christinaausley @akeller FYI this is the kind of change that needs to be duplicated in the camunda/camunda repo, or else it's going to be wiped out every time the API docs are re-generated.
| paths: | ||
| /topology: | ||
| get: | ||
| tags: | ||
| - Cluster | ||
| operationId: getTopology |
There was a problem hiding this comment.
Surprisingly, adding operationIds to the endpoints causes them to generate in a different file path. This isn't a problem, just not something I was expecting.
I will make a note for myself in the htaccess as part of this PR, pointing back here, because at time of the next release I will need to create a bunch of redirect rules for everything that moved.
There was a problem hiding this comment.
Oh yeah, I should have given you a heads-up, I missed that. The long-term benefit with this is: the file path and URL is now based on the operation id instead of the path summary (which can easily change). Thus, URLs will be more stable from now on.
|
Changes made upstream in camunda/camunda#24190. |
|
🧹 Preview environment for this PR has been torn down. |
| # Disclaimer: This is a modified version of the Camunda REST API specification, optimized for the documentation. | ||
|
|
||
| # Disclaimer: This is a modified version of the Camunda REST API specification, optimized for the documentation. | ||
|
|
There was a problem hiding this comment.
Hmm, interesting that we have this duplicated in here now 😅
Not a big deal, of course, it's just a comment in the spec file in the docs, not the source.
There was a problem hiding this comment.
oh, fun! I know why that happened. I re-generated the docs in this branch, and it added that comment both times.
I'll fix this for the future!
## Description Pulls multiple changes discussed in camunda/camunda-docs#4534 into the OpenAPI spec.
## Description Pulls multiple changes discussed in camunda/camunda-docs#4534 into the OpenAPI spec.
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?
PR Checklist
/docsdirectory (aka/next/).