openstack/api-sig
Code Issues Proposed changes

add a warning about json expectations

Browse Source 
This change follows the discussion from a recent wg meeting[1] about
making a clear statement that the guidelines are assumed to be written
for JSON based payloads.

[1]:
http://eavesdrop.openstack.org/irclogs/%23openstack-meeting-3/%23openstack-meeting-3.2016-08-18.log.html#t2016-08-18T16:33:56

Change-Id: Iae6266c00062ad1693fe680b839dac49ff5518f7
Closes-Bug: #1614624
This commit is contained in:
Michael McCune 2016-09-01 12:50:29 -04:00
parent 64e3e9b072
commit 57b9aa6a51
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/index.rst
View File

@ -29,6 +29,15 @@ OpenStack code and review submission processes are described at:
http://docs.openstack.org/infra/manual/developers.html
.. warning::
These documents from the API Working Group are primarily focused on
providing advice and guidelines for JSON-based APIs. While other
representations have their place in the OpenStack ecosystem, they present
such a diversity of challenges and edge cases, especially with large
and/or binary request and response bodies, that it is impossible to
provide guidance that is complete. Where there is doubt refer to the
HTTP RFCs, 7230 through 7235, as the ultimate authority.
Guidelines
----------