[GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth

[GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth

Critique

• 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, framework itself should be plural, i.e. frameworks, because /cbe/curriculum/frameworks is the collection of frameworks.

Suggestion

• If the endpoint returns a hierarchical list of nodes, then structure the URI by including /nodes as a sub-collection.

• This helps by making it clear what type of data is being returned.

• Rename framework to frameworks.

Final Suggestion

[GET] /cbe/curriculum/frameworks/{framework_id}/nodes