docs: update admin documentation (#2328)

dasch-swiss · Dec 7, 2022 · cedb603 · cedb603
1 parent a61f227
commit cedb603
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/docs/03-endpoints/api-admin/introduction.md b/docs/03-endpoints/api-admin/introduction.md
@@ -56,4 +56,4 @@ be sent as a part of the HTTP header or as parts of the URL (see
 
 ## Admin API Endpoints
 
-TODO
+An overview over all admin API endpoints can be found [here](overview.md).
diff --git a/docs/03-endpoints/api-admin/overview.md b/docs/03-endpoints/api-admin/overview.md
@@ -5,17 +5,17 @@
 
 # Admin Endpoint
 
-For the management of *users*, *projects*, and *groups*, the DSP-API
-following a resource centric approach, provides three endpoints
-corresponding to the three classes of objects that they have an effect
-on, namely:
+For the management of *users*, *projects*, *groups*, *lists*, and *permissions*, the DSP-API following a resource
+centric approach, provides the following endpoints corresponding to the respective classes of objects that they have an
+effect on, namely:
 
-  - Users Endpoint: `http://server:port/admin/users` - `knora-base:User`
-  - Projects Endpoint: `http://server:port/admin/projects` -
-    `knora-base:knoraProject`
-  - Groups Endpoint: `http://server:port/admin/groups` -
-    `knora-base:UserGroup`
+  - [Users endpoint](lists.md): `http://server:port/admin/users` - `knora-base:User`
+  - [Projects endpoint](projects.md): `http://server:port/admin/projects` - `knora-base:knoraProject`
+  - [Groups endpoint](groups.md): `http://server:port/admin/groups` - `knora-base:UserGroup`
+  - [Lists endpoint](lists.md): `http://server:port/admin/lists` - `knora-base:ListNode`
+  - [Permissions endpoint](permissions.md): `http://server:port/admin/permissions` - `knora-admin:Permission`
 
-All information regarding users, projects and groups is stored in the
-`http://www.knora.org/admin` named graph.
+All information regarding users, projects, groups, lists and permissions is stored in the `http://www.knora.org/admin`
+named graph.
 
+Additionally there is the [stores endpoint](stores.md) which allows manipulation of the triplestore content.
diff --git a/docs/03-endpoints/api-admin/stores.md b/docs/03-endpoints/api-admin/stores.md
@@ -5,3 +5,7 @@
 
 # Stores Endpoint
 
+This endpoint allows manipulation of the triplestore content.
+
+` POST admin/store/ResetTriplestoreContent` resets the triplestore content, given that the `allowReloadOverHttp`
+configuration flag is set to `true`. This route is mostly used in tests.