openstack
/
api-sig
Code Issues Proposed changes
OpenStack API Special Interest Group
297 Commits 1 Branch 0 Tags 4.8 MiB
Python 100%
Go to file
Monty Taylor 31f6575ce4 Add guidelines on Version Discovery 
As an expansion of the guidelines around microversions, add guidelines
around how services should expose Version Discovery documents. This
includes recommendations for putting unversioned endpoints into the
catalog.

It also includes a completely new thought, so feel free to punch me in
the head - that versioned discovery documents should include a
collections rel link to allow clients to get from the versioned to the
universioned document without having to do URL manipulation. If we can
get that in, it should serve as a bridge for those clouds that are still
putting versioned endpoints into the catalog for a while for backwards
compat reasons.

Two related follow-up patches are in-work. One that adds a copy of the
consuming-discovery document with all of the extra effort in support of
clouds and services that to not implement these guidelines removed, so a
"perfect future state" is easy to read. The other is a document
recommending a global cloud "profile" that greatly reduces the API
burden on clients consuming this information.

Change-Id: Id8160048dfffc1ada32ce876a65b02fb7a02306e
 		2020-06-02 13:29:09 -05:00
doc/source Small cleanups 2020-03-19 10:52:23 +00:00
guidelines Add guidelines on Version Discovery 2020-06-02 13:29:09 -05:00
tests Use doc8 to verify rst instead of custom tests 2020-03-19 11:43:16 +01:00
tools Change API-WG to API-SIG 2017-10-12 18:07:33 +00:00
.gitignore Switch to stestr 2018-07-10 18:40:22 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:06 +00:00
.stestr.conf Switch to stestr 2018-07-10 18:40:22 +07:00
.zuul.yaml Use doc8 to verify rst instead of custom tests 2020-03-19 11:43:16 +01:00
LICENSE Moves from markdown to rst 2014-10-22 16:24:41 +10:30
README.rst Change API-WG to API-SIG 2017-10-12 18:07:33 +00:00
requirements.txt Cleanup py27 support 2020-04-11 14:37:38 +02:00
setup.cfg Cleanup py27 support 2020-04-11 14:37:38 +02:00
setup.py Moves from markdown to rst 2014-10-22 16:24:41 +10:30
tox.ini Merge "Verify JSON files in the CI" 2020-03-20 12:45:20 +00:00

README.rst

README

Openstack API Special Interest Group documents

This repository contains documents from the OpenStack API Special Interest Group, including guidelines and proposed rules concerning API consistency, naming conventions, and best practice recommendations. The published information can be found at specs.openstack.org.

Interested in contributing to the API conversations? Simply clone this repository and follow the OpenStack code and review submission processes and the process document.