REST API documentation with rST

revision 5afb8f7ced98ecdcecd3b4e095f873bb2d3eb2fd

raw

README.rst

OpenStack uses reStructuredText to document their REST API.

Example: - https://docs.openstack.org/api-ref/database/?expanded=id30-detail,create-datastore-version-detail - Source: https://opendev.org/openstack/trove/src/branch/master/api-ref/source - Source: https://opendev.org/openstack/trove/src/branch/master/api-ref/source/datastore-versions.inc

They use rST with shared parameter definitions in a parameters.yaml file, and have custom directives like .. rest_method:: and .. rest_parameters::

History