diff options
| author |   Saryu Shah <ss3917@att.com> | 2019-08-30 04:13:06 +0000 |
|---|---|---|
| committer | Saryu Shah <ss3917@att.com> | 2019-08-30 21:41:07 +0000 |
| commit | 990f41da6b9cd6689182c582ac7e818e143fda46 (patch) | |
| tree | 6ec17b4109e18e448779a446ade269920e30e40f | |
| parent | 42b2f87993f6a65a359d91fd87c01d748e26228a (diff) | |
Documentation - added offeredapis.rst in parent
Added links for the API including legacy. This will be linked in the master API reference page.
Issue-ID: POLICY-1984
Signed-off-by: Saryu Shah <ss3917@att.com>
Change-Id: Ibab75f6c2077539ca16845053ded880ff05b8dd4
| -rw-r--r-- | docs/offeredapis.rst | 16 | ||||
| -rw-r--r-- | docs/xacml/xacml.rst | 2 |
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100644 index 00000000..4e094166 --- /dev/null +++ b/docs/offeredapis.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Offered APIs +============ + +The Policy Framework supports the public APIs listed in the links below: + +- :ref:`Policy Life Cycle API <api-label>` +- :ref:`Policy Administration Point (PAP) <pap-label>`. +- :ref:`Decision API <decision-api-label>`. +- :ref:`Legacy APIs <legacyapis-label>` (To be DEPRECATED) + +.. warning:: The :ref:`Legacy APIs <legacyapis-label>` are scheduled to be deprecated after the Frankfurt release! + diff --git a/docs/xacml/xacml.rst b/docs/xacml/xacml.rst index 71873515..7c67723a 100644 --- a/docs/xacml/xacml.rst +++ b/docs/xacml/xacml.rst @@ -100,6 +100,8 @@ The following tutorial can be helpful to get started: :ref:`xacmltutorial-label` Once your application is developed and the ONAP XACML PDP Engine can find your application via setting the classpath appropriately, then use the :ref:`PAP REST API <pap-label>` to ensure the ONAP XACML PDP is registering your custom Policy Type with the PAP. Once successful, then you should be able to start deploying the created policies to the XACML PDP Engine. +.. _decision-api-label: + Decision API ************ The Decision API is used by ONAP components that enforce policies and need a decision on which policy to enforce for a specific situation. The Decision API mimics closely the XACML request standard in that it supports a subject, action and resource. |