Bug #8834
CNCore.reserveIdentifier documentation correction
Start date:
2019-08-09
Due date:
% Done:
100%
Milestone:
None
Product Version:
*
Story Points:
Sprint:
Description
The documentation for CNCore.reserveIdentifier() states that an id
data parameter should be sent, but it should be pid
.
curl -H "Authorization: Bearer $token" -F "id=urn:uuid:56daae54-a42a-4927-83f1-878ec25ac366" -X POST https://cn.dataone.org/cn/v2/reserve
results in:
<error detailCode="4210" errorCode="409" name="IdentifierNotUnique">
<description>The given identifier is already in use: null</description>
</error>
but
curl -H "Authorization: Bearer $token" -F "pid=urn:uuid:56daae54-a42a-4927-83f1-878ec25ac366" -X POST https://cn.dataone.org/cn/v2/reserve
works:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><identifier xmlns="http://ns.dataone.org/service/types/v1">urn:uuid:56daae54-a42a-4927-83f1-878ec25ac366</identifier>
On a related note, the documentation for CNCore.generateIdentifier() doesn't mention that the identifier is also reserved, but that seems to be the case. Robyn Thiessen-Bock and I were incorporating these APIs into MetacatUI today, and that was helpful information that we wished were in the documentation.
History
#1 Updated by Dave Vieglais about 5 years ago
- % Done changed from 0 to 100
- Assignee set to Dave Vieglais
- Status changed from New to Closed
Fixed in docs dev branch