Problem description
Related to review comments included with PR #73
The API currently mixes different resource relationships in its path structure, resulting in inconsistent resource hierarchy. For example:
/service-sites/{siteId}/devices
/service-sites/{siteId}/isolated-networks
/devices/{deviceId}/isolated-networks
/isolated-networks/{netId}/devices
Expected behavior
The API path structure should be refactored to use a consistent, flat hierarchy with no more than 2 levels. Resource ownership should be clearly defined (e.g., devices own networks or vice versa), and circular dependencies should be avoided.
Alternative solution
TBD
Additional context
This issue was identified during the CAMARA design review. Aligning the resource hierarchy with CAMARA guidelines will improve API clarity, reduce implementation complexity, and facilitate client code generation.
Problem description
Related to review comments included with PR #73
The API currently mixes different resource relationships in its path structure, resulting in inconsistent resource hierarchy. For example:
Expected behavior
The API path structure should be refactored to use a consistent, flat hierarchy with no more than 2 levels. Resource ownership should be clearly defined (e.g., devices own networks or vice versa), and circular dependencies should be avoided.
Alternative solution
TBD
Additional context
This issue was identified during the CAMARA design review. Aligning the resource hierarchy with CAMARA guidelines will improve API clarity, reduce implementation complexity, and facilitate client code generation.