Remove linkcheck and add API examples

[doc.git] / docs / templates / platform-component / offeredapis.rst

diff --git a/docs/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst
index 3e3b5b3..55e58bd 100644 (file)
--- a/docs/templates/platform-component/offeredapis.rst
+++ b/docs/templates/platform-component/offeredapis.rst
@@ -6,7 +6,24 @@ Offered APIs
 ============
 List APIs offered.   One or more of the following examples may be appropriate.
 
-* java docs link
-* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
-* a restructured text document
+Example Swagger Displayed with swaggerv2doc directive
+-----------------------------------------------------
 
+.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json
+
+
+Example documenting a REST interface with Sphinx httpdomain directive
+---------------------------------------------------------------------
+
+.. http:get:: path
+
+   For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
+
+
+Word Document Converted to RST using Pandocs
+--------------------------------------------
+
+.. toctree:: 
+   :maxdepth: 1
+
+   ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide