Skip to content

Conversation

jopemachine
Copy link
Member

@jopemachine jopemachine commented Sep 29, 2025

resolves #6083 (BA-2545)

Checklist: (if applicable)

  • Milestone metadata specifying the target backport version
  • Mention to the original issue

📚 Documentation preview 📚: https://sorna--6104.org.readthedocs.build/en/6104/


📚 Documentation preview 📚: https://sorna-ko--6104.org.readthedocs.build/ko/6104/

@Copilot Copilot AI review requested due to automatic review settings September 29, 2025 06:21
@github-actions github-actions bot added size:XL 500~ LoC area:docs Documentations comp:manager Related to Manager component labels Sep 29, 2025
@jopemachine jopemachine changed the title docs: Add Artifact API descriptions docs(BA-2545): Add Artifact API descriptions Sep 29, 2025
@jopemachine jopemachine added this to the 25.15 milestone Sep 29, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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")
Copy link
Preview

Copilot AI Sep 29, 2025

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.

Suggested change
@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.

Comment on lines +449 to +450
Artifacts are discovered through scanning external registries and,
can have multiple revisions.
Copy link
Preview

Copilot AI Sep 29, 2025

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."

Suggested change
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.

@jopemachine jopemachine changed the title docs(BA-2545): Add Artifact API descriptions docs(BA-2545): Add Artifact API descriptions Sep 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Documentations comp:manager Related to Manager component size:XL 500~ LoC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Artifact API description
2 participants