Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update admin documentation #2328

Merged
merged 3 commits into from Dec 7, 2022
Merged

docs: update admin documentation #2328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d962caa
get rid of ancient TODO
BalduinLandolt Dec 7, 2022
347cecd
add missing content to admin overview
BalduinLandolt Dec 7, 2022
25383bf
add (very minimal) content to admin stores endpoint documentation
BalduinLandolt Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/03-endpoints/api-admin/introduction.md
View file
Open in desktop
Expand Up @@ -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).
22 changes: 11 additions & 11 deletions docs/03-endpoints/api-admin/overview.md
View file
Open in desktop
Expand Up @@ -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.
4 changes: 4 additions & 0 deletions docs/03-endpoints/api-admin/stores.md
View file
Open in desktop
Expand Up @@ -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.