Mark Query API as alpha feature instead of experimental
#22224
Assignees
Labels
component/c8-api
All things unified C8 API, e.g. C8 REST
component/gateway
component/zeebe
Related to the Zeebe component/team
kind/documentation
Categorizes an issue or PR as documentation related
scope/gateway
Marks an issue or PR to appear in the gateway section of the changelog
target:8.6
Issue must be completed before this target release
version:8.6.0
Label that represents issues released on version 8.6.0
Comments
12 tasks
tmetzke
added
scope/gateway
This was referenced Sep 12, 2024
github-merge-queue bot
pushed a commit
that referenced
this issue
Sep 13, 2024
## Description Documents experimental C8 REST endpoints as alpha features, not experimental. Alpha features are clearly defined in the reference documentation and contracts in contrast to experimental features. ## Checklist <!--- Please delete options that are not relevant. Boxes should be checked by reviewer. --> - [ ] for CI changes: - [ ] structural/foundational changes signed off by [CI DRI](https://github.com/cmur2) - [ ] [ci.yml](https://github.com/camunda/camunda/blob/main/.github/workflows/ci.yml) modifications comply with ["Unified CI" requirements](https://github.com/camunda/camunda/wiki/CI-&-Automation#workflow-inclusion-criteria) ## Related issues closes #22224
tmetzke
added
the
kind/documentation
3 tasks
|
Reopened to mark clock API as an alpha feature again. |
github-merge-queue bot
pushed a commit
that referenced
this issue
Sep 17, 2024
## Description Documents the clock REST API as an alpha feature since this is a preview feature that may be subject to change. ## Checklist <!--- Please delete options that are not relevant. Boxes should be checked by reviewer. --> - [ ] for CI changes: - [ ] structural/foundational changes signed off by [CI DRI](https://github.com/cmur2) - [ ] [ci.yml](https://github.com/camunda/camunda/blob/main/.github/workflows/ci.yml) modifications comply with ["Unified CI" requirements](https://github.com/camunda/camunda/wiki/CI-&-Automation#workflow-inclusion-criteria) ## Related issues closes #22224
tmetzke
added
the
version:8.6.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
The C8 REST Query API is currently documented as
experimentalin the OpenAPI specification.This terminology has no clear definition in the Camunda product stack.
Users cannot easily determine the implications of that flag.
However, alpha features are clearly documented and contractually defined.
We need to document the Query API and other experimental components as alpha features instead of naming them
experimental.The text was updated successfully, but these errors were encountered: