summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2017-09-15 01:25:06 +0000
committerLusheng Ji <lji@research.att.com>2017-09-15 03:06:55 +0000
commit73b40eba22e9b0a41e3fc8b420df97f45805b9f3 (patch)
treea8a77a55390e1c9919e3b01d44655db37d1a7356
parent869ede1c52f9c1602e69d4814398e3ddde3ed2c2 (diff)
Add intial docs
Issue-Id: DCAEGEN2-109 Change-Id: I8180bdcc689878dc768251b69b0a149f1bfa9d20 Signed-off-by: Lusheng Ji <lji@research.att.com>
-rw-r--r--docs/index.rst8
-rw-r--r--docs/offeredapis.rst12
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..833e1aa9
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+TODO Add files to toctree and delete this header
+------------------------------------------------
+.. toctree::
+ :maxdepth: 1
+
+
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644
index 00000000..8360848e
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,12 @@
+DCAEGEN2 Components Offered APIs
+==================================
+
+- `CDAP Broker Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/cdapbroker.git;a=blob_plain;f=swagger/swagger.yaml;hb=HEAD>`_.
+
+- `Config Binding Service Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/configbinding.git;a=blob_plain;f=config_binding_service/swagger/swagger.yaml;hb=HEAD>`_.
+
+- `Deployment Handler Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/deployment-handler.git;a=blob_plain;f=dispatcherAPI.yaml;hb=HEAD>`_.
+
+- `Inventory API Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/inventory-api.git;a=blob_plain;f=swagger_inventory.yaml;hb=HEAD>`_.
+
+- `VES Collector Swagger Yaml <https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.git;a=blob_plain;f=swagger_vescollector.yaml;hb=HEAD>`_.