[docs] Refactor Artifact API documentation #26854
Merged
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
github-actions
bot
added
the
kind/api-change
ninja-quokka
added
the
No New Tests
baude
reviewed
Aug 18, 2025
pkg/api/server/register_artifacts.go
Outdated
| // - name: fileName | ||
| // in: query | ||
| // description: File to be added to the artifact | ||
| // description: Name of the file to be added |
Collaborator
Author
There was a problem hiding this comment.
Done, thanks, it should certainly be path!
Member
|
LGTM |
Add artifact tag to tags.yaml so API docs are ordered correctly (alphabetically with libpod endpoints first). Refactor artifact API documentation to be consistently formated. Refactor some descriptions and summaries to be more accurate and user friendly. Signed-off-by: Lewis Roy <lewis@redhat.com>
ninja-quokka
force-pushed
the
format_artifact_api_doc
branch
from
bb65f1e to
be0ad4a
Compare
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Luap99, ninja-quokka The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
openshift-merge-bot
bot
merged commit aa006d1
into
containers:main
78 of 81 checks passed
stale-locking-app
bot
added
the
locked - please file new issue/PR
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
Add artifact tag to tags.yaml so API docs are ordered correctly (alphabetically with libpod endpoints first).
Refactor artifact API documentation to be consistently formated.
Refactor some descriptions and summaries to be more accurate and user friendly.
Does this PR introduce a user-facing change?