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

15
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>
@ -441,7 +442,6 @@ manifest will be returned, with the following format (see
"blobSum": <digest> "blobSum": <digest>
}, },
... ...
]
], ],
"history": <v1 images>, "history": <v1 images>,
"signature": <JWS> "signature": <JWS>
@ -832,7 +832,6 @@ image manifest. An image can be pushed using the following request format:
"blobSum": <digest> "blobSum": <digest>
}, },
... ...
]
], ],
"history": <v1 images>, "history": <v1 images>,
"signature": <JWS>, "signature": <JWS>,
@ -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": {
@ -1771,7 +1771,6 @@ Content-Type: <media type of manifest>
"blobSum": "<digest>" "blobSum": "<digest>"
}, },
... ...
]
], ],
"history": <v1 images>, "history": <v1 images>,
"signature": <JWS> "signature": <JWS>
@ -1991,7 +1990,6 @@ Content-Type: <media type of manifest>
"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>"
} }
``` ```