Project

General

Profile

Bug #2546

Inconsistency between listObjects implementation and documentation

Added by Dave Vieglais over 12 years ago. Updated over 12 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Start date:
2012-03-27
Due date:
% Done:

100%

Milestone:
CCI-1.0.0
Product Version:
*
Story Points:
Sprint:

Description

listObjects on MNs and CNs is documented to take a "formatId" parameter, however the services on both CNs and MNs do not respond to formatId though do respond as expected to objectFormat being used in its place.

e.g.: GMN

https://gmn-dev.dataone.org/mn/v1/object?count=0&formatId=application%2Foctet-stream

vs

https://gmn-dev.dataone.org/mn/v1/object?count=0&objectFormat=application%2Foctet-stream

e.g.: CN

https://cn-sandbox.dataone.org/cn/v1/object?count=0&formatId=application%2Foctet-stream

vs

https://cn-sandbox.dataone.org/cn/v1/object?count=0&objectFormat=application%2Foctet-stream

Simplest solution is to update the API documentation to match the implementations.

History

#1 Updated by Dave Vieglais over 12 years ago

  • Status changed from New to Closed

Implementations updated to match docs, i.e. use "formatId" instead of "objectFormat".

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)