-
Notifications
You must be signed in to change notification settings - Fork 164
docs(BA-2545): Add Artifact
API descriptions
#6104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive descriptions to the Artifact API GraphQL schema to improve documentation and developer experience. The documentation provides detailed explanations of artifact workflows, status transitions, and operation purposes.
- Replaces basic "Added in X.X.X" descriptions with detailed multi-line documentation for all artifact-related GraphQL types
- Documents the complete artifact workflow: Scan → Import → Use, including status transitions (SCANNED → PULLING → PULLED → AVAILABLE)
- Adds explanations for key concepts like artifact types, availability states, and admin-only operations
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
src/ai/backend/manager/api/gql/artifact.py | Adds comprehensive descriptions to all artifact-related GraphQL input/output types and operations using dedent_strip utility |
docs/manager/graphql-reference/v2-schema.graphql | Updates generated GraphQL schema documentation with new detailed descriptions |
docs/manager/graphql-reference/supergraph.graphql | Updates supergraph schema documentation with new detailed descriptions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
||
|
||
@strawberry.input(description="Added in 25.14.0") | ||
@strawberry.input(description="Added in 25.15.0") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This input class DelegateeTarget
is missing the detailed description treatment that other classes received. It should use dedent_strip
with a comprehensive description explaining its purpose for delegated scanning operations.
@strawberry.input(description="Added in 25.15.0") | |
@strawberry.input( | |
description=dedent_strip(""" | |
Added in 25.15.0. | |
Specifies the target for delegated scanning operations, including the delegatee reservoir registry | |
and its associated remote registry. Used to direct scan requests from a delegator to a specific | |
delegatee's registry, enabling discovery and registration of artifacts from external sources | |
via delegation. | |
""") | |
) |
Copilot uses AI. Check for mistakes.
Artifacts are discovered through scanning external registries and, | ||
can have multiple revisions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an unnecessary comma after "and" that creates a grammatically incorrect sentence fragment. It should read "Artifacts are discovered through scanning external registries and can have multiple revisions."
Artifacts are discovered through scanning external registries and, | |
can have multiple revisions. | |
Artifacts are discovered through scanning external registries and can have multiple revisions. |
Copilot uses AI. Check for mistakes.
Artifact
API descriptions
resolves #6083 (BA-2545)
Checklist: (if applicable)
📚 Documentation preview 📚: https://sorna--6104.org.readthedocs.build/en/6104/
📚 Documentation preview 📚: https://sorna-ko--6104.org.readthedocs.build/ko/6104/