Explicitly link to the HTTP RFCs
In the opening we advise people to use the HTTP RFCs as the ultimate authority but do not link to them. This change adds the links and generalizes the warning to the entirety of the guidelines, not just to non-JSON apis. Change-Id: I40a59594a477d6802a16d8b0ca11020629eff292
This commit is contained in:
parent
abd46fb0f2
commit
b6d58a3f7f
|
@ -35,8 +35,12 @@ http://docs.openstack.org/infra/manual/developers.html
|
|||
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.
|
||||
guidance that is complete.
|
||||
|
||||
.. note::
|
||||
Where this guidance is incomplete or ambiguous, refer to the HTTP
|
||||
RFCs—:rfc:`7230`, :rfc:`7231`, :rfc:`7232`, :rfc:`7233`, :rfc:`7234`, and
|
||||
:rfc:`7235`—as the ultimate authority.
|
||||
|
||||
Guidelines
|
||||
----------
|
||||
|
|
Loading…
Reference in New Issue