X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fofferedapis.rst;h=ee90751a0d66fe0f48817c6daeae513230a67e87;hb=6b0695c3e1a45fb8172790425422b66dc59c65ee;hp=628487ce2ba9f6ab40d3702cee7d6680d4d8c6df;hpb=68966c0d1cb9a35e01da9f1ddf3a33f790325216;p=policy%2Fparent.git 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 `_ 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” + +