From e19e114c80d693083d58c8880a67bb5a85981a93 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Thu, 30 Aug 2018 18:09:33 +0100 Subject: [PATCH] Add link to Building Protocols with HTTP In a recent api-sig meeting it was decided that we should link to this document as a good introduction and commentary on best practices. Change-Id: I662ed5c9c21a6eafb74cd1e224bf8c8953a556b6 --- doc/source/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index b3014a5..89e77f5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -40,7 +40,9 @@ http://docs.openstack.org/infra/manual/developers.html .. 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. + :rfc:`7235`—as the ultimate authority. For advice on effectively using + HTTP in APIs see `Building Protocols with + HTTP `_. Guidelines ----------