SG-43936 [Data Model] Add Reference components on publish#1115
Open
carlos-villavicencio-adsk wants to merge 15 commits into
Open
SG-43936 [Data Model] Add Reference components on publish#1115carlos-villavicencio-adsk wants to merge 15 commits into
carlos-villavicencio-adsk wants to merge 15 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feat/data-model-base #1115 +/- ##
========================================================
- Coverage 80.41% 80.27% -0.14%
========================================================
Files 203 203
Lines 19549 19680 +131
========================================================
+ Hits 15720 15798 +78
- Misses 3829 3882 +53
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
- add new "variantSet" and "source" components to schema config - removed unnecessary calls to ensure_unique_name() when creating asset hierarchy - replace Task folder in asset hierarchy with a root asset which is of type "container" for now - necessary in order for the Asset Viewer to display its children - move generic assets directly under pipeline step in asset hierarchy - added FlowAsset.get_derivatives() function - switched existing derivative workflow to use new "source" component instead of previous temporary component for designating derivative source - use get_schema_id() within ComponentSpecs to avoid needing to pass in type_id parameter for components using custom schemas - added components_action parameter to publish_new_revision() so that user can choose to append components rather than replace them (which is default behaviour) - formatting for schema_builder.py
Properties typed as autodesk.me:reference-2.0.0 are nested schema objects,
not primitives. The server expects {"objectId": {"id": "<urn>"}} rather than
a plain string, matching the autodesk.data:reference-2.0.0 schema structure.
- Add build_reference_value() utility to utils.py to centralize this format
- Fix DerivativeSourceComponentSpec.targetVersion to use build_reference_value()
- Fix VariantSetComponentSpec.targetAsset to use build_reference_value()
…tructure The targetVersion property is typed as autodesk.me:reference-2.0.0, whose objectId field is autodesk.data:identifier-1.0.0 (a nested object with an id field), not a plain string. After fixing the serialization in DerivativeSourceComponentSpec, the RSQL filter path must reflect the new structure: data.targetVersion.objectId.id instead of data.targetVersion. Without this fix, get_derivatives() always returned empty because the old filter path never matched the nested object, causing a new derivative asset to be created on every publish instead of versioning the existing one.
- added get_sources() and get_variant_sets() utilities to ComponentMixin - handle reference properties in FlowComponent so that they're more useable.
…et/SG-43936_add_reference_on_publish
carlos-villavicencio-adsk
changed the base branch from
master
to
ticket/sg-43935/data-model-derivative-update
July 15, 2026 15:59
Base automatically changed from
ticket/sg-43935/data-model-derivative-update
to
feat/data-model-base
July 15, 2026 18:07
carlos-villavicencio-adsk
marked this pull request as ready for review
July 16, 2026 15:08
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
| if dep.dep_type != DepType.ASSET: | ||
| raise FlowError( | ||
| f"Dependency at index {i} has unexpected type " | ||
| f"{dep.dep_type!r}. Only DepType.ASSET deps should be " |
Contributor
There was a problem hiding this comment.
Typo I think? Is the "!r" supposed to be in this string?
Contributor
Author
There was a problem hiding this comment.
!r calls repr() on the value instead of str(). For an enum like DepType.LOCAL it produces <DepType.LOCAL: 'local'> rather than just DepType.LOCAL, which gives more context in error messages. What do you think?
Contributor
There was a problem hiding this comment.
Oh I didn't know that syntax. I guess I usually just say dep.dep_type.name - I think this is clearer?
Contributor
There was a problem hiding this comment.
Oh actually I think "DepType.LOCAL" is best personally. Of the three options.
Contributor
Author
There was a problem hiding this comment.
Got it, changed to {dep.dep_type} instead.
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
reviewed
Jul 16, 2026
yungsiow
approved these changes
Jul 16, 2026
yungsiow
left a comment
yungsiow
left a comment
Contributor
There was a problem hiding this comment.
Small suggestion, not a big deal. Looks good otherwise!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request introduces support for "reference components" to record asset dependencies in the pipeline. The main changes include updating the schema, adding a new
ReferenceComponentSpecclass, and updating the publish utilities to create reference components when internal asset dependencies are detected.Support for reference components and dependency tracking:
component.referenceschema toconfig.jsonto represent asset dependencies as components.ReferenceComponentSpecclass inpublish.pyto encapsulate creation of reference components, including theirversion_id.create_components_for_publishinutils.pyto accept anint_depsargument and create aReferenceComponentSpecfor each asset-type dependency found in the scene. [1] [2]REFERENCE_TYPEconstant toglobals.pyand imported it where needed. [1] [2] [3]API enhancements for dependency access:
get_references()method toFlowProject(inobjects.py) to retrieve all reference components on an asset or revision.Additionally, the pipeline schema version was bumped to 1.1.0 to reflect these changes.