Project

General

Profile

Bug #7171

v2.0 documentation inconsistencies

Added by Rob Nahf almost 9 years ago. Updated about 8 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Architecture Design
Target version:
Start date:
2015-06-09
Due date:
% Done:

100%

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

Description

From running Architecture tests in d1_integration:

  1. MN and CN getLogRecords in the documentation are describing the event parameter as type Event, instead of String (changed for V2)
  2. listObjects number of parameters? -3. CN.search - queryType should be in path, not specified in implementation-
  3. CN.updateAccount, expects 3 parameters, got 2
  4. CN.updateSystemMetadata - probable problem with building parameters... -6. MN.view / CN.view - parameter 'theme' is not in the expected location (path).
  5. CN.getPackage - parameter 'packageType' is not in expected location (path).-

problems could be either in the documentation or the implementation.


Subtasks

Task #7172: modify updateSystemMetadata documentationClosedRob Nahf

Task #7173: modify getLogRecords documentation / Event type for v2Closed

Task #7174: MN.listObjects documentation is inconsistent regarding replicationStatus parameterClosedDave Vieglais

Task #7182: CN.Diagnostic documentation contains mime part mistakesClosedRob Nahf


Related issues

Related to DataONE API - Story #7185: Finalize API Documentation Closed 2015-06-16

Associated revisions

Revision 15753
Added by Rob Nahf almost 9 years ago

#7171. fixes to ClientArchitectureConformityIT.

Revision 15753
Added by Rob Nahf almost 9 years ago

#7171. fixes to ClientArchitectureConformityIT.

Revision 15779
Added by Rob Nahf almost 9 years ago

refs: #7171: updates to MethodCrossReference.xls as described in the redmine bug.

Revision 15781
Added by Rob Nahf almost 9 years ago

refs #7171: applied missed documentation changes.

History

#1 Updated by Rob Nahf almost 9 years ago

  • Description updated (diff)

#2 Updated by Rob Nahf almost 9 years ago

  • Description updated (diff)

CN.view, MN.view, CN.search, and MN.getPackage are all ok - the test didn't know how to find method parameters when they were not at the end of the path.

#3 Updated by Dave Vieglais almost 9 years ago

  • Target version changed from CCI-2.0.0 to CCI-2.0-TRUNK

#4 Updated by Dave Vieglais almost 9 years ago

  • Related to Story #7185: Finalize API Documentation added

#5 Updated by Dave Vieglais almost 9 years ago

  • Target version changed from CCI-2.0-TRUNK to CCI-2.0.0

#6 Updated by Dave Vieglais almost 9 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 30

#7 Updated by Dave Vieglais about 8 years ago

  • % Done changed from 30 to 100
  • Status changed from In Progress to Closed

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)