Update camunda REST API doc #4256
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
Closing and re-opening so that CI kicks off (at least, I think that will trigger it) |
|
👋 🤖 🤔 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.5/.
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. |
(it didn't, at least not the build-docs check. But updating from |
github-actions
bot
force-pushed
the
update-rest-doc
branch
from
78a5767 to
46b8563
Compare
|
@pepopowitz I had a look at the errors, we need a scoped PAT if we want to add @camunda/tech-writers as reviewers (also for running the CI) Error: Unable to request reviewers. If requesting team reviewers a 'repo' scoped PAT is required. Let me know if you need any help |
Tracked at #4263. |
| running: | ||
| type: boolean | ||
| active: | ||
| type: boolean | ||
| incidents: | ||
| type: boolean | ||
| finished: | ||
| type: boolean | ||
| completed: | ||
| type: boolean | ||
| canceled: | ||
| type: boolean | ||
| retriesLeft: | ||
| type: boolean | ||
| errorMessage: | ||
| type: string | ||
| activityId: | ||
| type: string | ||
| startDate: | ||
| type: string | ||
| format: date-time | ||
| endDate: | ||
| type: string | ||
| format: date-time | ||
| bpmnProcessId: | ||
| type: string | ||
| processDefinitionVersion: | ||
| type: integer | ||
| format: int32 | ||
| variable: | ||
| allOf: | ||
| - $ref: "#/components/schemas/ProcessInstanceVariableFilterRequest" | ||
| batchOperationId: | ||
| type: string | ||
| parentProcessInstanceKey: | ||
| type: integer | ||
| format: int64 | ||
| tenantId: | ||
| type: string | ||
| ProcessInstanceVariableFilterRequest: | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| values: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/VariableValueFilterRequest" | ||
| type: string |
There was a problem hiding this comment.
category: missing descriptions
owner: API author
There was a problem hiding this comment.
@mihail-ca -- in a recent PR to the C8 REST API, you added or updated the following in the OpenAPI spec, each of which is missing description properties:
- ProcessInstanceFilterRequest schema
- ProcessInstanceVariableFilterRequest schema
- ProcessInstanceItem schema
- OperationItem schema
The descriptions are important because the docs ingest the spec from the camunda repo, and generate our API docs from it. I'm tagging you here in the camunda-docs repo, instead of the camunda repo, because that's where we (DevEx) noticed the descriptions missing.
Please add descriptions to these items, in the camunda repo's C8 REST OpenAPI spec. Your changes will eventually propagate downstream to the docs here.
For guidance on writing the descriptions, see here. If you have any questions, feel free to ask.
Thank you!
|
Merging this as-is, and following up with all my comments separately. |
|
🧹 Preview environment for this PR has been torn down. |
…cs (#22101) (Note that this is different from #22037, another recent PR which brought up different downstream changes.) ## Description This PR addresses a few small C8 REST API spec issues, which were identified in camunda/camunda-docs#4256. See that PR for original conversation on these changes.
|
✅ All feedback is accounted for in follow-ups, either directly tagging the original API authors, or in camunda/camunda#22101. |
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/).