Skip to content
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

Reserved link types #144

Open
martastain opened this issue Apr 16, 2024 · 2 comments
Open

Reserved link types #144

martastain opened this issue Apr 16, 2024 · 2 comments
Assignees

Comments

@martastain
Copy link
Member

Story

We'll need to reserve some basic built-in link types that we are using all across the board in pipeline code.

Namely:

  • reference|version|version
  • generative|version|version
  • breakdown|folder|folder
  • workflow|task|task

these four have special pusposes and we should be able to rely on them heavily in various automation.

Proposed solution

The easiest solution would be just to create a validator for the link types field of the Anatomy model. But from the UX perspective, we should also allow setting certain items in list[Submodel] fields as read only/non-removable.

@martastain martastain added MEDIUM type: enhancement Improvement of existing functionality or minor addition labels Apr 16, 2024
@martastain martastain self-assigned this Apr 24, 2024
@martastain martastain removed the MEDIUM label May 9, 2024
@dee-ynput
Copy link

This would help us, but the same issue will exists between other addons using the links.

A more generic solution would be to namespace/prefix the links types like ayon.reference, ayon.generative...

Internal link type could be dundered, as it is a pretty classic way to handle that situation: __reference__, __generative__, but IMO a prefix would make it more obvious to external addon devs that they should prefix their link types.

@mkolar
Copy link
Member

mkolar commented Sep 17, 2024

That in general is a good approach, however we can't now change how we name the links. We could however introduce this affiliation in metadata quite easily.

@martastain martastain removed the type: enhancement Improvement of existing functionality or minor addition label Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants