openstack/nova
Code Issues Proposed changes

api-guide: flesh out todos in user doc

Browse Source 
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
This commit is contained in:
Matt Riedemann 2019-11-22 17:46:01 -05:00
parent ce7649e468
commit b7c6da3074
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-guide/source/faults.rst
View File

@ -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
==================

14
api-guide/source/users.rst
View File

@ -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.