Skip to content

Commit

Permalink
docs: Clarify setting of restricted view of images (DEV-2961) (#2950)
Browse files Browse the repository at this point in the history
Co-authored-by: Balduin Landolt <33053745+BalduinLandolt@users.noreply.github.com>
  • Loading branch information
jnussbaum and BalduinLandolt committed Dec 6, 2023
1 parent 1e14a88 commit e4ca484
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/03-endpoints/api-admin/projects.md
Expand Up @@ -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`
Expand Down Expand Up @@ -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:
Expand All @@ -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.

0 comments on commit e4ca484

Please sign in to comment.