Project

General

Profile

Task #1960

Story #1906: Review, revise, and update architecture documentation

class Types.Boolean - clarify use

Added by Roger Dahl about 10 years ago. Updated about 7 years ago.

Status:
Rejected
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2011-11-01
Due date:
% Done:

0%

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

Description

http://mule1.dataone.org/ArchitectureDocs-current/apis/Types.html#Types.Boolean

I think the following modifications to the description of Boolean would clarify its use:

The Boolean type is used in DataONE service APIs to indicate success (True) or failure (False) of an operation.

True is encoded as an HTTP response with a status code of “200”. The body of the message may contain additional content, but this should be ignored by the receiver.

False is encoded as an HTTP response containing a DataONE Exception. http://mule1.dataone.org/ArchitectureDocs-current/apis/Exceptions.html

History

#1 Updated by Dave Vieglais about 10 years ago

  • Status changed from New to Rejected

The description suggested is appropriate for the REST method calls and the generate description of REST services, but not for the Boolean type. Method and REST docs should be up to date on this.

#2 Updated by Dave Vieglais about 7 years ago

  • Target version set to Maintenance Backlog

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)