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

Merge pull request #3801 from iasoon/fix-api-docs-json

Browse source 
Fix json formatting in registry api docs
This commit is contained in:
Milos Gajdos 2023-07-22 19:16:36 +01:00 committed by GitHub
commit 7b502560ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 61 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

123
docs/spec/api.md
View file

@ -266,7 +266,8 @@ are reported as part of 4xx responses, in a json response body. One or more
errors will be returned in the following format: errors will be returned in the following format:
{ {
"errors": [{ "errors": [
{
"code": <error identifier>, "code": <error identifier>,
"message": <message describing condition>, "message": <message describing condition>,
"detail": <unstructured> "detail": <unstructured>
@ -434,17 +435,16 @@ manifest will be returned, with the following format (see
[docker/docker#8093](https://github.com/docker/docker/issues/8093) for details): [docker/docker#8093](https://github.com/docker/docker/issues/8093) for details):
{ {
"name": <name>, "name": <name>,
"tag": <tag>, "tag": <tag>,
"fsLayers": [ "fsLayers": [
{ {
"blobSum": <digest> "blobSum": <digest>
}, },
... ...
] ],
], "history": <v1 images>,
"history": <v1 images>, "signature": <JWS>
"signature": <JWS>
} }
The client should verify the returned manifest signature for authenticity The client should verify the returned manifest signature for authenticity
@ -825,18 +825,17 @@ image manifest. An image can be pushed using the following request format:
Content-Type: <manifest media type> Content-Type: <manifest media type>
{ {
"name": <name>, "name": <name>,
"tag": <tag>, "tag": <tag>,
"fsLayers": [ "fsLayers": [
{ {
"blobSum": <digest> "blobSum": <digest>
}, },
... ...
] ],
], "history": <v1 images>,
"history": <v1 images>, "signature": <JWS>,
"signature": <JWS>, ...
...
} }
The `name` and `reference` fields of the response body must match those The `name` and `reference` fields of the response body must match those
@ -855,7 +854,8 @@ identifying the missing blob. An error is returned for each unknown blob. The
response format is as follows: response format is as follows:
{ {
"errors": [{ "errors": [
{
"code": "BLOB_UNKNOWN", "code": "BLOB_UNKNOWN",
"message": "blob unknown to registry", "message": "blob unknown to registry",
"detail": { "detail": {
@ -886,10 +886,10 @@ The response will be in the following format:
Content-Type: application/json Content-Type: application/json
{ {
"repositories": [ "repositories": [
<name>, <name>,
... ...
] ]
} }
``` ```
@ -933,10 +933,10 @@ Content-Type: application/json
Link: <<url>?n=<n from the request>&last=<last repository in response>>; rel="next" Link: <<url>?n=<n from the request>&last=<last repository in response>>; rel="next"
{ {
"repositories": [ "repositories": [
<name>, <name>,
... ...
] ]
} }
``` ```
@ -1043,11 +1043,11 @@ Content-Type: application/json
Link: <<url>?n=<n from the request>&last=<last tag value from previous response>>; rel="next" Link: <<url>?n=<n from the request>&last=<last tag value from previous response>>; rel="next"
{ {
"name": <name>, "name": <name>,
"tags": [ "tags": [
<tag>, <tag>,
... ...
] ]
} }
``` ```
@ -1764,17 +1764,16 @@ Docker-Content-Digest: <digest>
Content-Type: <media type of manifest> Content-Type: <media type of manifest>
{ {
"name": <name>, "name": <name>,
"tag": <tag>, "tag": <tag>,
"fsLayers": [ "fsLayers": [
{ {
"blobSum": "<digest>" "blobSum": "<digest>"
}, },
... ...
] ],
], "history": <v1 images>,
"history": <v1 images>, "signature": <JWS>
"signature": <JWS>
} }
``` ```
@ -1984,17 +1983,16 @@ Authorization: <scheme> <token>
Content-Type: <media type of manifest> Content-Type: <media type of manifest>
{ {
"name": <name>, "name": <name>,
"tag": <tag>, "tag": <tag>,
"fsLayers": [ "fsLayers": [
{ {
"blobSum": "<digest>" "blobSum": "<digest>"
}, },
... ...
] ],
], "history": <v1 images>,
"history": <v1 images>, "signature": <JWS>
"signature": <JWS>
} }
``` ```
@ -2226,7 +2224,8 @@ The error codes that may be included in the response body are enumerated below:
Content-Type: application/json Content-Type: application/json
{ {
"errors": [{ "errors": [
{
"code": "BLOB_UNKNOWN", "code": "BLOB_UNKNOWN",
"message": "blob unknown to registry", "message": "blob unknown to registry",
"detail": { "detail": {
@ -5499,7 +5498,7 @@ Content-Type: application/json
"repositories": [ "repositories": [
<name>, <name>,
... ...
] ],
"next": "<url>?last=<name>&n=<last value of n>" "next": "<url>?last=<name>&n=<last value of n>"
} }
``` ```