Docs for org deletion

BlueBrain · Oct 2, 2023 · 131e4d9 · 131e4d9
1 parent e3564a1
commit 131e4d9
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
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
@@ -0,0 +1,2 @@
+curl -X DELETE \
+   "http://localhost:8080/v1/orgs/myorg?prune=true"
diff --git 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
@@ -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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		curl -X DELETE \
		"http://localhost:8080/v1/orgs/myorg?prune=true"