X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fofferedapis.rst;h=a9e34cc2da2dbf9503266de2717d782137d86785;hb=fa9ddbfc8ae98ac96b69847c42302e4a384c63f6;hp=fb265d45c100bcfe3c7cb0a58efb89b9533d32e2;hpb=b3f559b69b764c5b8757a6b4fe5e38dcdbd5f0ff;p=policy%2Fparent.git diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index fb265d45..a9e34cc2 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -26,9 +26,9 @@ The following environment file from postman can be used for testing API's. All y :download:`Postman Environment ` .. note:: - If you are testing on a Docker Installation use *http* as **protocol**, *localhost* as **IP**, + If you are testing on a Docker Installation use *http* as **protocol**, *localhost* as **IP**, and the values set in the `export-ports.sh `_ as **PORT**. - More information in: :ref:`Docker Installation ` + More information in: :ref:`Docker Installation ` Postman Collection for API Testing ---------------------------------- @@ -47,24 +47,29 @@ the original "Swagger Specification," is being widely used in API developments. OAS 3.0 is used to describe the API contracts, and those documents are added as a source artifacts. -`Swagger Specification for Policy API `_ +`Swagger Specification for Policy API <./api/local-swagger.html>`_ -`Swagger Specification for Policy PAP `_ +`Swagger Specification for Policy PAP <./pap/local-swagger.html>`_ -`Swagger Specification for Policy XACML-PDP `_ +`Swagger Specification for Policy XACML-PDP <./xacml/local-swagger.html>`_ -`Swagger Specification for Policy ACM-R `_ +`Swagger Specification for Policy ACM-R <./clamp/acm/api-protocol/local-swagger.html>`_ `Swagger Specification for Policy DROOLS-PDP `_ -The YAML document can be imported in an web editor such as `Editor Swagger `_ +The YAML document can be also downloaded and imported in an web editor such as `Editor Swagger `_ An "OpenApi first" approach is adopted, so starting from the Swagger document we auto-generate interfaces that are implemented in the API controllers. .. note:: The Swagger document can still be extracted from the code in the API that uses *Spring-Doc* dependency at the endpoint "../v3/api-docs/" For Example ACM-Runtime endpoint - + + ``http://:/onap/policy/clamp/acm/v3/api-docs`` + + The Swagger document can still be extracted from the code in the API that uses *Spring-Doc* dependency at the endpoint "../v3/api-docs/" + For Example ACM-Runtime endpoint + ``http://:/onap/policy/clamp/acm/v3/api-docs``