(no commit message)
authorChristian Weiske <cweiske@cweiske.de>
Thu, 11 Feb 2021 20:41:49 +0000 (21:41 +0100)
committerwww-cweiske <www-cweiske@ahso3>
Thu, 11 Feb 2021 20:41:49 +0000 (21:41 +0100)
README.rst [new file with mode: 0644]

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..54048da
--- /dev/null
@@ -0,0 +1,9 @@
+OpenStack uses reStructuredText to document their REST API.\r
+\r
+\r
+Example:\r
+- https://docs.openstack.org/api-ref/database/?expanded=id30-detail,create-datastore-version-detail\r
+- Source: https://opendev.org/openstack/trove/src/branch/master/api-ref/source\r
+- Source: https://opendev.org/openstack/trove/src/branch/master/api-ref/source/datastore-versions.inc\r
+\r
+They use rST with shared parameter definitions in a ``parameters.yaml`` file, and have custom directives like ``.. rest_method::`` and ``.. rest_parameters::``
\ No newline at end of file