diff options
| author | Matt Riedemann <mriedem.os@gmail.com> | 2019-11-22 17:46:01 -0500 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2019-11-25 09:19:24 -0500 |
| commit | b7c6da30744b389cc15b547483ee8473c4ec1d6c (patch) | |
| tree | 5193f5fb9e4aaaf7fb9853b889125201e37e9b2d /api-guide | |
| parent | ce7649e4680b567797f7baf017fc3e22c3d7d929 (diff) | |
| download | nova-b7c6da30744b389cc15b547483ee8473c4ec1d6c.tar.gz | |
api-guide: flesh out todos in user doc
This is pretty basic. As for the todo about using named
personas I've just removed that since I don't think at
this point anyone is going to work on assigning names like
Bob and Sally to roles in the guide and consistently use them.
Change-Id: I88dfb23c0e2750dc37d32dfc431b62baed7238b6
Diffstat (limited to 'api-guide')
| -rw-r--r-- | api-guide/source/faults.rst | 1 | ||||
| -rw-r--r-- | api-guide/source/users.rst | 14 |
2 files changed, 8 insertions, 7 deletions
diff --git a/api-guide/source/faults.rst b/api-guide/source/faults.rst index 14a36dd6b1..c28e4ebcae 100644 --- a/api-guide/source/faults.rst +++ b/api-guide/source/faults.rst @@ -137,6 +137,7 @@ In many cases there are also notifications emitted that describe the error. This is an administrator focused API, that works best when treated as structured logging. +.. _synchronous_faults: Synchronous Faults ================== diff --git a/api-guide/source/users.rst b/api-guide/source/users.rst index e09cbb6d16..a0b74374a2 100644 --- a/api-guide/source/users.rst +++ b/api-guide/source/users.rst @@ -27,7 +27,9 @@ Keystone middleware is used to authenticate users and identify their roles. The Compute API uses these roles, along with oslo.policy, to decide what the user is authorized to do. -.. todo:: link to compute admin guide for details. +Refer to the to +:nova-doc:`compute admin guide </admin/arch#projects-users-and-roles>` +for details. Personas used in this guide =========================== @@ -53,14 +55,12 @@ actions on any of them. various facets of the different users but instead aims to be a minimal set of users such that we use a consistent terminology throughout this document. -.. todo:: - - could assign names to these users, or similar, to make it more "real". - Discovering Policy ================== An API to discover what actions you are authorized to perform is still a work -in progress. Currently this reported by a HTTP 403 error. +in progress. Currently this reported by a HTTP 403 +:ref:`error <synchronous_faults>`. -.. todo:: link to the doc on errors. +Refer to the :nova-doc:`configuration guide </configuration/policy>` for a list +of policy rules along with their default values. |