Bug #1691
boolean serialization conflict in design docs
Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
Due date:
% Done:
100%
Milestone:
CCI-0.6.3
Product Version:
*
Story Points:
Sprint:
Description
http://mule1.dataone.org/ArchitectureDocs-current/design/Serialization.html
states "When the response is simply a boolean True or False, the response is a single character “1” if True, or “0” if False."
Many methods short-circuit this, using "empty stream" for True, and 'someError' if False.
Perhaps the Serialization of Types document can read:
When the response is simply a boolean True or False, the response returned is in one of two forms:
a) For cases where false is a valid response: a single character "1" if True, or "0" if False
b) For cases where false coincides with a DataONE exception: an empty body if True, and an error-indicating HTTP status code and serialized error object if False.
History
#1 Updated by Rob Nahf over 13 years ago
- Subject changed from boolean serialization conflict in docs to boolean serialization conflict in design docs
- Category set to Documentation
- Assignee set to Dave Vieglais
- Milestone changed from CCI-0.6.2 to CCI-0.6.3
#2 Updated by Dave Vieglais over 13 years ago
closed with commit r4495
#3 Updated by Dave Vieglais over 13 years ago
- Status changed from New to Closed
