Add human-readable property to identify TypeInstance #579
Labels
area/cli
Relates to CLI
area/dashboard
Relates to Dashboard
area/engine
Relates to Engine
area/gateway
Relates to Gateway
area/hub
Relates to Hub
area/hub-manifests
Relates to Hub manifests
area/ocf
Relates to Open Capability Format
enhancement
New feature or request
needs-triage
Relates to issues that should be refined
Description
Currently, TypeInstance has:
- ID
- createdBy (optional)
- lockedBy
Unfortunately, it's hard to select a proper TypeInstance based only on those values. For example, Capact Upgrade requires multiple input TypeInstance of Type
cap.type.helm.chart.release
Without looking into TypeInstance details (value.name) it's hard to determine for which release it was created. Looking into value property is also not generic approach as each Type stored different data there.We need to have a generic approach to identify TypeInstance easily by our users. It must work both for manually created TypeInstances (e.g. via CLI/GraphQL Console) and automatically created (e.g. via Capact Action)
Reason
We are not able to select a proper TypeInstance based only on ID.
Use cases
Possible solutions
Currently, we require the alias property when you want to create a relation between TypeInstances. For example,
This property can be required always, and we can add it to the created TypeInstance on Hub side. Only the ID + alias pair is unique. As a result, we don't need to introduce a new property in our API. In Action workflows this property is already populated (maybe we will need to adjust our naming pattern a bit), together with createdBy property it should give enough information to identify a given TypeInstance.
The text was updated successfully, but these errors were encountered: