Skip to content

Commit 079df17

Browse files
authored
Merge pull request #363 from saschaszott/saschaszott-patch-11
bundles.md: fix example URLs and clarify bitstream creation
2 parents cca6b69 + 5b827d4 commit 079df17

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

bundles.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Deleting a bundle will delete all bitstreams in the bundle
157157

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

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

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

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

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

169-
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
170-
171-
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams>
169+
Creates a new bitstream in the bundle with the given UUID
172170

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

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

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

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

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

309307
```
310-
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]"
308+
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]"
311309
```
312310

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

329327
```
330-
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]"
328+
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]"
331329
```
332330

333331
Status codes:

0 commit comments

Comments
 (0)