Documentation for 'Fetch and Delete policy API with PolicyName and PolicyVersion'

[policy/parent.git] / docs / offeredapis.rst

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 580038c..ee90751 100644 (file)
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -1,6 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. _policy-offeredapis:
+
+.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
+.. _offeredapis:
 
 
 Policy Offered APIs
@@ -15,15 +17,6 @@ The Policy Framework supports the public APIs listed in the links below:
    pap/pap
    xacml/decision-api
 
--    :ref:`Policy Life Cycle API <api-label>`
--    :ref:`Policy Administration Point (PAP) <pap-label>`
--    :ref:`Decision API <decision-api-label>`
-
-
-.. warning:: The :ref:`Legacy APIs  <legacyapis-label>` are scheduled to be deprecated after the Frankfurt release!
-
--    :ref:`Legacy APIs <legacyapis-label>`  (To be DEPRECATED)
-
 Postman Environment for API Testing
 -----------------------------------
 
@@ -34,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 <https://github.com/onap/policy-api/blob/master/postman/lifecycle-api-collection.json>`_
+
+Postman collection for `Policy Framework Administration API <https://github.com/onap/policy-pap/blob/master/postman/pap-api-collection.json>`_
+
+Postman collection for `Policy Framework Decision API <https://github.com/onap/policy-xacml-pdp/blob/master/postman/decision-api-collection.json>`_
+
+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 <PolicyAPI.postman_collection.json>`