Updated item documentation with information on the patch operation. #25
Conversation
items.md
Outdated
| ### Replace | ||
| The replace operation allows to replace *existent* information with new one. Attempt to use the replace operation to set not yet initialized information must return an error. See [general errors on PATCH requests](patch.md) | ||
|
|
||
| To withdraw an item, `curl --data '{[ { "op": "replace", "path": "withdraw"}]}' -X PATCH ${dspace7-url}/api/core/items/${item-uuid}`. The withdraw operation also requires an Authorization header. |
There was a problem hiding this comment.
the replace operation in a json patch requires a value attribute it should be "value": true for a withdrawn request and "value": false for a reinstate request.
The most similar operation already documented is here:
https://github.com/DSpace/Rest7Contract/blob/master/workspaceitem-data-license.md#replace
There was a problem hiding this comment.
Thanks for the example. I see what you mean. Will update the contract here before I update the code.
There was a problem hiding this comment.
Quick follow up question.
The issue says that the request should return the 422 error code if the client try to withdrawn a NOT archived item. Does this refer to the "inArchive" flag in the item data?
I notice that withdraw (and reinstate) actions toggle the inArchive flag. For example, setting withdraw = true will result in inArchive = false. My initial idea was that requesting to withdraw and already withdrawn item would result in 422 (because the inArchive flag is false). I suspect this idea is incorrect.
Once I understand the requirement better I'll also update the code PR to do the right thing.
There was a problem hiding this comment.
You are right withdrawn items have the inArchive flag to false but this is not the only situation where the inArchive flag is false. InProgress submissions (workspaceitem, workflowitem) also have the inArchive flag to false.
Trying to withdrawn an item that is already withdrawn should succeed (it is a no-op)
items.md
Outdated
| "type": "item" | ||
| ``` | ||
|
|
||
| To reinstate an item, `curl --data '{[ { "op": "replace", "path": "reinstate"}]}' -X PATCH ${dspace7-url}/api/core/items/${item-uuid}`. The reinstate operation also requires an Authorization header. |
There was a problem hiding this comment.
path must point to a valid attribute in the json object that we go to update (the item), so it should be withdrawn with a value of false
items.md
Outdated
| ```json | ||
| "inArchive": false, | ||
| "discoverable": true, | ||
| "withdrawn": true, |
There was a problem hiding this comment.
this should be "withdrawn": false,
Only describes the replace operation since that is what has been implemented to date. Will (or may) define other operations after consultation with project leaders. Corrected documentation for withdrawal operation.
Create a find method to return bitstrems belonging to a bundle filtered by dc.type Approved-by: Giuseppe Digilio
Only describes the replace operation since that is what has been implemented to date. Will (or may) define other operations after consultation with project leaders.