docs: update oras discover JSON output format#552
Open
Iam-Karan-Suresh wants to merge 1 commit intooras-project:mainfrom
Open
docs: update oras discover JSON output format#552Iam-Karan-Suresh wants to merge 1 commit intooras-project:mainfrom
Iam-Karan-Suresh wants to merge 1 commit intooras-project:mainfrom
Conversation
ff446ff to
f2d0da0
Compare
Signed-off-by: Iam-karan-suresh <karansuresh.info@gmail.com>
f2d0da0 to
c940700
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for oras discover --format json to align with the new output format introduced in ORAS v1.3.0, which now returns the subject manifest along with its referrers following the OCI referrers data model, instead of the legacy manifests-based output.
Changes:
- Updated tree output example to show current format with annotations
- Updated JSON output example to reflect new structure with subject manifest at root level and
referrersarray instead ofmanifestsarray
Comments suppressed due to low confidence (1)
versioned_docs/version-1.3/how_to_guides/format_output.mdx:283
- The field descriptions (lines 275-283) need to be updated to match the new JSON output format. The documentation still describes the old format with a
manifestsarray at the root level, but the actual JSON output (lines 292-310) now includes the subject manifest details at the root level with areferrersarray. The description should be updated to explain that the output includes the subject manifest's metadata (reference, mediaType, digest, size) at the root level, followed by areferrersarray containing the list of artifacts that reference the subject.
View an artifact's referrers manifest in pretty JSON output. The following fields should be outputted:
- `manifests`: the list of referrers
- `reference`: full reference by digest of the referrer
- `mediaType`: media type of the referrer
- `size`: referrer file size in bytes
- `digest`: digest of the referrer
- `artifactType`: artifact type of a referrer
- `annotations`: contains arbitrary metadata in a referrer
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This PR updates the documentation for
oras discover --format jsonto reflect the current output format introduced in ORAS v1.3.0.In v1.3.0, the discover command returns the subject manifest along with its referrers, following the OCI referrers data model. The previous documentation still described the legacy
manifests-based output, which is no longer returned by recent ORAS versions.This change aligns the docs with the actual CLI behavior to avoid user confusion.
related to issue:#497