{"type":"rich","version":"1.0","provider_name":"phorkie","provider_url":"https:\/\/p.cweiske.de\/","title":"REST API documentation with rST ","author_name":"Christian Weiske","cache_age":86400,"width":900,"height":900,"html":"<!-- embedding all files of https:\/\/p.cweiske.de\/713 -->\n<link rel=\"stylesheet\" href=\"https:\/\/p.cweiske.de\/css\/embed.css\"\/>\n<div class=\"phork\" id=\"713\">\n    <div class=\"phork-file\">\n <div class=\"phork-content\">\n  \n<div class=\"document\">\n\n\n<p>OpenStack uses reStructuredText to document their REST API.<\/p>\n<p>Example:<\/p>\n<ul class=\"simple\">\n<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>\n<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>\n<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>\n<\/ul>\n<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>\n<div class=\"section\" id=\"other-nice-api-docs-proprietary-format\">\n<h1>Other nice API docs (proprietary format)<\/h1>\n<ul class=\"simple\">\n<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>\n<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>\n<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>\n<li><a class=\"reference external\" href=\"https:\/\/stripe.com\/docs\/api\/metadata\">https:\/\/stripe.com\/docs\/api\/metadata<\/a><\/li>\n<\/ul>\n<\/div>\n<\/div>\n\n <\/div>\n <div class=\"phork-meta\">\n  <a href=\"https:\/\/p.cweiske.de\/713\/rev-raw\/73b3b5d15caee8f884983ed5c86cf0c6e3da1175\/README.rst\" style=\"float: right\">view raw source<\/a>\n  <a href=\"https:\/\/p.cweiske.de\/713#README.rst\">README.rst<\/a>\n <\/div>\n<\/div>\n<\/div>\n"}