From e4ca484194a98a2b540ab0490c81fe4630456974 Mon Sep 17 00:00:00 2001 From: Johannes Nussbaum <39048939+jnussbaum@users.noreply.github.com> Date: Wed, 6 Dec 2023 14:10:43 +0100 Subject: [PATCH] docs: Clarify setting of restricted view of images (DEV-2961) (#2950) Co-authored-by: Balduin Landolt <33053745+BalduinLandolt@users.noreply.github.com> --- docs/03-endpoints/api-admin/projects.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/03-endpoints/api-admin/projects.md b/docs/03-endpoints/api-admin/projects.md index bc720aaf8c..102009a6f0 100644 --- a/docs/03-endpoints/api-admin/projects.md +++ b/docs/03-endpoints/api-admin/projects.md @@ -784,6 +784,7 @@ Example response: Permissions: ProjectAdmin Request definition: + - `GET /admin/projects/shortcode/{shortcode}/RestrictedViewSettings` - `GET /admin/projects/shortname/{shortname}/RestrictedViewSettings` - `GET /admin/projects/iri/{iri}/RestrictedViewSettings` @@ -831,12 +832,14 @@ size. Permissions: ProjectAdmin/SystemAdmin Request definition: + - `POST /admin/projects/iri/{iri}/RestrictedViewSettings` - `POST /admin/projects/shortcode/{shortcode}/RestrictedViewSettings` Description: Set the project's restricted view Required payload: + - `size` Example request: @@ -862,6 +865,8 @@ Example response: ``` Operates on the following properties: - - `knora-admin:projectRestrictedViewSize`: the IIIF size value - - `knora-admin:projectRestrictedViewWatermark`: the path to the watermark image. **Currently not used!** +- `knora-admin:projectRestrictedViewSize`: the IIIF size value +- `knora-admin:projectRestrictedViewWatermark`: the path to the watermark image. **Currently not used!** + +Note: Restricted view settings only take effect, if a user has "Restricted View" permission on an image.