From 131e4d9ee44609d4be96a2f2a2378bfc32320ff0 Mon Sep 17 00:00:00 2001 From: dantb Date: Mon, 2 Oct 2023 14:27:37 +0200 Subject: [PATCH] Docs for org deletion --- .../delta/api/assets/organizations/delete.sh | 2 ++ docs/src/main/paradox/docs/delta/api/orgs-api.md | 16 ++++++++++++++++ .../paradox/docs/releases/v1.9-release-notes.md | 6 ++++++ 3 files changed, 24 insertions(+) create mode 100644 docs/src/main/paradox/docs/delta/api/assets/organizations/delete.sh diff --git a/docs/src/main/paradox/docs/delta/api/assets/organizations/delete.sh b/docs/src/main/paradox/docs/delta/api/assets/organizations/delete.sh new file mode 100644 index 0000000000..6d65f15bb9 --- /dev/null +++ b/docs/src/main/paradox/docs/delta/api/assets/organizations/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE \ + "http://localhost:8080/v1/orgs/myorg?prune=true" \ No newline at end of file diff --git a/docs/src/main/paradox/docs/delta/api/orgs-api.md b/docs/src/main/paradox/docs/delta/api/orgs-api.md index 96bda1f17b..d246431cd2 100644 --- a/docs/src/main/paradox/docs/delta/api/orgs-api.md +++ b/docs/src/main/paradox/docs/delta/api/orgs-api.md @@ -89,6 +89,22 @@ Request Response : @@snip [deprecated.json](assets/organizations/deprecated.json) +## Delete + +Delete a organization containing no projects. If there is a project, returns 409 Conflict. + +``` +DELETE /v1/orgs/{label}?prune=true +``` + +... where + +- `{label}`: String - is the user friendly name that identifies this organization. + +**Example** + +Request +: @@snip [delete.sh](assets/organizations/deprecate.sh) ## Fetch (current version) diff --git a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md index d5d71099e5..2a997f5ff8 100644 --- a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md @@ -123,6 +123,12 @@ Creating an archive now requires only the `resources/read` permission instead of Tarball archives are no longer supported due to unnecessary restrictions. ZIP is now the only allowed format and clients should send `application/zip` in the `Accept` header when creating archives. +### Organizations + +#### Support deletion of empty organizations +Previously it was only possible to deprecate organizations at a specific revision. Now organizations containing no projects can be deleted by specifying a prune parameter: `DELETE /v1/org/{label}?prune=true` + + ### Storages ### Remote Storages