Project

General

Profile

Bug #1465

mn update documentation not clear with regard to the 2 pids

Added by Rob Nahf about 13 years ago. Updated over 12 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
-
Start date:
2011-04-06
Due date:
% Done:

100%

Milestone:
None
Product Version:
*
Story Points:
Sprint:

Description

at http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_storage.update

the return comment seems to be wrong:
The identifier that was used to insert the document into the system, which should be the same as pid.

  • correct to: "... which should be the same as newPid."

History

#1 Updated by Dave Vieglais about 13 years ago

  • Status changed from New to Closed

yup. docs updated, change will be propagated with next commit.

#2 Updated by Rob Nahf about 13 years ago

  • Status changed from Closed to In Progress

found another spot where the doc for update is confusing. Where it says: "The object that is being obsoleted is passed in as a parameter, ..."

I think it would be better to say:

"The pid of the object that is being obsoleted is passed in as a parameter, ..."

#3 Updated by Dave Vieglais about 13 years ago

  • Status changed from In Progress to Closed

Try again...

#4 Updated by Rob Nahf about 13 years ago

  • Status changed from Closed to In Progress

found another typo in the error section:

"The update operation failed because the object which was supposed to be updated in the system (indicated via the obsoletedPid parameter) is not present in the DataONE system, so update is an illegal operation."

should be: ... (indicated via the pid parameter) ...

#5 Updated by Dave Vieglais over 12 years ago

  • Position set to 33

#6 Updated by Dave Vieglais over 12 years ago

  • Milestone set to None
  • Status changed from In Progress to Closed

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)