From c5792bf87e890ce0a0cdfff95632f8241900bb6d Mon Sep 17 00:00:00 2001 From: Stephen J Day Date: Wed, 22 Jul 2015 20:09:41 -0700 Subject: [PATCH] Identify V2 API changes by letter To avoid confusion with the registry version number or other project versions, the specification updates are now lettered. Signed-off-by: Stephen J Day --- docs/spec/api.md | 62 ++++++++++++++++++++++++------------------- docs/spec/api.md.tmpl | 62 ++++++++++++++++++++++++------------------- 2 files changed, 68 insertions(+), 56 deletions(-) diff --git a/docs/spec/api.md b/docs/spec/api.md index a3606d8d..cec3402c 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -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 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. +
-
2.0.4
> +
e
  • Added support for listing registry contents.
    • @@ -130,40 +135,41 @@ specification to correspond with the versions enumerated here.
-
2.0.3
+
d
-
  • Allow repository name components to be one character.
    • -
  • Clarified that single component names are allowed.
    • +
      +
    • Allow repository name components to be one character.
      • +
    • Clarified that single component names are allowed.
      • +
    -
    2.0.2
    +
    c
    -
  • Added section covering digest format.
    • -
  • Added more clarification that manifest cannot be deleted by tag.
    • +
      +
    • Added section covering digest format.
      • +
    • Added more clarification that manifest cannot be deleted by tag.
      • +
    -
    2.0.1
    -
    -
      -
    • Added capability of doing streaming upload to PATCH blob upload.
      • -
    • Updated PUT blob upload to no longer take final chunk, now requires entire data or no data.
      • -
    • Removed `416 Requested Range Not Satisfiable` response status from PUT blob upload.
      • -
    -
    -
    2.0.0
    -
    -
      -
    • Added support for immutable manifest references in manifest endpoints.
      • -
    • Deleting a manifest by tag has been deprecated.
      • -
    • Specified `Docker-Content-Digest` header for appropriate entities.
      • -
    • Added error code for unsupported operations.
      • -
    -
    +
    b
    +
    +
      +
    • Added capability of doing streaming upload to PATCH blob upload.
      • +
    • Updated PUT blob upload to no longer take final chunk, now requires entire data or no data.
      • +
    • Removed `416 Requested Range Not Satisfiable` response status from PUT blob upload.
      • +
    +
    + +
    a
    +
    +
      +
    • Added support for immutable manifest references in manifest endpoints.
      • +
    • Deleting a manifest by tag has been deprecated.
      • +
    • Specified `Docker-Content-Digest` header for appropriate entities.
      • +
    • Added error code for unsupported operations.
      • +
    +
    -
    2.0
    -
    - This is the baseline specification. -
    ## Overview diff --git a/docs/spec/api.md.tmpl b/docs/spec/api.md.tmpl index ceee0c72..d4f1c825 100644 --- a/docs/spec/api.md.tmpl +++ b/docs/spec/api.md.tmpl @@ -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 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. +
    -
    2.0.4
    > +
    e
    • Added support for listing registry contents.
      • @@ -130,40 +135,41 @@ specification to correspond with the versions enumerated here.
    -
    2.0.3
    +
    d
    -
  • Allow repository name components to be one character.
    • -
  • Clarified that single component names are allowed.
    • +
      +
    • Allow repository name components to be one character.
      • +
    • Clarified that single component names are allowed.
      • +
    -
    2.0.2
    +
    c
    -
  • Added section covering digest format.
    • -
  • Added more clarification that manifest cannot be deleted by tag.
    • +
      +
    • Added section covering digest format.
      • +
    • Added more clarification that manifest cannot be deleted by tag.
      • +
    -
    2.0.1
    -
    -
      -
    • Added capability of doing streaming upload to PATCH blob upload.
      • -
    • Updated PUT blob upload to no longer take final chunk, now requires entire data or no data.
      • -
    • Removed `416 Requested Range Not Satisfiable` response status from PUT blob upload.
      • -
    -
    -
    2.0.0
    -
    -
      -
    • Added support for immutable manifest references in manifest endpoints.
      • -
    • Deleting a manifest by tag has been deprecated.
      • -
    • Specified `Docker-Content-Digest` header for appropriate entities.
      • -
    • Added error code for unsupported operations.
      • -
    -
    +
    b
    +
    +
      +
    • Added capability of doing streaming upload to PATCH blob upload.
      • +
    • Updated PUT blob upload to no longer take final chunk, now requires entire data or no data.
      • +
    • Removed `416 Requested Range Not Satisfiable` response status from PUT blob upload.
      • +
    +
    + +
    a
    +
    +
      +
    • Added support for immutable manifest references in manifest endpoints.
      • +
    • Deleting a manifest by tag has been deprecated.
      • +
    • Specified `Docker-Content-Digest` header for appropriate entities.
      • +
    • Added error code for unsupported operations.
      • +
    +
    -
    2.0
    -
    - This is the baseline specification. -
    ## Overview