starlingx
/
docs
Code Issues Proposed changes

Merge "Add information about RBAC policy of StarlingX API"

This commit is contained in:
Zuul 2022-10-27 18:41:21 +00:00 committed by Gerrit Code Review
parent 822a273fbd 13160ffba7
commit c68752f067
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>`__