correct documentation for OCI uploader and downloader #665
Conversation
This file contains 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
hilmarf
added
area/documentation
Mend Scan Summary: ❌Repository: open-component-model/ocm
|
|
Integration Tests for 34e6d22 run with result: Success ✅! |
|
Integration Tests for 34e6d22 run with result: Success ✅! |
mandelsoft
requested changes
Feb 19, 2024
| The following artifact media types are supported: | ||
| `+listformat.FormatList("", supportedMimeTypes...)+` | ||
| `+listformat.FormatList("", artdesc.ArchiveBlobTypes()...)+` | ||
| By default, it is registered for these mimetypes. |
There was a problem hiding this comment.
there is no default registration so far
| It accepts a config with the following fields: | ||
| `+listformat.FormatMapElements("", AttributeDescription()), | ||
| `+listformat.FormatMapElements("", ociuploadattr.AttributeDescription())+` |
There was a problem hiding this comment.
ociupload belongs to the upload handler.
It should add, that if no mime types are configured the supported mimes types are used.
|
I just saw, that the text in the downloader tests still refer to upload. |
mandelsoft
requested changes
Feb 19, 2024
Comment on lines
-76
to
-78
| `+listformat.FormatMapElements("", ociuploadattr.AttributeDescription())+` | ||
| Alternatively, a single string value can be given representing an OCI repository | ||
| reference.`, |
There was a problem hiding this comment.
The deleted one is the upload description
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.
Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
What type of PR is this? (check all applicable)
Related Tickets & Documents
Screenshots
Added tests?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Added to documentation?
Checklist: