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

antirotor · 2025-05-30T12:49:04Z

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

Copilot

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.

ayon_api/server_api.py

iLLiCiTiT · 2025-06-13T09:36:32Z

ayon_api/server_api.py

+
+        return parsed_data.get("productBaseTypes", [])
+
+


Suggested change

iLLiCiTiT · 2025-06-13T09:40:57Z

ayon_api/server_api.py

+        return parsed_data.get("project", {}).get("productBaseTypes", [])
+
+
+    def get_product_base_type_names(


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 · 2025-06-13T09:42:39Z

ayon_api/typing.py

+    name: str
+    color: Optional[str]
+    icon: Optional[str]
+


Suggested change

iLLiCiTiT · 2025-06-13T09:43:29Z

ayon_api/entity_hub.py

@@ -3475,6 +3501,7 @@ def from_entity_data(cls, product, entity_hub):
        return cls(
            name=product["name"],
            product_type=product["productType"],
+            product_base_type=product["productBaseType"],


Suggested change

product_base_type=product["productBaseType"],

product_base_type=product.get("productBaseType"),

iLLiCiTiT · 2025-06-13T09:44:00Z

ayon_api/entity_hub.py

@@ -3492,6 +3519,7 @@ def to_create_body_data(self):
        output = {
            "name": self.name,
            "productType": self.product_type,
+            "productBaseType": self.product_base_type,


This key should be added only if product base type is supported on server.

iLLiCiTiT · 2025-06-13T09:44:49Z

ayon_api/graphql_queries.py

@@ -143,6 +165,30 @@ def project_product_types_query(fields):
    return query


+def project_product_base_types_query(fields):


I really don't think this should have separate query, it should be added to project query and it does not need special method (meaning get_project_product_base_types).

iLLiCiTiT · 2025-06-13T09:46:04Z

ayon_api/operations.py

-            product under folder.
+        name (str): Is considered as a unique identifier of
+            the product under the folder.
+        product_base_type (str): Base type of the product, e.g. "render",


Wrong position of argument

iLLiCiTiT · 2025-06-13T09:46:18Z

ayon_api/operations.py


        Args:
            project_name (str): Project name.
            name (str): Product name.
-            product_type (str): Product type.
+            product_base_type (str): Base type of the product, e.g. "render",


Wrong position of argument.

iLLiCiTiT · 2025-06-13T09:46:58Z

ayon_api/operations.py

-            if value is not None:
-                update_data[key] = value
-
+        update_data = {


We should check if product type is supported and raise an error if is passed and is not supported?

iLLiCiTiT · 2025-06-13T09:48:44Z

ayon_api/entity_hub.py

@@ -443,10 +444,11 @@ def add_new_product(
        entity_id: Optional[str] = None,
        created: Optional[bool] = True,
    ):
-        """Create task object and add it to entity hub.
+        """Create a task object and add it to the entity hub.


Suggested change

"""Create a task object and add it to the entity hub.

"""Create a product object and add it to the entity hub.

iLLiCiTiT · 2025-06-13T09:50:02Z

ayon_api/server_api.py

ServerAPI should have property to check if product base type is supported and that property should be checked if is productBaseType is used for filtering or entity create/update.

✨ add support for product base types

b8e1050

antirotor requested review from iLLiCiTiT and Copilot May 30, 2025 12:49

antirotor self-assigned this May 30, 2025

antirotor added the type: enhancement New feature or request label May 30, 2025

antirotor linked an issue May 30, 2025 that may be closed by this pull request

🏛️Product base types: Add support #254

Open

1 task

Copilot AI reviewed May 30, 2025

View reviewed changes

ayon_api/server_api.py Outdated Show resolved Hide resolved

antirotor added this to PR reviewing May 30, 2025

github-project-automation bot moved this to Pending Review in PR reviewing May 30, 2025

🐛 remove the stray character in comment

1eeae55

antirotor mentioned this pull request May 30, 2025

🏛️Product base types: add support to loaders ynput/ayon-core#1301

Merged

✨ add productBaseType to PRODUCT_FIELDS

4d83ab8

antirotor mentioned this pull request Jun 6, 2025

🏛️Product base types: Creation and creator plugins ynput/ayon-core#1297

Open

♻️ better handling of product base type in entity operations

ceff641

antirotor mentioned this pull request Jun 10, 2025

🏛️Product base types: Support in the integrator ynput/ayon-core#1315

Open

✨ add product base type getters to init and linting

e3bc2c5

antirotor marked this pull request as ready for review June 10, 2025 11:20

iLLiCiTiT reviewed Jun 13, 2025

View reviewed changes

ayon_api/server_api.py

return parsed_data.get("productBaseTypes", [])

Copy link

Member

iLLiCiTiT Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

iLLiCiTiT reviewed Jun 13, 2025

View reviewed changes

ayon_api/typing.py

name: str

color: Optional[str]

icon: Optional[str]

Copy link

Member

iLLiCiTiT Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

iLLiCiTiT reviewed Jun 13, 2025

View reviewed changes

iLLiCiTiT added 2 commits June 26, 2025 11:47

fix used function to create query

3a96dd6

remove unnecessary 'get_product_base_type_names' function

cb4a9f9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

antirotor commented May 30, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025 •

edited

Loading

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025 •

edited

Loading

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025 •

edited

Loading

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

iLLiCiTiT Jun 13, 2025

Uh oh!

Uh oh!

		return parsed_data.get("project", {}).get("productBaseTypes", [])


		def get_product_base_type_names(

	product_base_type=product["productBaseType"],
	product_base_type=product.get("productBaseType"),

		@@ -143,6 +165,30 @@ def project_product_types_query(fields):
		return query


		def project_product_base_types_query(fields):

	"""Create a task object and add it to the entity hub.
	"""Create a product object and add it to the entity hub.

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

antirotor commented May 30, 2025

Changelog Description

Additional review information

Testing notes:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iLLiCiTiT Jun 13, 2025 •

edited

Loading

iLLiCiTiT Jun 13, 2025 •

edited

Loading

iLLiCiTiT Jun 13, 2025 •

edited

Loading