Skip to content

[Port dspace-10_x] bundles.md: fix example URLs and clarify bitstream creation #367

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

Merged
tdonohue merged 1 commit into from
Jul 21, 2026
Merged

[Port dspace-10_x] bundles.md: fix example URLs and clarify bitstream creation #367

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
18 changes: 8 additions & 10 deletions bundles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Deleting a bundle will delete all bitstreams in the bundle

**GET /api/core/bundles/<:uuid>/bitstreams**

Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams>
Example: <https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams>

It returns the bitstreams within this bundle. See the [bitstream endpoint](bitstreams.md#Single-Bitstream) for more info

Expand All @@ -166,9 +166,7 @@ The supported parameters are:

**POST /api/core/bundles/<:uuid>/bitstreams**

TODO: the item has to be known as well when creating a new bitstream. See https://jira.duraspace.org/browse/DS-4317?focusedCommentId=63099&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-63099

Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams>
Creates a new bitstream in the bundle with the given UUID

Curl example:
```
Expand All @@ -179,9 +177,9 @@ curl 'https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d3
-F 'properties={ "name": "test.html", "metadata": { "dc.description": [ { "value": "example file", "language": null, "authority": null, "confidence": -1, "place": 0 } ]}, "bundleName": "ORIGINAL" };type=application/json'
```

* The item is determined using the ID in the URL
* The file is uploaded using multipart/form-data
* The metadata of the bitstream is included as a json property, and with layout, it looks like:
* The item is determined by the bundle UUID in the URL
* The file is uploaded using `multipart/form-data`
* The metadata of the new bitstream is included as a JSON property:
```json
{
"name": "test.html",
Expand All @@ -204,7 +202,7 @@ The bitstream properties can contain:

It returns the created bitstream. See the bitstream endpoint for more info](bitstreams.md#Single Bitstream)

The REST API can support Content-Length and Content-MD5 headers to verify integrity
The REST API can support `Content-Length` and `Content-MD5` HTTP headers to verify integrity.

Status codes:
* 201 Created - if the operation succeed
Expand Down Expand Up @@ -307,7 +305,7 @@ If the Primary bitstream doesn't exist, it can be created using a POST
This should use `Content-Type:text/uri-list` with a single URI value which represents the new Bitstream to mark as primary.

```
curl -i -X POST "https://demo7.dspace.org/api/core/bundles/[uuid]/primaryBitstream" -H "Content-type:text/uri-list" -d "https://demo7.dspace.org/api/core/bitstreams/[uuid]"
curl -i -X POST "https://demo.dspace.org/api/core/bundles/[uuid]/primaryBitstream" -H "Content-type:text/uri-list" -d "https://demo.dspace.org/api/core/bitstreams/[uuid]"
```

Status codes:
Expand All @@ -327,7 +325,7 @@ If the Primary bitstream already exists, it can be changed using a PUT
This should use `Content-Type:text/uri-list` with a single URI value which represents the new Bitstream to mark as primary.

```
curl -i -X PUT "https://demo7.dspace.org/api/core/bundles/[uuid]/primaryBitstream" -H "Content-type:text/uri-list" -d "https://demo7.dspace.org/api/core/bitstreams/[uuid]"
curl -i -X PUT "https://demo.dspace.org/api/core/bundles/[uuid]/primaryBitstream" -H "Content-type:text/uri-list" -d "https://demo.dspace.org/api/core/bitstreams/[uuid]"
```

Status codes:
Expand Down