Repository navigation
Generalize use of URL fragments in used_by fields #4231
Description
Is there an existing issue for this?
- There is no existing issue for this feature
What are you currently unable to do
#3412 introduced the ability to return URL fragments of the form endpoint#config.key to account for references to resources without a dedicated API endpoint, such as configuration keys, in used_by fields.
When looking at the usage of my networks, important diagnostic information such as “what exactly makes /1.0/instances/my-instance dependent on my network?“ is missing.
What do you think would need to be added
I think we should generalize usage of the api_fragments API extension to all UsedBy fields, where it makes sense. For devices, I think the hierarchy should be encoded as #devices/<device name>/<config key>, e.g. /1.0/instances/my-instance#devices/eth0/network.
Activity
stgraber commentedon Oct 21, 2026
So we'll potentially have multiple used-by for the same instance?
Say if you have both eth0 and eth1 attached to the same network.
bensmrs commentedon Oct 22, 2026
That would be the idea, yep. We could still have the client filter out the fragments and deduplicate the resulting
used_bylist, or we could even have adetailed/expandedargument on the API endpoints that expose theUsedByfield, returning either the expanded usage or its deduplicated version.Another possibility is to have a combinator, say
//to allow concatenating a bunch of places where the object (here the network) is used, but I don’t like it.