openstack
/
os-api-ref
Code Issues Proposed changes

add section on warnings 

Change-Id: I3286a49dbefc56696136412272759d302dd1c431
This commit is contained in:
Sean Dague 2016-05-15 07:00:32 -04:00
parent e5699bc8ae
commit 8a80a67df6
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/usage.rst
View File

@ -180,3 +180,28 @@ rest_expand_all
The ``rest_expand_all`` stanza is used to place a control in the
document that will be a global Show / Hide for all sections. There are
times when this is extremely nice to have.
Runtime Warnings
================
The extension tries to help when it can point out that something isn't
matching up correctly. The following warnings are generated when
issues are found:
* parameters file is not found or parsable yaml
* a lookup value in the parameters file is not found
* the parameters file is not sorted
The sorting rules for parameters file is that first elements should be
sorted by ``in`` going from earliest to latest processed.
#. header
#. path
#. query
#. body
After that the parameters should be sorted by name, lower case alpha
numerically.
The sort enforcement is because in large parameters files it helps
prevent unintended duplicates.