X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fofferedapis.rst;h=ee90751a0d66fe0f48817c6daeae513230a67e87;hb=a6c09a2f247323d92a64cdf5793442da9a13e05c;hp=799facfd57cb59b9c737cf66b9367306e14d4632;hpb=7a00e85e21533d2a11300a61439b4ab3a420c1d5;p=policy%2Fparent.git diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 799facfd..ee90751a 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -17,10 +17,6 @@ The Policy Framework supports the public APIs listed in the links below: pap/pap xacml/decision-api -.. warning:: The :ref:`Legacy APIs ` are scheduled to be deprecated after the Frankfurt release! - -- :ref:`Legacy APIs ` (To be DEPRECATED) - Postman Environment for API Testing ----------------------------------- @@ -31,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 `