Browse Source

Update api ref of checkpoint reset

Change-Id: If9dbc815c94f348e31cfa6c9fed303f16a630f64
Story: 2006807
Task: 37357
changes/51/692751/4
jiaopengju 1 year ago
parent
commit
2aac31c11f
3 changed files with 57 additions and 1 deletions
  1. +44
    -1
      api-ref/source/v1/karbor-v1-checkpoints.inc
  2. +12
    -0
      api-ref/source/v1/parameters.yaml
  3. +1
    -0
      api-ref/source/v1/samples/checkpoint-reset-state-response.json

+ 44
- 1
api-ref/source/v1/karbor-v1-checkpoints.inc View File

@ -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

+ 12
- 0
api-ref/source/v1/parameters.yaml View File

@ -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.


+ 1
- 0
api-ref/source/v1/samples/checkpoint-reset-state-response.json View File

@ -0,0 +1 @@
{}

Loading…
Cancel
Save