From 3beeced464fd424bda372d098a3b907f577d4155 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Mon, 18 Sep 2017 10:01:25 -0400 Subject: Remove linkcheck and add API examples Part 1 of moviing linkcheck from verify to a CSIT job Added API examples and extensions used to document APIs Change-Id: I5dd536c50930b09bb129e95a9767c97f09c0604b Issue-ID: DOC-82 Signed-off-by: Rich Bennett --- docs/templates/platform-component/offeredapis.rst | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'docs/templates') diff --git a/docs/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst index 3e3b5b3d0..55e58bd9b 100644 --- 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 ``_ + + +Word Document Converted to RST using Pandocs +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide -- cgit 1.2.3-korg