Skip to content

Commit 99a2955

Browse files
authored
docs: recommend the sync workflow for changes to C8 REST API vNext (#5113)
1 parent 79e5485 commit 99a2955

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

howtos/interactive-api-explorers.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,22 @@ The source for each API's instance lives in an identifying folder within the `/a
2020

2121
## Updating an OpenAPI spec
2222

23-
### Regenerate the docs for the Next version of an API
23+
### Automatic synchronization (applies only to the Next version of the C8 REST API)
24+
25+
[A workflow](https://github.com/camunda/camunda-docs/actions/workflows/sync-rest-api-docs.yaml) is configured to synchronize the "next" version of the REST API docs, scheduled on a weekly basis. The workflow pulls the specification from [the upstream camunda/camunda repo's `main` branch](https://github.com/camunda/camunda/blob/main/zeebe/gateway-protocol/src/main/proto/rest-api.yaml), and re-generates the documentation for the "next" version based on that spec.
26+
27+
If you've made changes to the upstream `main` branch but do not require urgent documentation updates, you should wait for that scheduled workflow to incorporate your changes.
28+
29+
If you've made changes to the upstream `main` branch and require urgent documentation updates, you should trigger [that workflow](https://github.com/camunda/camunda-docs/actions/workflows/sync-rest-api-docs.yaml) manually.
30+
31+
### Regenerate the docs for the Next version of any API
2432

2533
1. Replace the OpenAPI spec file at `/api/[apiName]/[apiName]-openapi.yaml`.
2634
2. Regenerate the docs with this command:
2735
`npm run api:generate:[apiName]`
2836
3. Commit the changes, and open a PR.
2937

30-
### Regenerate the docs for a numbered version of an API
38+
### Regenerate the docs for a numbered version of any API
3139

3240
1. Replace the OpenAPI spec file at `/api/[apiName]/[version]/[apiName]-openapi.yaml`.
3341
2. Regenerate the docs with this command:

0 commit comments

Comments
 (0)