openstack/api-sig
Code Issues Proposed changes
api-sig/guidelines/discoverability.rst
Chris Yeoh e00144c3a0 Moves from markdown to rst 
Changes format of files from markdown to reStructuredText
and adds the tox targets to verify the format and build
the html. Also adds bits and pieces needed to finish
bootstrapping the repository.

Change-Id: If559c21f19d7044a0d89b29e5743bf09c9da2ac1
2014-10-22 16:24:41 +10:30

426 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 compatibility.

Guidance

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