search

camunda / camunda-docs

Camunda 8 Documentation, including all components and features
https://docs.camunda.io/
Other
52 stars 180 forks source link

Document Zeebe broker admin endpoint #59

Closed npepinpe closed 1 year ago

npepinpe commented 3 years ago

Description

We removed the admin endpoint documentation from the upgrade guide, primarily to avoid confusing as we're working the way Zeebe can be upgraded. However, it's still useful to have this documented, and we should documented it separately (which can then be linked back in the upgrade guide).

Ideally, please document each endpoint, expected request format, expected response format, etc. Something similar (but not necessarily as thorough) as https://docs.github.com/en/free-pro-team@latest/rest/reference/actions.

akeller commented 3 years ago

Is this something that still needs work? I see a merged PR and wasn't sure.

akeller commented 3 years ago

@menski can you please assign someone to work on this?

akeller commented 2 years ago

Is this relevant anymore?

npepinpe commented 2 years ago

This is relevant for self managed customers, as the admin endpoint provides more observability. It's pretty advanced though, so I expect most users will not need to deal with it for now. We could close it until we want to approach it again.

megglos commented 1 year ago

Deepthi: We should move admin endpoints to the Gateway instead, and document it there.

Pauseprocessing, Streamprocessing and TakeSnapshot are left to move. @deepthidevaki will create a ticket for that.

Closing this as it's not worth doing under that perspective.