diff options
| author | Alex <alex@adnab.me> | 2023-11-29 15:42:46 +0000 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2023-11-29 15:42:46 +0000 |
| commit | a8b0e01f88b947bc34c05d818d51860b4d171967 (patch) | |
| tree | 874f7a7c85901b96d1d8b725a3abf2ddb65c9d64 /doc/book/reference-manual/admin-api.md | |
| parent | ffa659433d45d5186acc618134c5561bf9b21f37 (diff) | |
| parent | 80886906507ba12586874ec66ef683139108cbcf (diff) | |
| download | garage-a8b0e01f88b947bc34c05d818d51860b4d171967.tar.gz garage-a8b0e01f88b947bc34c05d818d51860b4d171967.zip | |
Merge pull request 'OpenAPI specification of admin APIv1' (#672) from api-v1 into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/672
Diffstat (limited to 'doc/book/reference-manual/admin-api.md')
| -rw-r--r-- | doc/book/reference-manual/admin-api.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/book/reference-manual/admin-api.md b/doc/book/reference-manual/admin-api.md index 6932ac60..15630788 100644 --- a/doc/book/reference-manual/admin-api.md +++ b/doc/book/reference-manual/admin-api.md @@ -13,8 +13,11 @@ We will bump the version numbers prefixed to each API endpoint at each time the or semantics change, meaning that code that relies on these endpoint will break when changes are introduced. -The Garage administration API was introduced in version 0.7.2, this document -does not apply to older versions of Garage. +Versions: + - Before Garage 0.7.2 - no admin API + - Garage 0.7.2 - admin APIv0 + - Garage 0.9.0 - admin APIv1, deprecate admin APIv0 + ## Access control @@ -131,7 +134,9 @@ $ curl -so /dev/null -w "%{http_code}" http://localhost:3903/check?domain=exampl ### Cluster operations -These endpoints are defined on a dedicated [Redocly page](https://garagehq.deuxfleurs.fr/api/garage-admin-v0.html). You can also download its [OpenAPI specification](https://garagehq.deuxfleurs.fr/api/garage-admin-v0.yml). +These endpoints have a dedicated OpenAPI spec. + - APIv1 - [HTML spec](https://garagehq.deuxfleurs.fr/api/garage-admin-v1.html) - [OpenAPI YAML](https://garagehq.deuxfleurs.fr/api/garage-admin-v1.yml) + - APIv0 (deprecated) - [HTML spec](https://garagehq.deuxfleurs.fr/api/garage-admin-v0.html) - [OpenAPI YAML](https://garagehq.deuxfleurs.fr/api/garage-admin-v0.yml) Requesting the API from the command line can be as simple as running: |