and move the list of deposit statuses there instead of repeating it 3
times.
Also reference the API endpoints used in the deposit creation scenario.
Depends on D4428.
Differential D4429
doc: add an introduction paragraph in blueprint.rst douardda on Nov 6 2020, 10:59 AM. Authored by
Details
and move the list of deposit statuses there instead of repeating it 3 Also reference the API endpoints used in the deposit creation scenario. Depends on D4428.
Diff Detail
Event TimelineComment Actions Build is green Patch application report for D4429 (id=15685)Could not rebase; Attempt merge onto 0f4ec31168... Updating 0f4ec311..912be1d0 Fast-forward docs/endpoints/collection.rst | 116 ++++++++++++---------- docs/endpoints/content.rst | 65 +++++++++++- docs/endpoints/service-document.rst | 80 +++++++++------ docs/endpoints/status.rst | 63 ++++++------ docs/endpoints/update-media.rst | 16 +-- docs/endpoints/update-metadata.rst | 10 +- docs/index.rst | 2 +- docs/spec-api.rst | 29 +++--- docs/specs/blueprint.rst | 192 +++++++++++++++++------------------- docs/specs/{specs.rst => index.rst} | 0 docs/specs/spec-loading.rst | 119 +++++++++++----------- 11 files changed, 386 insertions(+), 306 deletions(-) rename docs/specs/{specs.rst => index.rst} (100%) Changes applied before testcommit 912be1d02839250950b2770c79d332ccf0ccd0ef Author: David Douard <david.douard@sdfa3.org> Date: Fri Nov 6 09:39:24 2020 +0100 doc: add an introduction paragraph in blueprint.rst and move the list of deposit statuses there instead of repeating it 3 times. Also reference the API endpoints used in the deposit creation scenario. commit 489f1ab76caa54b50e7523c058b4d5034e66d858 Author: David Douard <david.douard@sdfa3.org> Date: Fri Nov 6 09:36:29 2020 +0100 doc: improve the spec-loading doc - update some deprecated statements (tar loader -> deposit loader) - explcit API calls for example JSON snippets - update JSON snippets for current API behavior commit 61653ddfc7c38bd4130374a6b6472f55f358138a Author: David Douard <david.douard@sdfa3.org> Date: Thu Nov 5 16:16:07 2020 +0100 doc: improve the doc of API endpoints make usage of the sphinx-httpdomain extension according to its documenation. commit 1736371f2c6da9713e4f815da99cd3cd624fdaad Author: David Douard <david.douard@sdfa3.org> Date: Thu Nov 5 14:21:40 2020 +0100 doc: rename docs/specs/specs.rst as docs/specs/index.rst for the sake of clarity. See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/283/ for more details. Comment Actions Thank you for doing this important review of the deposit documentation.
Comment Actions thanks! just a few nitpicks:
Comment Actions Build is green Patch application report for D4429 (id=15698)Rebasing onto 04c1114508... Current branch diff-target is up to date. Changes applied before testcommit 2daa09ed7b09b209d0ce2dac6ad138fa7c81ae61 Author: David Douard <david.douard@sdfa3.org> Date: Fri Nov 6 09:39:24 2020 +0100 doc: add an introduction paragraph in blueprint.rst and move the list of deposit statuses there instead of repeating it 3 times. Also reference the API endpoints used in the deposit creation scenario. See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/289/ for more details. Comment Actions good catch with the v2 precision. Comment Actions nice, thanks.
Comment Actions Build is green Patch application report for D4429 (id=15723)Rebasing onto a67a8cc770... Current branch diff-target is up to date. Changes applied before testcommit 7148a257b296047d8e03d43fe1739404820ca9bb Author: David Douard <david.douard@sdfa3.org> Date: Fri Nov 6 09:39:24 2020 +0100 doc: add an introduction paragraph in blueprint.rst and move the list of deposit statuses there instead of repeating it 3 times. Also reference the API endpoints used in the deposit creation scenario. See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/293/ for more details. |