[GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth
[GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth
From the route alone, it is unclear what the resource is for this endpoint.
For example, is a framework being returned? Or a list of objective sets?
In reality, this endpoint returns a hierarchical list of nodes associated with the specified framework.
In addition,
frameworkitself should be plural, i.e.frameworks, because/cbe/curriculum/frameworksis the collection of frameworks.
If the endpoint returns a hierarchical list of nodes, then structure the URI by including
/nodesas a sub-collection.This helps by making it clear what type of data is being returned.
Rename
frameworktoframeworks.
Last updated