Add force field to api-ref

Change-Id: Iddea2359a13ba099e840b9501d4e9335905695f4
Implements: blueprint add-force-field-to-audit

api-ref/source/parameters.yaml

@@ -245,6 +245,13 @@ audit_endtime_resp:
   required: false
   type: string
   min_version: 1.1
+audit_force:
+  description: |
+    Launch audit even if action plan is ongoing.
+  in: body
+  required: false
+  type: boolean
+  min_version: 1.2
 audit_goal:
   description: |
     The UUID or name of the Goal.

api-ref/source/samples/audit-cancel-response.json

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

api-ref/source/samples/audit-create-request-continuous.json

@@ -1,5 +1,6 @@
 {
     "auto_trigger": false,
+    "force": false,
     "audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09",
     "name": "test_audit",
     "parameters": {

api-ref/source/samples/audit-create-request-oneshot.json

@@ -1,5 +1,6 @@
 {
     "audit_type": "ONESHOT",
     "auto_trigger": false,
+    "force": true,
     "audit_template_uuid": "5e70a156-ced7-4012-b1c6-88fcb02ee0c1"
-}
+}

api-ref/source/samples/audit-create-response.json

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

api-ref/source/samples/audit-list-detailed-response.json

@@ -30,6 +30,7 @@
                 }
             },
             "auto_trigger": false,
+	    "force": false,
             "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
             "goal_name": "workload_balancing",
             "scope": [],

api-ref/source/samples/audit-show-response.json

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

api-ref/source/samples/audit-update-response.json

@@ -28,6 +28,7 @@
         }
     },
     "auto_trigger": false,
+    "force": false,
     "uuid": "65a5da84-5819-4aea-8278-a28d2b489028",
     "goal_name": "workload_balancing",
     "scope": [],

api-ref/source/watcher-api-v1-audits.inc

@@ -47,6 +47,7 @@ Request
    - auto_trigger: audit_autotrigger
    - start_time: audit_starttime_req
    - end_time: audit_endtime_req
+   - force: audit_force
 
 **Example ONESHOT Audit creation request:**
 
@@ -83,6 +84,7 @@ version 1:
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -181,6 +183,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -227,6 +230,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -281,6 +285,7 @@ version 1:
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**
 
@@ -335,6 +340,7 @@ Response
     - hostname: audit_hostname
     - start_time: audit_starttime_resp
     - end_time: audit_endtime_resp
+    - force: audit_force
 
 **Example JSON representation of an Audit:**