<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>TO DO List — v2.1.0-beta</title> <link rel="stylesheet" href="_static/dataone.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', VERSION: '2.1.0-beta', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/mathjax_pre.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML"></script> <script type="text/javascript" src="_static/sidebar.js"></script> <link rel="author" title="About these documents" href="about.html" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link media="only screen and (max-device-width: 480px)" href="_static/small_dataone.css" type= "text/css" rel="stylesheet" /> </head> <body role="document"> <div class="version_notice"> <p> <span class='bold'>Warning:</span> These documents are under active development and subject to change (version 2.1.0-beta).<br /> The latest release documents are at: <a href="https://purl.dataone.org/architecture">https://purl.dataone.org/architecture</a> </p> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="nav-item nav-item-0"><a href="index.html"></a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="to-do-list"> <h1>TO DO List<a class="headerlink" href="#to-do-list" title="Permalink to this headline">¶</a></h1> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Need to provide a list of recommended identifier schemes.</p> </div> <p class="todo-source">(The <a class="reference internal" href="apis/CN_APIs.html#index-0"><em>original entry</em></a> is located in source/apis/generated/generated_CNCore.txt, line 383.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Need to provide a list of recommended identifier schemes.</p> </div> <p class="todo-source">(The <a class="reference internal" href="apis/MN_APIs.html#index-0"><em>original entry</em></a> is located in source/apis/generated/generated_MNStorage.txt, line 214.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Link these methods to the generated methods in the API specifications, eliminate redundancy of the description text between the two locations.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/Authorization.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/Authorization.txt, line 432.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">guidance on RESOURCE_MAPS - initial thoughts: depends on references to DATA objects, whether they be SIDs or PIDs</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/ContentMutability.html#index-1"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/ContentMutability.txt, line 672.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Define ObjectList rendering in HTML</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/Serialization.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/Serialization.txt, line 83.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">flesh this out with examples</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/SystemMetadata.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/SystemMetadata.txt, line 260.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Needs discussion.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/SystemMetadata.html#index-1"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/SystemMetadata.txt, line 446.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">2015-09-17 Review for currentness</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/UseCases/06_uc.html#index-1"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/06_uc.txt, line 195.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">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.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/WhatIsData.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 439.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Define the procedures for content deletion - who is responsible, procedures for contacting authors, timeliness of response.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/WhatIsData.html#index-1"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 454.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Describe how endianness is specified in various science metadata formats.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/WhatIsData.html#index-2"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 472.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">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.</p> </div> <p class="todo-source">(The <a class="reference internal" href="design/WhatIsData.html#index-3"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/WhatIsData.txt, line 504.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <ul class="last simple"> <li>Attribute mapping to the list prepared previously</li> <li>Attribute mapping to sysmeta docs</li> <li>SOLR examples, specific to Mercury</li> </ul> </div> <p class="todo-source">(The <a class="reference internal" href="design/querying_content.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/querying_content.txt, line 5.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Describe this operation.</p> </div> <p class="todo-source">(The <a class="reference internal" href="notes/MN_api_notes_comments.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 7.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">batchGet specifies that multiple objects may be retrieved in a single call. How are these objects packaged in the response?</p> </div> <p class="todo-source">(The <a class="reference internal" href="notes/MN_api_notes_comments.html#index-1"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 41.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">need details on what this operation is supposed to be doing.</p> </div> <p class="todo-source">(The <a class="reference internal" href="notes/MN_api_notes_comments.html#index-2"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 47.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Define “a simple acknowledgement”</p> </div> <p class="todo-source">(The <a class="reference internal" href="notes/MN_api_notes_comments.html#index-3"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/MN_api_notes_comments.txt, line 94.)</p> <div class="admonition-todo admonition"> <p class="first admonition-title">Todo</p> <p class="last">Estimate some times for the unknowns here.</p> </div> <p class="todo-source">(The <a class="reference internal" href="notes/cn_requirements.html#index-0"><em>original entry</em></a> is located in /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/notes/cn_requirements.txt, line 7.)</p> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="http://dataone.org"> <img class="logo" src="_static/dataone_logo.png" alt="Logo"/> </a></p><h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation Overview</a><ul> </ul></li> </ul> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <div><input type="text" name="q" /></div> <div><input type="submit" value="Go" /></div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="footer"> <div id="copyright"> © Copyright <a href="http://www.dataone.org">2009-2017, DataONE</a>. [ <a href="_sources/todo.txt" rel="nofollow">Page Source</a> | <a href='https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/todo.txt' rel="nofollow">Revision History</a> ] </div> <div id="acknowledgement"> <p>This material is based upon work supported by the National Science Foundation under Grant Numbers <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=0830944">083094</a> and <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=1430508">1430508</a>.</p> <p>Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.</p> </div> </div> <!-- <hr /> <div id="HCB_comment_box"><a href="http://www.htmlcommentbox.com">HTML Comment Box</a> is loading comments...</div> <link rel="stylesheet" type="text/css" href="_static/skin.css" /> <script type="text/javascript" language="javascript" id="hcb"> /*<! -*/ (function() {s=document.createElement("script"); s.setAttribute("type","text/javascript"); s.setAttribute("src", "http://www.htmlcommentbox.com/jread?page="+escape((typeof hcb_user !== "undefined" && hcb_user.PAGE)||(""+window.location)).replace("+","%2B")+"&mod=%241%24wq1rdBcg%24Gg8J5iYSHJWwAJtlYu/yU."+"&opts=21407&num=10"); if (typeof s!="undefined") document.getElementsByTagName("head")[0].appendChild(s);})(); /* ->*/ </script> --> </body> </html>