X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Ftemplates%2Fplatform-component%2Fofferedapis.rst;h=55e58bd9b3b1c30f98a1043be7be62ac1be0a544;hb=3beeced464fd424bda372d098a3b907f577d4155;hp=3e3b5b3d0218f059ded18baa68a605430bef8a0b;hpb=477610ff2502a80550d862a4877cf7bb47af5290;p=doc.git 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