Skip to content

🏛️Product base types: add support for product base types in API #255

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

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

antirotor
Copy link
Member

Changelog Description

Adding support for product base types.

Additional review information

Once the product base types are established, they should be marked mandatory in function arguments and product_type optional.

Testing notes:

This shouldn't affect "normal" functionality. If product base type is provided, it should be successfully queried or written to/from server.

Note

Closes: #254
Requires: ynput/ayon-backend#615

@antirotor antirotor requested review from iLLiCiTiT and Copilot May 30, 2025 12:49
@antirotor antirotor self-assigned this May 30, 2025
@antirotor antirotor added the type: enhancement New feature or request label May 30, 2025
@antirotor antirotor linked an issue May 30, 2025 that may be closed by this pull request
1 task
Copy link

@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 support for product base types across the API, including new type definitions, query filters, and API operations.

  • Introduces ProductBaseTypeDict and default fields for product base types.
  • Updates API functions to support filtering, querying, and creating/updating products with the new product base type.
  • Extends GraphQL queries and entity hub operations to incorporate product base types.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
ayon_api/typing.py Added a new TypedDict for product base types.
ayon_api/server_api.py Extended product-related functions to support product base types.
ayon_api/operations.py Updated product entity creation and update operations to include base type; noted a naming typo.
ayon_api/graphql_queries.py Added GraphQL queries for product base types.
ayon_api/entity_hub.py Modified product entity handling to incorporate product base type with a documentation update.
ayon_api/constants.py Added default fields for product base types.
ayon_api/_api.py Updated API functions to include product base type filters.
ayon_api/init.py Re-exported new functions related to product base types.
Comments suppressed due to low confidence (2)

ayon_api/operations.py:117

  • Correct the misspelled parameter name from 'produc_base_type' to 'product_base_type' to ensure consistency with the documentation and usage.
produc_base_type: str,

ayon_api/entity_hub.py:447

  • Update the docstring to reflect that the function creates a product entity rather than a task object for clarity.
'''Create a task object and add it to the entity hub.

@github-project-automation github-project-automation bot moved this to Pending Review in PR reviewing May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
Status: Pending Review
Development

Successfully merging this pull request may close these issues.

🏛️Product base types: Add support
1 participant