Warning: These documents are under active
development and subject to change (version 2.1.0-beta).
The latest release documents are at:
https://purl.dataone.org/architecture
Todo
Need to provide a list of recommended identifier schemes.
(The original entry is located in source/apis/generated/generated_CNCore.txt, line 383.)
Todo
Need to provide a list of recommended identifier schemes.
(The original entry is located in source/apis/generated/generated_MNStorage.txt, line 214.)
Todo
Link these methods to the generated methods in the API specifications, eliminate redundancy of the description text between the two locations.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/Authorization.txt, line 432.)
Todo
guidance on RESOURCE_MAPS - initial thoughts: depends on references to DATA objects, whether they be SIDs or PIDs
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/ContentMutability.txt, line 672.)
Todo
Define ObjectList rendering in HTML
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/Serialization.txt, line 83.)
Todo
flesh this out with examples
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/SystemMetadata.txt, line 260.)
Todo
Needs discussion.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/SystemMetadata.txt, line 446.)
Todo
2015-09-17 Review for currentness
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/06_uc.txt, line 195.)
Todo
Byte stream equivalence of replicated science metadata would require that MNs record an exact copy of the metadata document received during replication operations in addition to the content that would be extracted and stored as part of the normal (existing) operations of a MN. Is this a reasonable requirement for MNs? Since MNs are required to store a copy of data, it seems reasonable to assume a copy of the metadata can be stored as well.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 439.)
Todo
Define the procedures for content deletion - who is responsible, procedures for contacting authors, timeliness of response.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 454.)
Todo
Describe how endianness is specified in various science metadata formats.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 472.)
Todo
List and define the minimal set of fields with examples. A starting point would be the union of the required search properties and the information required for accurate citation.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 504.)
Todo
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/querying_content.txt, line 5.)
Todo
Describe this operation.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 7.)
Todo
batchGet specifies that multiple objects may be retrieved in a single call. How are these objects packaged in the response?
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 41.)
Todo
need details on what this operation is supposed to be doing.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 47.)
Todo
Define “a simple acknowledgement”
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 94.)
Todo
Estimate some times for the unknowns here.
(The original entry is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/cn_requirements.txt, line 7.)