Extend exception handler to report details
[ric-plt/a1.git] / docs / api-spec.rst
diff --git a/docs/api-spec.rst b/docs/api-spec.rst
new file mode 100644 (file)
index 0000000..2191c4d
--- /dev/null
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+
+A1 Mediator API
+===============
+
+This page shows the Open API specification for the A1 Mediator.
+Alternately, if you have checked out the code and are running the server,
+you can see a formatted version at this URL: ``http://localhost:10000/ui/``.
+
+OpenAPI Specification
+---------------------
+
+.. literalinclude:: ../a1/openapi.yaml
+   :language: yaml
+   :linenos: