Project

General

Profile

Task #2099

Feature #1764: Finalize dataoneTypes schema for public release

Types and their various representations

Added by Roger Dahl almost 13 years ago. Updated almost 13 years ago.

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

100%

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

Description

I think the descriptions of some of our types that have more than a single serialized representation are a bit confusing. Most of the types have only a single (XML) serialized representation, and the descriptions of those are very concise. But, for instance, Types.DateTime can also be passed in URLs, so it has an additional serialization type. And I think maybe we should try to structure the description of that to make it more clear. Maybe have two clearly separated sections for the two serialized representations and say what the contexts that each is used in (URL vs. XML in the HTTP body). Also, Types.DateTime mentions stuff about internal representations, which I think should be left out entirely, or included at the end in an "implementation tips" section.

History

#1 Updated by Matthew Jones almost 13 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

Clarified the DateTime docs under an earlier ticket and addressed these concerns.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)