From 2aac31c11fece52d7eb06228649f0adef685605b Mon Sep 17 00:00:00 2001
From: jiaopengju <jiaopengju@cmss.chinamobile.com>
Date: Sun, 3 Nov 2019 21:28:21 +0800
Subject: [PATCH] Update api ref of checkpoint reset

Change-Id: If9dbc815c94f348e31cfa6c9fed303f16a630f64
Story: 2006807
Task: 37357
---
 api-ref/source/v1/karbor-v1-checkpoints.inc   | 45 ++++++++++++++++++-
 api-ref/source/v1/parameters.yaml             | 12 +++++
 .../checkpoint-reset-state-response.json      |  1 +
 3 files changed, 57 insertions(+), 1 deletion(-)
 create mode 100644 api-ref/source/v1/samples/checkpoint-reset-state-response.json

diff --git a/api-ref/source/v1/karbor-v1-checkpoints.inc b/api-ref/source/v1/karbor-v1-checkpoints.inc
index 96d5e30c..9ed5495b 100644
--- a/api-ref/source/v1/karbor-v1-checkpoints.inc
+++ b/api-ref/source/v1/karbor-v1-checkpoints.inc
@@ -205,7 +205,8 @@ Response Codes
 
 .. rest_status_code:: error status.yaml
 
-   - 202
+   - 401
+   - 403
 
 Request
 -------
@@ -226,3 +227,45 @@ Response Example
 
 .. literalinclude:: ./samples/checkpoint-delete-response.json
    :language: javascript
+
+
+Update checkpoint
+=================
+
+.. rest_method::  PUT /v1/{tenant_id}/providers/{provider_id}/checkpoints/{checkpoint_id}
+
+Updates a specific checkpoint.
+
+Response Codes
+--------------
+
+.. rest_status_code:: success status.yaml
+
+   - 200
+
+.. rest_status_code:: error status.yaml
+
+   - 401
+   - 403
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - tenant_id: tenant_id
+   - provider_id: provider_id_1
+   - checkpoint_id: checkpoint_id_1
+   - os-resetState: os-resetState
+   - os-resetState.state: state
+
+Response
+--------
+
+Empty dict
+
+Response Example
+----------------
+
+.. literalinclude:: ./samples/checkpoint-reset-state-response.json
+   :language: javascript
\ No newline at end of file
diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml
index c7eecd47..736b3af8 100644
--- a/api-ref/source/v1/parameters.yaml
+++ b/api-ref/source/v1/parameters.yaml
@@ -255,6 +255,12 @@ operation_type_1:
   in: body
   required: true
   type: UUID
+os-resetState:
+  description: |
+    A ``os-resetState`` object.
+  in: body
+  required: true
+  type: object
 plan:
   description: |
     A ``plan`` object.
@@ -492,6 +498,12 @@ started_at:
   in: body
   required: false
   type: string
+state:
+  description: |
+    The status of checkpoint. A valid value is ``error`` or ``available``.
+  in: body
+  required: true
+  type: string
 tenant_id_1:
   description: |
     The UUID of the tenant in a multi-tenancy cloud.
diff --git a/api-ref/source/v1/samples/checkpoint-reset-state-response.json b/api-ref/source/v1/samples/checkpoint-reset-state-response.json
new file mode 100644
index 00000000..9e26dfee
--- /dev/null
+++ b/api-ref/source/v1/samples/checkpoint-reset-state-response.json
@@ -0,0 +1 @@
+{}
\ No newline at end of file