docs/doc/source/api-ref/index.rst
Joao Victor Portal 13160ffba7 Add information about RBAC policy of StarlingX API
Story: 2010149
Task: 46653

Signed-off-by: Joao Victor Portal <Joao.VictorPortal@windriver.com>
Change-Id: Ic073a6b7b8a49c04c9360bc60e87906048d7907e
2022-10-26 12:44:19 -03:00

24 lines
894 B
ReStructuredText

==================
REST API Reference
==================
.. Please keep this list alphabetical
.. note::
Based on the |RBAC| policy, for every API listed below except for |PTP|
Status Notifications, the execution of ``GET`` requests requires a reader
role in either admin or services project; for ``non-GET`` requests (DELETE,
PATCH, POST and PUT), an admin role in either admin or services project is
required.
StarlingX project REST API references:
* `Bare Metal </api-ref/metal/index.html>`__
* `Configuration </api-ref/config/index.html>`__
* `Distributed Cloud </api-ref/distcloud/index.html>`__
* `Fault Management </api-ref/fault/index.html>`__
* `High Availability </api-ref/ha/index.html>`__
* `NFV </api-ref/nfv/index.html>`__
* `PTP Status Notifications </api-ref/ptp-notification-armada-app/index.html>`__
* `Software Updates </api-ref/update/index.html>`__