public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add Additional /apis Versioning Guidance (#109134)

Browse Source 
* [docs] Add extra guidance for new /apis versioning.

* Fix typo

* fix typo

* Run prettier on changes.

* Update docs/sources/developers/http_api/apis.md

Co-authored-by: Igor Suleymanov <radiohead@users.noreply.github.com>

* Update docs/sources/developers/http_api/apis.md

Co-authored-by: Igor Suleymanov <radiohead@users.noreply.github.com>

* Update docs/sources/developers/http_api/apis.md

Co-authored-by: Igor Suleymanov <radiohead@users.noreply.github.com>

* Run prettier on doc

---------

Co-authored-by: Irene Rodríguez <irene.rodriguez@grafana.com>
Co-authored-by: Igor Suleymanov <radiohead@users.noreply.github.com>
This commit is contained in:
Austin Pond
2025-10-21 09:22:28 -04:00
committed by GitHub
co-authored by Igor Suleymanov Irene Rodríguez
parent e8d4c63071
commit 6851ca2988
1 changed files with 21 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/apis.md
+21 -5
View File
@@ -42,11 +42,27 @@ Groups organize related functionality into logical collections. For example `das
These APIs will also uses semantic versioning with three stability levels:
| Level | Format | Description | Use Case |
| ----- | ---------- | --------------------------------------------------------------------------- | ------------------------ |
| Alpha | `v1alpha1` | Early development stage. Unstable, may contain bugs, and subject to removal | For testing new features |
| Beta | `v1beta1` | More stable than alpha, but may still have some changes | For early production use |
| GA | `v1` | Generally Available. Stable with backward compatibility guarantees | For production use |
| Level | Format | Description | Use Case | Enabled By Default? |
| ----- | ---------- | --------------------------------------------------------------------------- | ------------------------ | ------------------- |
| Alpha | `v1alpha1` | Early development stage. Unstable, may contain bugs, and subject to removal | For testing new features | No |
| Beta | `v1beta1` | More stable than alpha, but may still have some changes | For non-critical use | No |
| GA | `v1` | Generally Available. Stable with backward compatibility guarantees | For production use | Yes |
#### Alpha
Alpha versions should not be served unless explicitly enabled by a feature flag, and should be considered completely experimental and subject to major changes.
An alpha version may undergo breaking changes without adding an additional version, and should not be relied upon by production workflows. Alpha versions may be removed completely, even without being promoted to a more stable level (e.g. an experimental API may be introduced as alpha for a new feature and subsequently removed completely, in case that feature gets canceled).
#### Beta
Beta versions should not contain breaking changes in the schema, but still may be subject to changes in handling logic or semantics.
Breaking schema changes require a new published beta version (such as publishing `v1beta2` for breaking changes to the `v1beta1` schema).
While beta versions are no longer considered experimental like alpha versions, they should still be disabled by default.
#### GA
GA versions are enabled by default, and can be treated as completely stable. The only changes that can be made to these APIs are bug fixes,
and any other changes should instead result in a new published version of the API.
### Namespace (`<namespace>`)