docs/offeredapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   5 .. _offeredapis:
   6
   7
   8 Policy Offered APIs
   9 ===================
  10
  11 The Policy Framework supports the public APIs listed in the links below:
  12
  13 .. toctree::
  14    :maxdepth: 1
  15
  16    api/api
  17    pap/pap
  18    xacml/decision-api
  19
  20 Postman Environment for API Testing
  21 -----------------------------------
  22
  23 The following environment file from postman can be used for testing API's. All you need to do is fill in the IP and Port information for the installation that you have created.
  24
  25 :download:`link <PolicyAPI.postman_environment.json>`
  26
  27 Postman Collection for API Testing
  28 ----------------------------------
  29
  30 Postman collection for `Policy Framework Lifecycle API <https://github.com/onap/policy-api/blob/master/postman/lifecycle-api-collection.json>`_
  31
  32 Postman collection for `Policy Framework Administration API <https://github.com/onap/policy-pap/blob/master/postman/pap-api-collection.json>`_
  33
  34 Postman collection for `Policy Framework Decision API <https://github.com/onap/policy-xacml-pdp/blob/master/postman/decision-api-collection.json>`_
  35
  36 API Swagger Generation
  37 ----------------------
  38
  39 The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS, which is based on
  40 the original "Swagger Specification," is being widely used in API developments.
  41
  42 Execute the below curl command for swagger generation by filling in the authorization details, IP and Port information:
  43
  44 .. code-block:: bash
  45
  46   “curl -k --user ‘{user_id}:{password}’ https://{ip}:{port}/swagger.json”
  47
  48