TrueCloudLab/distribution
13
0
Fork 3
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Identify V2 API changes by letter

Browse source 
To avoid confusion with the registry version number or other project versions,
the specification updates are now lettered.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
Stephen J Day 2015-07-22 20:09:41 -07:00
parent 76f29c2630
commit c5792bf87e
2 changed files with 68 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/spec/api.md
View file

@ -119,9 +119,14 @@ This section should be updated when changes are made to the specification,
indicating what is different. Optionally, we may start marking parts of the indicating what is different. Optionally, we may start marking parts of the
specification to correspond with the versions enumerated here. specification to correspond with the versions enumerated here.
Each set of changes is given a letter corresponding to a set of modifications
that were applied to the baseline specification. These are merely for
reference and shouldn't be used outside the specification other than to
identify a set of modifications.
<dl> <dl>
<dt>2.0.4</dt>> <dt>e</dt>
<dd> <dd>
<ul> <ul>
<li>Added support for listing registry contents.</li> <li>Added support for listing registry contents.</li>
@ -130,18 +135,23 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0.3</dt> <dt>d</dt>
<dd> <dd>
<ul>
<li>Allow repository name components to be one character.</li> <li>Allow repository name components to be one character.</li>
<li>Clarified that single component names are allowed.</li> <li>Clarified that single component names are allowed.</li>
</ul>
</dd> </dd>
<dt>2.0.2</dt> <dt>c</dt>
<dd> <dd>
<ul>
<li>Added section covering digest format.</li> <li>Added section covering digest format.</li>
<li>Added more clarification that manifest cannot be deleted by tag.</li> <li>Added more clarification that manifest cannot be deleted by tag.</li>
</ul>
</dd> </dd>
<dt>2.0.1</dt>
<dt>b</dt>
<dd> <dd>
<ul> <ul>
<li>Added capability of doing streaming upload to PATCH blob upload.</li> <li>Added capability of doing streaming upload to PATCH blob upload.</li>
@ -150,7 +160,7 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0.0</dt> <dt>a</dt>
<dd> <dd>
<ul> <ul>
<li>Added support for immutable manifest references in manifest endpoints.</li> <li>Added support for immutable manifest references in manifest endpoints.</li>
@ -160,10 +170,6 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0</dt>
<dd>
This is the baseline specification.
</dd>
</dl> </dl>
## Overview ## Overview

24
docs/spec/api.md.tmpl
View file

@ -119,9 +119,14 @@ This section should be updated when changes are made to the specification,
indicating what is different. Optionally, we may start marking parts of the indicating what is different. Optionally, we may start marking parts of the
specification to correspond with the versions enumerated here. specification to correspond with the versions enumerated here.
Each set of changes is given a letter corresponding to a set of modifications
that were applied to the baseline specification. These are merely for
reference and shouldn't be used outside the specification other than to
identify a set of modifications.
<dl> <dl>
<dt>2.0.4</dt>> <dt>e</dt>
<dd> <dd>
<ul> <ul>
<li>Added support for listing registry contents.</li> <li>Added support for listing registry contents.</li>
@ -130,18 +135,23 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0.3</dt> <dt>d</dt>
<dd> <dd>
<ul>
<li>Allow repository name components to be one character.</li> <li>Allow repository name components to be one character.</li>
<li>Clarified that single component names are allowed.</li> <li>Clarified that single component names are allowed.</li>
</ul>
</dd> </dd>
<dt>2.0.2</dt> <dt>c</dt>
<dd> <dd>
<ul>
<li>Added section covering digest format.</li> <li>Added section covering digest format.</li>
<li>Added more clarification that manifest cannot be deleted by tag.</li> <li>Added more clarification that manifest cannot be deleted by tag.</li>
</ul>
</dd> </dd>
<dt>2.0.1</dt>
<dt>b</dt>
<dd> <dd>
<ul> <ul>
<li>Added capability of doing streaming upload to PATCH blob upload.</li> <li>Added capability of doing streaming upload to PATCH blob upload.</li>
@ -150,7 +160,7 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0.0</dt> <dt>a</dt>
<dd> <dd>
<ul> <ul>
<li>Added support for immutable manifest references in manifest endpoints.</li> <li>Added support for immutable manifest references in manifest endpoints.</li>
@ -160,10 +170,6 @@ specification to correspond with the versions enumerated here.
</ul> </ul>
</dd> </dd>
<dt>2.0</dt>
<dd>
This is the baseline specification.
</dd>
</dl> </dl>
## Overview ## Overview