Fix guard application doc

recipe -> operation
added response example

Will cherry pick to frankfurt.

Issue-ID: POLICY-2656
Change-Id: Ia0e5c75d29edcecce54709f3659d3cd8f5bcfd15
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

diff --git a/docs/xacml/decision.guard.json b/docs/xacml/decision.guard.json
index ef1b5f6..9051c57 100644 (file)
--- a/docs/xacml/decision.guard.json
+++ b/docs/xacml/decision.guard.json
@@ -7,7 +7,7 @@
   "resource": {
       "guard": {
           "actor": "SO",
   "resource": {
       "guard": {
           "actor": "SO",

-          "recipe": "VF Module Create",
+          "operation": "VF Module Create",

           "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
           "target": "vLoadBalancer-00",
           "vfCount": "1"
           "clname": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
           "target": "vLoadBalancer-00",
           "vfCount": "1"

diff --git a/docs/xacml/tutorial/decision.guard.response.json b/docs/xacml/tutorial/decision.guard.response.json
new file mode 100644 (file)
index 0000000..24cc0d1
--- /dev/null
+++ b/docs/xacml/tutorial/decision.guard.response.json
@@ -0,0 +1 @@
+{"status":"Permit"}
\ No newline at end of file

diff --git a/docs/xacml/xacml.rst b/docs/xacml/xacml.rst
index f129a01..4100e80 100644 (file)
--- a/docs/xacml/xacml.rst
+++ b/docs/xacml/xacml.rst
@@ -110,6 +110,11 @@ This is an example Decision API payload made to retrieve a decision for a Guard
 .. literalinclude:: decision.guard.json
   :language: JSON
 
 .. literalinclude:: decision.guard.json
   :language: JSON
 

+The return decision simply has "permit" or "deny" in the response to tell the calling application whether they are allowed to perform the operation.
+
+.. literalinclude:: decision.guard.response.json
+  :language: JSON
+

 .. _xacml-optimization-label:
 
 Optimization Policy Types
 .. _xacml-optimization-label:
 
 Optimization Policy Types