From e3098a8e3276f1f04faf1b0286797dd599a0f59c Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Fri, 24 Oct 2014 16:31:53 +0100 Subject: [PATCH] Add a "general" section This is for topics which do not easily fit into specific topics but are more about overall style or general attitude of approach. For an initial proposal, diversity of clients seems a good guideline. Change-Id: I70d54a0ce98b7a583ba0b1e171b89d206acad98f --- guidelines/general.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 guidelines/general.rst diff --git a/guidelines/general.rst b/guidelines/general.rst new file mode 100644 index 0000000..2a25c6f --- /dev/null +++ b/guidelines/general.rst @@ -0,0 +1,16 @@ + +General +======= + +This topic document serves to provide guidance on general topics of +style and approaches to developing and managing public HTTP APIs. + +Guidelines +---------- + +1. While every public API should have a canonical client + implementation we should discourage tight bindings between an API + and its clients and strongly encourage separate evolution of + the API and its official client. We welcome any effort aimed at + developing and promoting alternative clients. A diversity of + implementations is healthy and enables use in many environments.