Skip to content

Commit

Permalink
processing feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
benbosman committed Feb 12, 2020
1 parent cf5c9c6 commit 06fb7a4
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 20 deletions.
7 changes: 7 additions & 0 deletions items.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,13 @@ A sample can be found at https://dspace7-entities.atmire.com/rest/#https://dspac

It embeds all relationships where either the left or the right item matches the given uuid

### Get single version for item
**GET /api/core/items/{:item-uuid}/version**

Provide version information based on a given Item UUID. An Item UUID will only match one version.

The JSON response and status codes are the same as the [Version endpoint](version.md#get-single-version).

## Deleting an item

**DELETE /api/core/items/<:uuid>**
Expand Down
14 changes: 6 additions & 8 deletions version.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ Provide version information for the version id.
"summary": "Fixing some typos in the abstract",
"_links": {
"versionhistory": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistory/10"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistories/10"
},
"self": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/version/101"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versions/101"
},
"eperson": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/version/101/eperson"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versions/101/eperson"
},
"item": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/version/101/item"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versions/101/item"
}
}
}
Expand All @@ -49,11 +49,9 @@ Status codes:

## Get single version for item

**GET /api/versioning/item/<:item-uuid>**
**GET /api/core/items/{:item-uuid}/version**

Provide version information based on a given Item UUID. An Item UUID will only match one version.

The JSON response and status codes are the same as the endpoint above.
See [the item endpoint](items.md#get-single-version-for-item)

## Remove version

Expand Down
8 changes: 4 additions & 4 deletions versionhistory.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Provide version information for the version history id.
"type": "versionhistory",
"_links": {
"self": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistory/1"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistories/1"
},
"versions": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistory/1/versions"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistories/1/versions"
}
}
}
Expand All @@ -38,7 +38,7 @@ Status codes:

### Versions

**GET /api/versioning/versionhistory/<:versionHistoryId>/versions**
**GET /api/versioning/versionhistories/<:versionHistoryId>/versions**

Retrieve a pageable list of versions for the provided version history identifier.
The versions are ordered by version number descending.
Expand All @@ -64,7 +64,7 @@ The versions are ordered by version number descending.
],
"_links": {
"self": {
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistory/1/versions"
"href": "https://dspace7.4science.it/dspace-spring-rest/api/versioning/versionhistories/1/versions"
}
},
"page": {
Expand Down
8 changes: 4 additions & 4 deletions workflowitems.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,18 +124,18 @@ It returns the workflowitems created by the specified submitter

## Get Single Workflow Item from Item UUID

**/api/submission/workflowitems/item/<:uuid>**
**/api/workflow/workflowitems/search/item?uuid=<:item-uuid>**

https://dspace7.4science.cloud/server/api/submission/workflowitems/item/cd67ce0e-7f9a-42fc-b8e7-c8bb83ef58ca
/api/workflow/workflowitems/search/item?uuid=cd67ce0e-7f9a-42fc-b8e7-c8bb83ef58ca
The item uuid is mandatory

There's always at most one workflow item per Item.
There's always at most one workflow item per Item, so this endpoint will return a single workflow item, not a list

It would respond with:
* 200 OK - Returning the workflow item if there's a match
* 401 Unauthorized - if you are not authenticated
* 403 Forbidden - if you are not logged in with sufficient permissions to view the workflow item
* 404 if the workflow item doesn't exist
* 204 if the workflow item doesn't exist

## POST Method
To create a workflowitem, i.e. to start a workflow, a workspaceitem must be posted to the workflowitems resource collection endpoint (/api/submission/workflowitems).
Expand Down
8 changes: 4 additions & 4 deletions workspaceitems.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,18 +123,18 @@ It returns the workspaceitem created by the specified submitter

## Get Single Workspace Item from Item UUID

**/api/submission/workspaceitems/item/<:uuid>**
**/api/submission/workspaceitems/search/item?uuid=<:item-uuid>**

https://dspace7.4science.cloud/server/api/submission/workspaceitems/item/cd67ce0e-7f9a-42fc-b8e7-c8bb83ef58ca
/server/api/submission/workspaceitems/search/item?uuid=cd67ce0e-7f9a-42fc-b8e7-c8bb83ef58ca
The item uuid is mandatory

There's always at most one workspace item per Item.
There's always at most one workspace item per Item, so this endpoint will return a single workspace item, not a list

It would respond with:
* 200 OK - Returning the workspace item if there's a match
* 401 Unauthorized - if you are not authenticated
* 403 Forbidden - if you are not logged in with sufficient permissions to view the workspace item
* 404 if the workspace item doesn't exist
* 204 if the workspace item doesn't exist

## Multipart POST Method
Multipart POST request will typically result in the creation of a new file in the section identified by the name of the variable used for the upload (uploads is the default name of the user uploaded content). The process will be managed by the implementation bind with the identified section.
Expand Down

0 comments on commit 06fb7a4

Please sign in to comment.