🏛️Product base types: add support for product base types in API #255
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
1 task
There was a problem hiding this comment.
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.
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
ayon_api/server_api.py
Outdated
| return parsed_data.get("project", {}).get("productBaseTypes", []) | ||
|
|
||
|
|
||
| def get_product_base_type_names( |
Member
There was a problem hiding this comment.
This function probably does not have to be implemented in server api.
It does 2 different things, either returns what get_project_product_base_types does or what get_products does. Looks like a helper functions somewhere in pipeline, but even there I can't imagine the usecase. I would not include it here.
iLLiCiTiT
reviewed
Jun 13, 2025
| name: str | ||
| color: Optional[str] | ||
| icon: Optional[str] | ||
|
|
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
| if value is not None: | ||
| update_data[key] = value | ||
|
|
||
| update_data = { |
Member
There was a problem hiding this comment.
We should check if product type is supported and raise an error if is passed and is not supported?
iLLiCiTiT
reviewed
Jun 13, 2025
iLLiCiTiT
reviewed
Jun 13, 2025
…oduct-base-types-add-support
…es-add-support' into enhancement/254-product-base-types-add-support
iLLiCiTiT
reviewed
Nov 11, 2025
Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>
…pport # Conflicts: # ayon_api/_api_helpers/projects.py
iLLiCiTiT
approved these changes
Nov 18, 2025
github-project-automation
bot
moved this from Pending Review
to Merge Requested
in PR reviewing
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.
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_typeoptional.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