Review subset of use cases and ensure all required APIs are considered
Review use cases "identified as priorities":http://mule1.dataone.org/ArchitectureDocs/prioritization.html for version 0.3 implementation and ensure a) they cover the functionality outlined during the 20091116 CCIT meeting; and b) the API methods identified during the meeting cover the functional requirements of the use cases.
The use cases below were identified during the meeting (# 24 may not be included)
1: "Get Object Identified by GUID":http://mule1.dataone.org/ArchitectureDocs/UseCases/01_uc.html
2: "List GUIDs By Search":http://mule1.dataone.org/ArchitectureDocs/UseCases/02_uc.html
6: "MN Synchronize":http://mule1.dataone.org/ArchitectureDocs/UseCases/06_uc.html
10: "MN Status Reports":http://mule1.dataone.org/ArchitectureDocs/UseCases/10_uc.html
16: "Log CRUD Operations":http://mule1.dataone.org/ArchitectureDocs/UseCases/16_uc.html
24: "MNs and CNs Support Transactions":http://mule1.dataone.org/ArchitectureDocs/UseCases/24_uc.html
#1 Updated by Allen Paul about 12 years ago
I'm trying to juggle three different versions of the APIs (in the UC diagrams, in the architecture document API sections, and in the meeting notes).
Which should one should I consider primary, and should I just go ahead and modify the UC or API sections to make them match the meeting notes?
#2 Updated by Dave Vieglais about 12 years ago
In general, I think the meeting notes should be primary, then the diagrams, then the API sections. In some instances, the API docs might take precedent over the diagrams (they were developed iteratively, and basically time ran out before the meeting to get things stabilized). I'm happy to work with you on a case-by-case basis to get it sorted out.
Feel free to modify the API docs and/or diagrams as necessary.
#3 Updated by Allen Paul about 12 years ago
I believe that this is now complete for all use cases except 24, which I didn't feel able to tackle since I was not part of discussions concerning it. I have added two new sections to the Architecture Docs, "and [[http://mule1.dataone.org/ArchitectureDocs/CN_APIs_v0_3.html":http://mule1.dataone.org/ArchitectureDocs/MN_APIs_v0_3.html]]. Those sections are now consistent with the use cases (1, 2, 6, 10, 16). However, the APIs in these new sections do not match very well with the ones listed from the Nov. 2009 Knoxville meeting (https://repository.dataone.org/documents/Committees/CCIT/20091117_CCIT_Knoxville/CN_prototype_methods.txt).