docs(spec): define output formats for oras repo commands #1763
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR extends the formatted‐output proposal with documentation for the oras repo ls and oras repo tags commands, including JSON schemas and examples.
- Adds table of contents entries for
oras repo lsandoras repo tags - Defines JSON schema and usage examples for both commands
- Illustrates default vs JSON output behavior for
oras repo ls
Comments suppressed due to low confidence (3)
docs/proposals/formatted-output.md:13
- The TOC includes a link to "Verify local files" but there’s no matching section in the document. Either add the section content or remove this entry to prevent a broken anchor.
- [Verify local files](#verify-local-files)
docs/proposals/formatted-output.md:637
- [nitpick] For consistency with the
oras repo lssection, consider adding an example of the default (text) output fororas repo tagsin addition to the JSON example.
### oras repo tags
docs/proposals/formatted-output.md:637
- [nitpick] The JSON schema for
oras repo tagsonly includestags. If downstream tooling needs context (e.g., registry or repository name), consider adding those fields or explicitly documenting that they’re omitted by design.
### oras repo tags
4 tasks
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1763 +/- ##
==========================================
- Coverage 85.29% 85.26% -0.04%
==========================================
Files 133 133
Lines 5882 5882
==========================================
- Hits 5017 5015 -2
- Misses 616 618 +2
Partials 249 249 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
c0a950d to
0770d1c
Compare
TerryHowe
reviewed
Jul 2, 2025
This was referenced Aug 7, 2025
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds documentation for the output formats for
oras repo lsandoras repo tagscommands.Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Related to #1547
Related to #1758
Please check the following list: