starlingx/docs
Code Issues Proposed changes

Add information about RBAC policy of StarlingX API

Browse Source 
Story: 2010149
Task: 46653

Signed-off-by: Joao Victor Portal <Joao.VictorPortal@windriver.com>
Change-Id: Ic073a6b7b8a49c04c9360bc60e87906048d7907e
This commit is contained in:
Joao Victor Portal 2022-10-25 20:33:51 -03:00
parent 0b970fb16f
commit 13160ffba7
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/api-ref/index.rst
View File

@ -4,6 +4,13 @@ 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>`__