openstack/api-sig
Code Issues Proposed changes
api-sig/guidelines/discoverability.rst
Chris Dent 6cfa7550dd Update compatibility doc and references 
The compatibility doc was out of date and making promises of having
additional information that is now provided by the interoperability
document. So we now link from compatibility to api_interoperability and
in discoverability where we had been linking to compatibility we now
link to the recent information on consuming the catalog.

Change-Id: I296d5b167ffad63a256a2b133ee9250710e2837b
Closes-Bug: #1593312
2017-07-26 17:20:31 +01:00

430 B
Raw Blame History

API Discoverability

This topic document serves to provide guidance on how to have a public REST API expose the URIs and resources to end users in a machine-readable way.

See also the topic document on consuming-catalog.

Guidance

TODO Add sections that describe a best practice for API discoverability, possibly using JSON-Home, JSONSchema documents, and JSON-HAL.