From 13160ffba7bf34fd4343280bfd98a6ae392a8cc9 Mon Sep 17 00:00:00 2001 From: Joao Victor Portal Date: Tue, 25 Oct 2022 20:33:51 -0300 Subject: [PATCH] Add information about RBAC policy of StarlingX API Story: 2010149 Task: 46653 Signed-off-by: Joao Victor Portal Change-Id: Ic073a6b7b8a49c04c9360bc60e87906048d7907e --- doc/source/api-ref/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/api-ref/index.rst b/doc/source/api-ref/index.rst index a971c89b2..eb9bfb417 100644 --- a/doc/source/api-ref/index.rst +++ b/doc/source/api-ref/index.rst @@ -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 `__