Project

General

Profile

Feature #40913

Feature #40907: mgr/dashboard: REST API improvements

mgr/dashboard: REST API: HATEOAS support (linking)

Added by Ernesto Puerta about 3 years ago. Updated over 1 year ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
General - Back-end
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

HATEOAS or RMM level 3 API describes relationships between resources and links, so it allows a client to navigate across resources just by following their specified Links.

Example:
  • From /roo@t resource a client gets the list of child resources (e.g.: /cluster@).
  • From there (/cluster) they get a list of subordinate resources: (/cluster/hosts@, /cluster/logs, /cluster/config, ...).
  • From the list of hosts they can go the a specific host "example.com" and get their OSDs (/cluster/hosts/example.com/osds).
  • If the list of OSDs include more than the pagination limit (e.g.: 10), the response is limited to 10 OSDs, but a link to the next paginated (Link: </cluster/hosts/example.com/osds/?page=1>; rel="next").

An API supporting HATEOAS can be browsed by HATEOAS compliant client.

History

#1 Updated by Ernesto Puerta over 1 year ago

  • Project changed from mgr to Dashboard
  • Category changed from 146 to General - Back-end

Also available in: Atom PDF