From bc8e6af2232e13f37db783c4c0e7509e91a86046 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Fri, 23 May 2025 17:25:17 +0200 Subject: [PATCH] update admin API documentation --- doc/api/garage-admin-v0.html | 2 +- doc/api/garage-admin-v1.html | 2 +- doc/api/garage-admin-v2.html | 2 +- doc/api/garage-admin-v2.json | 6 ++++++ doc/drafts/admin-api.md | 5 ++++- 5 files changed, 13 insertions(+), 4 deletions(-) diff --git a/doc/api/garage-admin-v0.html b/doc/api/garage-admin-v0.html index 4949cc37..7eb11f25 100644 --- a/doc/api/garage-admin-v0.html +++ b/doc/api/garage-admin-v0.html @@ -1,7 +1,7 @@ - Garage adminstration API v0 + Garage administration API v0 diff --git a/doc/api/garage-admin-v1.html b/doc/api/garage-admin-v1.html index a9708e92..e98306b8 100644 --- a/doc/api/garage-admin-v1.html +++ b/doc/api/garage-admin-v1.html @@ -1,7 +1,7 @@ - Garage adminstration API v1 + Garage administration API v1 diff --git a/doc/api/garage-admin-v2.html b/doc/api/garage-admin-v2.html index 0911f205..b079e760 100644 --- a/doc/api/garage-admin-v2.html +++ b/doc/api/garage-admin-v2.html @@ -1,7 +1,7 @@ - Garage adminstration API v2 + Garage administration API v2 diff --git a/doc/api/garage-admin-v2.json b/doc/api/garage-admin-v2.json index 4e07ed68..210b5559 100644 --- a/doc/api/garage-admin-v2.json +++ b/doc/api/garage-admin-v2.json @@ -3973,6 +3973,12 @@ "$ref": "#/components/schemas/ScrubCommand" } } + }, + { + "type": "string", + "enum": [ + "aliases" + ] } ] }, diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md index 0613c535..18dfb627 100644 --- a/doc/drafts/admin-api.md +++ b/doc/drafts/admin-api.md @@ -15,7 +15,10 @@ when changes are introduced. The Garage administration API was introduced in version 0.7.2, and was changed several times. -This document applies only to the Garage v2 API (starting with Garage v2.0.0). + +**THIS DOCUMENT IS DEPRECATED.** We now have an OpenAPI spec which is automatically generated +from Garage's source code and is always up-to-date. See `doc/api/garage-admin-v2.html`. +Text in this document is no longer kept in sync with the admin API's actual behavior. ## Access control