From 6addd6bda0ef18859d3718e5351dd62b763013a0 Mon Sep 17 00:00:00 2001
From: licanwei <li.canwei2@zte.com.cn>
Date: Mon, 24 Dec 2018 16:57:29 +0800
Subject: [PATCH] update api-ref for audit start/end time

Change-Id: I2d81f58fc32885ec967df29f56b0dc040eb52534
---
 api-ref/source/parameters.yaml           | 24 ++++++++++++++++++++----
 api-ref/source/watcher-api-v1-audits.inc | 24 ++++++++++++------------
 2 files changed, 32 insertions(+), 16 deletions(-)

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 78987a1f7..aeb0d323d 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -191,9 +191,17 @@ audit_autotrigger:
   in: body
   required: false
   type: boolean
-audit_endtime:
+audit_endtime_req:
   description: |
-    The time after which audit can't be executed.
+    The local time after which audit can't be executed.
+    It will be converted to UTC time by Watcher.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+audit_endtime_resp:
+  description: |
+    The UTC time after which audit can't be executed.
   in: body
   required: false
   type: string
@@ -236,9 +244,17 @@ audit_parameters:
   in: body
   required: false
   type: JSON
-audit_starttime:
+audit_starttime_req:
   description: |
-    The time after which audit can be executed in accordance with interval.
+    The local time after which audit can be executed in accordance
+    with interval. It will be converted to UTC time by Watcher.
+  in: body
+  required: false
+  type: string
+  min_version: 1.1
+audit_starttime_resp:
+  description: |
+    The UTC time after which audit can be executed in accordance with interval.
   in: body
   required: false
   type: string
diff --git a/api-ref/source/watcher-api-v1-audits.inc b/api-ref/source/watcher-api-v1-audits.inc
index 3e83d82cf..014996c3f 100644
--- a/api-ref/source/watcher-api-v1-audits.inc
+++ b/api-ref/source/watcher-api-v1-audits.inc
@@ -45,8 +45,8 @@ Request
    - parameters: audit_parameters
    - interval: audit_interval
    - auto_trigger: audit_autotrigger
-   - start_time: audit_starttime
-   - end_time: audit_endtime
+   - start_time: audit_starttime_req
+   - end_time: audit_endtime_req
 
 **Example ONESHOT Audit creation request:**
 
@@ -81,8 +81,8 @@ version 1:
     - scope: audittemplate_scope
     - links: links
     - hostname: audit_hostname
-    - start_time: audit_starttime
-    - end_time: audit_endtime
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
 
 **Example JSON representation of an Audit:**
 
@@ -179,8 +179,8 @@ Response
     - scope: audittemplate_scope
     - links: links
     - hostname: audit_hostname
-    - start_time: audit_starttime
-    - end_time: audit_endtime
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
 
 **Example JSON representation of an Audit:**
 
@@ -225,8 +225,8 @@ Response
     - scope: audittemplate_scope
     - links: links
     - hostname: audit_hostname
-    - start_time: audit_starttime
-    - end_time: audit_endtime
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
 
 **Example JSON representation of an Audit:**
 
@@ -279,8 +279,8 @@ version 1:
     - scope: audittemplate_scope
     - links: links
     - hostname: audit_hostname
-    - start_time: audit_starttime
-    - end_time: audit_endtime
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
 
 **Example JSON representation of an Audit:**
 
@@ -333,8 +333,8 @@ Response
     - scope: audittemplate_scope
     - links: links
     - hostname: audit_hostname
-    - start_time: audit_starttime
-    - end_time: audit_endtime
+    - start_time: audit_starttime_resp
+    - end_time: audit_endtime_resp
 
 **Example JSON representation of an Audit:**