X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fofferedapis.rst;h=ee90751a0d66fe0f48817c6daeae513230a67e87;hb=530236fbbd76434bb76fb62579c8b9f6132e0698;hp=818b1f5c7444622e2317905d2152a8b160d8c313;hpb=488dd18f0f196d1e4544d2b030774b64fa56c5c5;p=policy%2Fparent.git diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 818b1f5c..ee90751a 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -1,5 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _offeredapis: @@ -8,12 +10,12 @@ Policy Offered APIs The Policy Framework supports the public APIs listed in the links below: -- :ref:`Policy Life Cycle API ` -- :ref:`Policy Administration Point (PAP) `. -- :ref:`Decision API `. -- :ref:`Legacy APIs ` (To be DEPRECATED) +.. toctree:: + :maxdepth: 1 -.. warning:: The :ref:`Legacy APIs ` are scheduled to be deprecated after the Frankfurt release! + api/api + pap/pap + xacml/decision-api Postman Environment for API Testing ----------------------------------- @@ -25,6 +27,22 @@ The following environment file from postman can be used for testing API's. All y Postman Collection for API Testing ---------------------------------- -The following collection can be used in Postman to assist in testing the Policy APIs. +Postman collection for `Policy Framework Lifecycle API `_ + +Postman collection for `Policy Framework Administration API `_ + +Postman collection for `Policy Framework Decision API `_ + +API Swagger Generation +---------------------- + +The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS, which is based on +the original "Swagger Specification," is being widely used in API developments. + +Execute the below curl command for swagger generation by filling in the authorization details, IP and Port information: + +.. code-block:: bash + + “curl -k --user ‘{user_id}:{password}’ https://{ip}:{port}/swagger.json” + -:download:`link `