rich1.0phorkiehttps://p.cweiske.de/Christian Weiske86400900900<!-- embedding all files of https://p.cweiske.de/713 --> <link rel="stylesheet" href="https://p.cweiske.de/css/embed.css"/> <div class="phork" id="713"> <div class="phork-file"> <div class="phork-content"> <div class="document"> <p>OpenStack uses reStructuredText to document their REST API.</p> <p>Example:</p> <ul class="simple"> <li><a class="reference external" href="https://docs.openstack.org/api-ref/database/?expanded=id30-detail,create-datastore-version-detail">https://docs.openstack.org/api-ref/database/?expanded=id30-detail,create-datastore-version-detail</a></li> <li>Source: <a class="reference external" href="https://opendev.org/openstack/trove/src/branch/master/api-ref/source">https://opendev.org/openstack/trove/src/branch/master/api-ref/source</a></li> <li>Source: <a class="reference external" href="https://opendev.org/openstack/trove/src/branch/master/api-ref/source/datastore-versions.inc">https://opendev.org/openstack/trove/src/branch/master/api-ref/source/datastore-versions.inc</a></li> </ul> <p>They use rST with shared parameter definitions in a <tt class="docutils literal">parameters.yaml</tt> file, and have custom directives like <tt class="docutils literal">.. rest_method::</tt> and <tt class="docutils literal">.. rest_parameters::</tt></p> <div class="section" id="other-nice-api-docs-proprietary-format"> <h1>Other nice API docs (proprietary format)</h1> <ul class="simple"> <li><a class="reference external" href="https://docs.github.com/en/rest/reference/issues#create-an-issue">https://docs.github.com/en/rest/reference/issues#create-an-issue</a></li> <li><a class="reference external" href="https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member">https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member</a></li> <li><a class="reference external" href="https://www.twilio.com/docs/usage/bulkexport/export-custom-job">https://www.twilio.com/docs/usage/bulkexport/export-custom-job</a></li> <li><a class="reference external" href="https://stripe.com/docs/api/metadata">https://stripe.com/docs/api/metadata</a></li> </ul> </div> </div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/713/rev-raw/73b3b5d15caee8f884983ed5c86cf0c6e3da1175/README.rst" style="float: right">view raw source</a> <a href="https://p.cweiske.de/713#README.rst">README.rst</a> </div> </div> </div>