Skip to content

Document consistent not-found responses for Items and Bitstreams #375

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

Open
Zsolt05 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document consistent not-found responses for Items and Bitstreams #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion bitstreams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ Exposed links:
* bundle: link to the bundle, not embedded
* thumbnail: the thumbnail of the bitstream

Status codes:
* 200 OK - if the bitstream is found and its metadata is visible to the current user or the anonymous user
* 401 Unauthorized - if the bitstream exists, but you are not authenticated and its metadata is not visible to anonymous users
* 403 Forbidden - if the bitstream exists, but you are not logged in with sufficient permissions to see its metadata
* 404 Not Found - if the identifier is malformed, the bitstream doesn't exist, or the UUID belongs to a different type of DSpace object

Comment on lines +36 to +41
## Patch operations

Bitstream metadata can be modified as described in [Modifying metadata via Patch](metadata-patch.md).
Expand Down Expand Up @@ -255,4 +261,4 @@ The `PATCH` request body includes the UUIDs of the bitstreams to be deleted.
"path": "/bitstreams/5a3f7c7a-d3df-419c-8a2-f00ede62c60a"
}
]
```
```
6 changes: 3 additions & 3 deletions items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ Exposed links:

Status codes:
* 200 OK - if the item is found and it is visible to the current user or the anonymous user. Withdrawn items are returned
* 401 Unauthorized - if you are not authenticated and the item is not visible to anonymous users
* 403 Forbidden - if you are not logged in with sufficient permissions. Please note that withdrawn items are visible to everyone without any metadata details
* 404 Not found - if the item doesn't exist
* 401 Unauthorized - if the item exists, but you are not authenticated and it is not visible to anonymous users
* 403 Forbidden - if the item exists, but you are not logged in with sufficient permissions. Please note that withdrawn items are visible to everyone without any metadata details
* 404 Not Found - if the identifier is malformed, the item doesn't exist, or the UUID belongs to a different type of DSpace object
Comment on lines +96 to +98

### Withdrawn item
A withdrawn item is a normal item that has been retired from the repository using a patch operation as described below. Once withdrawn the response will show an empty metadata section to everyone except than administrators.
Expand Down