Skip to content

Commit

Permalink
Merge pull request #238 from alanorth/dspace7-demo-url
Browse files Browse the repository at this point in the history
Replace references to api7.dspace.org
  • Loading branch information
kshepherd authored Sep 30, 2023
2 parents 431a013 + 0fd32b1 commit 128f6bf
Show file tree
Hide file tree
Showing 30 changed files with 245 additions and 245 deletions.
2 changes: 1 addition & 1 deletion authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This endpoint only accepts the `POST` method. Parameters and body structure depe

A `WWW-Authenticate` header is returned listing the different authentication method supported by the system.
Below an example listing the password and shibboleth authentication:
`WWW-Authenticate: shibboleth realm="DSpace REST API", location="https://api7.dspace.org/Shibboleth.sso/Login?target=https%3A%2F%2Fapi7.dspace.org", password realm="DSpace REST API"`
`WWW-Authenticate: shibboleth realm="DSpace REST API", location="https://demo.dspace.org/Shibboleth.sso/Login?target=https%3A%2F%2Fdemo.dspace.org", password realm="DSpace REST API"`

Return codes
- 200 Ok. If the authentication succeed. The JWT will be returned in the response Header Authorization.
Expand Down
2 changes: 1 addition & 1 deletion bitstreamformats.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Provide access to the bitstream formats defined in the registry (DBMS based). It returns the list of existent metadata fields.

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/bitstreamformats>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bitstreamformats>

**POST /api/core/bitstreamformats**

Expand Down
10 changes: 5 additions & 5 deletions bitstreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Bitstream metadata can be modified as described in [Modifying metadata via Patch
### Format
**GET /api/core/bitstreams/<:uuid>/format**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/format>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/format>

It returns the format of the bitstream

Expand All @@ -51,7 +51,7 @@ Update the bitstream format of the bitstream

Sample CURL command:
```
curl -i -X PUT 'https://api7.dspace.org/server/api/core/bitstreams/6ba01288-8a5a-4acf-96f1-fd0730424a1f/format' -H 'Authorization: Bearer eyJhbGciO…' -H "Content-Type:text/uri-list" --data 'https://api7.dspace.org/server/api/core/bitstreamformats/6'
curl -i -X PUT 'https://demo.dspace.org/server/api/core/bitstreams/6ba01288-8a5a-4acf-96f1-fd0730424a1f/format' -H 'Authorization: Bearer eyJhbGciO…' -H "Content-Type:text/uri-list" --data 'https://demo.dspace.org/server/api/core/bitstreamformats/6'
```

The uri-list should always contain exactly 1 bitstream format. This bitstream format will be assigned to the bitstream
Expand All @@ -73,7 +73,7 @@ Keep in mind that there's a change to dc.format in the API related to bitstream
### Bundle
**GET /api/core/bitstreams/<:uuid>/bundle**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/bundle>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/bundle>

It returns the bundle of the bitstream

Expand All @@ -83,7 +83,7 @@ Move the bitstream to another bundle

Sample CURL command:
```
curl -i -X PUT 'https://api7.dspace.org/server/api/core/bitstreams/6ba01288-8a5a-4acf-96f1-fd0730424a1f/bundle' -H 'Authorization: Bearer eyJhbGciO…' -H "Content-Type:text/uri-list" --data 'https://api7.dspace.org/server/api/core/bundles/0b3c0ebf-83bc-4017-afa1-9df37a1a065c'
curl -i -X PUT 'https://demo.dspace.org/server/api/core/bitstreams/6ba01288-8a5a-4acf-96f1-fd0730424a1f/bundle' -H 'Authorization: Bearer eyJhbGciO…' -H "Content-Type:text/uri-list" --data 'https://demo.dspace.org/server/api/core/bundles/0b3c0ebf-83bc-4017-afa1-9df37a1a065c'
```

The uri-list should always contain exactly 1 bitstream format. This bitstream format will be assigned to the bitstream
Expand All @@ -98,7 +98,7 @@ Error codes:
### Content
**/api/core/bitstreams/<:uuid>/content**

Example: <https://api7.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/content>
Example: <https://demo.dspace.org/server/api/core/bitstreams/8d33bdfb-e7ba-43e6-a93a-f445b7e8a1e2/content>

It returns the actual content (bits) described by the bitstream

Expand Down
2 changes: 1 addition & 1 deletion browses.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ It returns a collection of BrowseEntryResource the JSON document looks like
"count": 1,
"_links": {
"items": {
"href": "https://api7.dspace.org/server/api/discover/browses/author/items?filterValue=Arulmozhiyal, Ramaswamy"
"href": "https://demo.dspace.org/server/api/discover/browses/author/items?filterValue=Arulmozhiyal, Ramaswamy"
}
}
},
Expand Down
34 changes: 17 additions & 17 deletions bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ Provide detailed information about a specific bundle. A sample JSON response doc
"type": "bundle",
"_links" : {
"primarybitstream" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/ac49f361-4ffd-47a4-8eb2-e6c73c3f3e76"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/ac49f361-4ffd-47a4-8eb2-e6c73c3f3e76"
},
"bitstreams" : {
"href" : "https://api7.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams"
"href" : "https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams"
},
"item" : {
"href" : "https://api7.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/item"
"href" : "https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/item"
},
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb"
"href" : "https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb"
}
},
"_embedded" : {
Expand Down Expand Up @@ -79,13 +79,13 @@ Provide detailed information about a specific bundle. A sample JSON response doc
"type" : "bitstream",
"_links" : {
"content" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14/content"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14/content"
},
"format" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14/format"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14/format"
},
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
}
}
}, {
Expand Down Expand Up @@ -125,13 +125,13 @@ Provide detailed information about a specific bundle. A sample JSON response doc
"type" : "bitstream",
"_links" : {
"content" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc/content"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc/content"
},
"format" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc/format"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc/format"
},
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
}
}
}
Expand All @@ -157,7 +157,7 @@ Deleting a bundle will delete all bitstreams in the bundle

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

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams>
Example: <https://demo.dspace.org/server/#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 @@ -168,11 +168,11 @@ The supported parameters are:

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

Curl example:
```
curl 'https://api7.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams' \
curl 'https://demo.dspace.org/server/api/core/bundles/d3599177-0408-403b-9f8d-d300edd79edb/bitstreams' \
-XPOST -H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer eyJhbGciOiJI...' \
-F "file=@Downloads/test.html" \
Expand Down Expand Up @@ -231,15 +231,15 @@ Current list of bitstreams:
"uuid" : "1ce6db0e-662f-4a13-ba87-c371ad664b14",
"_links" : {
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
}
}
}, {
"id" : "4dd9621f-a464-4192-bc17-d70f68845bdc",
"uuid" : "4dd9621f-a464-4192-bc17-d70f68845bdc",
"_links" : {
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
}
}
}
Expand Down Expand Up @@ -269,7 +269,7 @@ New list of bitstreams:
"uuid" : "4dd9621f-a464-4192-bc17-d70f68845bdc",
"_links" : {
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc"
}
}
},
Expand All @@ -278,7 +278,7 @@ New list of bitstreams:
"uuid" : "1ce6db0e-662f-4a13-ba87-c371ad664b14",
"_links" : {
"self" : {
"href" : "https://api7.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions claimedtasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ If successful a 201 code will be returned along with the new claimedtask. The po

An example curl call:
```
curl -i -X POST https://api7.dspace.org/server/api/workflow/claimedtasks
curl -i -X POST https://demo.dspace.org/server/api/workflow/claimedtasks
\ -H "Content-Type:text/uri-list" \
--data "https://api7.dspace.org/server/api/workflow/pooltasks/1"
--data "https://demo.dspace.org/server/api/workflow/pooltasks/1"
```

Return codes:
Expand Down
20 changes: 10 additions & 10 deletions collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Provide access to the list of collections (DBMS based).

Example: <https://api7.dspace.org/server/#/server/api/core/collections>
Example: <https://demo.dspace.org/server/#/server/api/core/collections>

## Single Collection
**/api/core/collections/<:uuid>**
Expand Down Expand Up @@ -196,7 +196,7 @@ Collection metadata can be modified as described in [Modifying metadata via Patc
#### Retrieve Logo
**GET /api/core/collections/<:uuid>/logo**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo>

It returns the bitstream representing the logo of this collection. [See the bitstream endpoint for more info](bitstreams.md#Single Bitstream)

Expand All @@ -207,7 +207,7 @@ To be used on a collection without a logo

Curl example:
```
curl 'https://api7.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
curl 'https://demo.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
-XPOST -H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer eyJhbGciOiJI...' \
-F "file=@Downloads/test.png"
Expand Down Expand Up @@ -259,7 +259,7 @@ Return information about the license template in use by the collection. The json
#### Retrieve Item template
**GET /api/core/collections/<:uuid>/itemtemplate**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/itemtemplate>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/collections/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/itemtemplate>

It returns the item representing the item template of this collection. [See the item endpoint for more info](items.md#Single Item)

Expand Down Expand Up @@ -329,15 +329,15 @@ The json representation is as follow
"type": "resourcePolicy",
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/authz/resourcePolicies/2844"
"href": "https://demo.dspace.org/server/api/authz/resourcePolicies/2844"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/core/collections/5ad50035-ca22-4a4d-84ca-d5132f34f588/defaultAccessConditions"
"href": "https://demo.dspace.org/server/api/core/collections/5ad50035-ca22-4a4d-84ca-d5132f34f588/defaultAccessConditions"
}
},
"page": {
Expand Down Expand Up @@ -393,7 +393,7 @@ A sample json response:
"last_harvested": null,
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/core/collections/6f944500-c300-449a-9023-a5ad8bd21160/harvester"
"href": "https://demo.dspace.org/server/api/core/collections/6f944500-c300-449a-9023-a5ad8bd21160/harvester"
}
},
"_embedded": {
Expand All @@ -417,7 +417,7 @@ A sample json response:
],
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/config/harvestermetadata"
"href": "https://demo.dspace.org/server/api/config/harvestermetadata"
}
}
}
Expand All @@ -440,7 +440,7 @@ A sample json response if no harvesting is enabled:
"last_harvested": null,
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/core/collections/6f944500-c300-449a-9023-a5ad8bd21160/harvester"
"href": "https://demo.dspace.org/server/api/core/collections/6f944500-c300-449a-9023-a5ad8bd21160/harvester"
}
},
"_embedded": {
Expand All @@ -464,7 +464,7 @@ A sample json response if no harvesting is enabled:
],
"_links": {
"self": {
"href": "https://api7.dspace.org/server/api/config/harvestermetadata"
"href": "https://demo.dspace.org/server/api/config/harvestermetadata"
}
}
}
Expand Down
12 changes: 6 additions & 6 deletions communities.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Provide access to the communities (DBMS based). It returns the list of existent communities.

Example: <https://api7.dspace.org/server/#/server/api/core/communities>
Example: <https://demo.dspace.org/server/#/server/api/core/communities>

## Single Community
**/api/core/communities/<:uuid>**
Expand Down Expand Up @@ -97,7 +97,7 @@ The supported parameters are:
### Collections
**/api/core/communities/<:uuid>/collections**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/communities/7669c72a-3f2a-451f-a3b9-9210e7a4c02f/collections>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/communities/7669c72a-3f2a-451f-a3b9-9210e7a4c02f/collections>

It returns the collections within this community

Expand All @@ -108,7 +108,7 @@ The supported parameters are:
#### Retrieve Logo
**GET /api/core/communities/<:uuid>/logo**

Example: <https://api7.dspace.org/server/#https://api7.dspace.org/server/api/core/communities/7669c72a-3f2a-451f-a3b9-9210e7a4c02f/logo>
Example: <https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/communities/7669c72a-3f2a-451f-a3b9-9210e7a4c02f/logo>

It returns the bitstream representing the logo of this community. [See the bitstream endpoint for more info](bitstreams.md#Single Bitstream)

Expand All @@ -119,7 +119,7 @@ To be used on a community without a logo

Curl example:
```
curl 'https://api7.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
curl 'https://demo.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
-XPOST -H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer eyJhbGciOiJI...' \
-F "file=@Downloads/test.png"
Expand Down Expand Up @@ -149,7 +149,7 @@ To be used on a community with a logo

Curl example:
```
curl 'https://api7.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
curl 'https://demo.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
-XPUT -H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer eyJhbGciOiJI...' \
-F "file=@Downloads/test.png"
Expand Down Expand Up @@ -179,7 +179,7 @@ To be used on a community with a logo

Curl example:
```
curl 'https://api7.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
curl 'https://demo.dspace.org/server/api/core/communities/1c11f3f1-ba1f-4f36-908a-3f1ea9a557eb/logo' \
-XDELETE \
-H 'Authorization: Bearer eyJhbGciOiJI...'
```
Expand Down
Loading

0 comments on commit 128f6bf

Please sign in to comment.