Fix json formatting in registry api docs #3801
Conversation
Signed-off-by: Ilion Beyst <ilion.beyst@gmail.com>
Codecov ReportBase: 56.59% // Head: 56.59% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #3801 +/- ##
=======================================
Coverage 56.59% 56.59%
=======================================
Files 105 105
Lines 10658 10658
=======================================
Hits 6032 6032
Misses 3951 3951
Partials 675 675 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| "name": <name>, | ||
| "tag": <tag>, | ||
| "fsLayers": [ | ||
| { | ||
| "blobSum": "<digest>" | ||
| }, | ||
| ... | ||
| ] | ||
| ], | ||
| "history": <v1 images>, | ||
| "signature": <JWS> | ||
| "name": <name>, | ||
| "tag": <tag>, | ||
| "fsLayers": [ | ||
| { | ||
| "blobSum": "<digest>" | ||
| }, | ||
| ... | ||
| ], | ||
| "history": <v1 images>, | ||
| "signature": <JWS> |
There was a problem hiding this comment.
Some of this document is generated using the spec.md.tmpl in the same directory.
I'm not sure if we still generate, but I did a quick compare, and it looks like the JSON examples below line 1110 are generated.
So perhaps we should stick to 2 spaces for indentation (instead of 4) so that if we regenerated, the indentation would be the same.
Lines before 1110 are ok (but would be good to also use 2 spaces; there's indeed some mistakes in there; would be good to also sync those changes to the spec.md.tmpl so that regenerating the file wouldn't revert those changes.
There was a problem hiding this comment.
@iasoon do you mind having a look at updating the api.md.tmpl file so the generator doesnt override y9our changes.
Currently the formatting of example JSON is a bit inconsistent. This PR makes sure they are all formatted using a 4 space indent, and resolves some minor syntax errors.