Skip to content

design considerations

Klaus Kämpf edited this page Nov 9, 2022 · 1 revision

API design considerations

This is about API design for use by the Elemental UI

See issue #228 for reference.

Elemental APIs should

  • be RESTful
    • (given that it uses the login credentials/auth token (not sure which we use currently) for rancher API so that we don't need to provide a new token for a new API.)
  • must be async, as things might take longer to perform
    • usually kick-off with POST request, return handle, use handle to get status, result or error message
  • results might be large (like ISO download)
Clone this wiki locally