openstack
/
api-sig
Code Issues Proposed changes

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
This commit is contained in:
Chris Dent 2014-10-24 16:31:53 +01:00
parent 3178b4c722
commit e3098a8e32
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
guidelines/general.rst Normal file
View File

@ -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.