api-sig/guidelines/consuming-catalog
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
..
authority.rst Add document describing consuming version discovery 2020-06-02 13:23:43 -05:00
endpoint.rst Add document describing consuming version discovery 2020-06-02 13:23:43 -05:00
version-discovery.rst Add guidelines on Version Discovery 2020-06-02 13:29:09 -05:00