diff options
| author |   puthuparambil.aditya <aditya.puthuparambil@bell.ca> | 2020-07-27 12:09:40 +0100 |
|---|---|---|
| committer | puthuparambil.aditya <aditya.puthuparambil@bell.ca> | 2020-07-27 14:44:01 +0100 |
| commit | a6c09a2f247323d92a64cdf5793442da9a13e05c (patch) | |
| tree | 9ecb6628426ef2aae59982f177706524afd4dde8 /docs/offeredapis.rst | |
| parent | 1ea659a07c611ea89a80aa1d85b8390b6799c36f (diff) | |
Documentation for 'Fetch and Delete policy API with PolicyName and PolicyVersion'
Issue-ID: POLICY-2585
Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
Change-Id: I76c41dd139b3d41e1cadc61108682ff4bdc6f6a0
Diffstat (limited to 'docs/offeredapis.rst')
| -rw-r--r-- | docs/offeredapis.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 628487ce..ee90751a 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -32,3 +32,17 @@ Postman collection for `Policy Framework Lifecycle API <https://github.com/onap/ 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” + + |