openstack/cinder
Code Issues Proposed changes

Merge "api-ref: fix some inconsistencies in snapshot API"

Browse Source
This commit is contained in:
Zuul 2018-10-19 19:54:31 +00:00 committed by Gerrit Code Review
commit e576261f7e
12 changed files with 81 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api-ref/source/v2/parameters.yaml
View File

@ -868,6 +868,12 @@ links_4:
in: body
required: true
type: array
links_5:
description: |
List of links related to the extension.
in: body
required: true
type: array
location:
description: |
Full URL to a service or server.
@ -1230,7 +1236,7 @@ os-extended-snapshot-attributes:progress:
A percentage value for the build progress.
in: body
required: true
type: integer
type: string
os-extended-snapshot-attributes:project_id:
description: |
The UUID of the owning project.

3
api-ref/source/v2/samples/snapshot-show-response.json
View File

@ -9,6 +9,7 @@
"os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
"name": "snap-001"
"name": "snap-001",
"updated_at": "2013-03-11T07:24:57Z"
}
}

1
api-ref/source/v2/samples/snapshot-update-response.json
View File

@ -6,6 +6,7 @@
"id": "4b502fcb-1f26-45f8-9fe5-3b9a0a52eaf2",
"size": 1,
"status": "available",
"metadata": {},
"volume_id": "2402b902-0b7a-458c-9c07-7435a826f794"
}
}

9
api-ref/source/v2/samples/snapshots-list-detailed-response.json
View File

@ -12,7 +12,14 @@
"created_at": "2015-11-29T02:25:51.000000",
"size": 1,
"id": "b1323cda-8e4b-41c1-afc5-2fc791809c8c",
"description": "volume snapshot"
"description": "volume snapshot",
"updated_at": "2015-12-11T07:24:57Z"
}
],
"snapshots_links": [
{
"href": "https://10.43.176.164:8776/v3/d55fb90e300b436cb2714a17137be023/snapshots?limit=1&marker=2e0cd28e-d7a2-4cdb-87e6-cd37c417c06d",
"rel": "next"
}
]
}

9
api-ref/source/v2/samples/snapshots-list-response.json
View File

@ -10,7 +10,14 @@
"created_at": "2015-11-29T02:25:51.000000",
"size": 1,
"id": "b1323cda-8e4b-41c1-afc5-2fc791809c8c",
"description": "volume snapshot"
"description": "volume snapshot",
"updated_at": "2015-12-11T07:24:57Z"
}
],
"snapshots_links": [
{
"href": "https://10.43.176.164:8776/v3/d55fb90e300b436cb2714a17137be023/snapshots?limit=1&marker=2e0cd28e-d7a2-4cdb-87e6-cd37c417c06d",
"rel": "next"
}
]
}

35
api-ref/source/v2/volumes-v2-snapshots.inc
View File

@ -69,11 +69,13 @@ Response Parameters
- description: description
- created_at: created_at
- name: name
- volume_id: volume_id
- volume_id: volume_id_5
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- id: id_4
- metadata: metadata
- updated_at: updated_at
- snapshots_links: links_5
Response Example
----------------
@ -125,9 +127,9 @@ Response Parameters
- created_at: created_at
- name: name
- snapshot: snapshot
- volume_id: volume_id
- volume_id: volume_id_5
- metadata: metadata
- id: id
- id: id_4
- size: size
@ -169,10 +171,12 @@ Response Parameters
- description: description
- created_at: created_at
- name: name
- volume_id: volume_id
- volume_id: volume_id_5
- metadata: metadata
- id: id
- id: id_4
- size: size
- updated_at: updated_at
- snapshots_links: links_5
Response Example
----------------
@ -210,16 +214,6 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description
- created_at: created_at
- name: name
- snapshot: snapshot
- volume_id: volume_id
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- metadata: metadata
Response Example
@ -346,11 +340,12 @@ Response Parameters
- created_at: created_at
- name: name
- snapshot: snapshot
- volume_id: volume_id
- volume_id: volume_id_5
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- id: id_4
- metadata: metadata
- updated_at: updated_at
Response Example
----------------
@ -404,9 +399,9 @@ Response Parameters
- created_at: created_at
- name: name
- snapshot: snapshot
- volume_id: volume_id
- volume_id: volume_id_5
- metadata: metadata
- id: id
- id: id_4
- size: size
Response Example

8
api-ref/source/v3/parameters.yaml
View File

@ -1555,6 +1555,12 @@ links_6:
in: body
required: true
type: array
links_7:
description: |
Links for the snapshot.
in: body
required: false
type: array
location:
description: |
Full URL to a service or server.
@ -2038,7 +2044,7 @@ os-extended-snapshot-attributes:progress:
A percentage value for the build progress.
in: body
required: true
type: integer
type: string
os-extended-snapshot-attributes:project_id:
description: |
The UUID of the owning project.

3
api-ref/source/v3/samples/snapshot-show-response.json
View File

@ -10,6 +10,7 @@
"os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
"size": 1,
"id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
"name": "snap-001"
"name": "snap-001",
"updated_at": "2013-03-11T07:24:57Z"
}
}

1
api-ref/source/v3/samples/snapshot-update-response.json
View File

@ -6,6 +6,7 @@
"id": "4b502fcb-1f26-45f8-9fe5-3b9a0a52eaf2",
"size": 1,
"status": "available",
"metadata": {},
"user_id": "40c2102f4a554b848d96b14f3eec39ed",
"volume_id": "2402b902-0b7a-458c-9c07-7435a826f794"
}

9
api-ref/source/v3/samples/snapshots-list-detailed-response.json
View File

@ -13,7 +13,14 @@
"created_at": "2015-11-29T02:25:51.000000",
"size": 1,
"id": "b1323cda-8e4b-41c1-afc5-2fc791809c8c",
"description": "volume snapshot"
"description": "volume snapshot",
"updated_at": "2015-12-11T07:24:57Z"
}
],
"snapshots_links": [
{
"href": "https://10.43.176.164:8776/v3/d55fb90e300b436cb2714a17137be023/snapshots?limit=1&marker=2e0cd28e-d7a2-4cdb-87e6-cd37c417c06d",
"rel": "next"
}
],
"count": 10

9
api-ref/source/v3/samples/snapshots-list-response.json
View File

@ -14,7 +14,14 @@
"os-extended-snapshot-attributes:progress": "100%",
"os-extended-snapshot-attributes:project_id": "0892d23df5c5471da88299517a412b90",
"id": "b1323cda-8e4b-41c1-afc5-2fc791809c8c",
"description": "volume snapshot"
"description": "volume snapshot",
"updated_at": "2015-12-11T07:24:57Z"
}
],
"snapshots_links": [
{
"href": "https://10.43.176.164:8776/v3/d55fb90e300b436cb2714a17137be023/snapshots?limit=1&marker=2e0cd28e-d7a2-4cdb-87e6-cd37c417c06d",
"rel": "next"
}
],
"count": 10

33
api-ref/source/v3/volumes-v3-snapshots.inc
View File

@ -80,12 +80,14 @@ Response Parameters
- created_at: created_at
- name: name
- user_id: user_id_2
- volume_id: volume_id
- volume_id: volume_id_5
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- id: id_4
- metadata: metadata
- count: count
- updated_at: updated_at
- snapshots_links: links_7
Response Example
----------------
@ -140,7 +142,7 @@ Response Parameters
- name: name_12
- snapshot: snapshot_1
- user_id: user_id_2
- volume_id: volume_id
- volume_id: volume_id_5
- metadata: metadata
- id: id_4
- size: size
@ -198,11 +200,13 @@ Response Parameters
- created_at: created_at
- name: name
- user_id: user_id_2
- volume_id: volume_id
- volume_id: volume_id_5
- metadata: metadata
- id: id
- id: id_4
- size: size
- count: count
- updated_at: updated_at
- snapshots_links: links_7
Response Example
----------------
@ -240,16 +244,6 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- status: status_2
- os-extended-snapshot-attributes:progress: os-extended-snapshot-attributes:progress
- description: description_8
- created_at: created_at
- name: name
- snapshot: snapshot_1
- volume_id: volume_id
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- metadata: metadata
Response Example
@ -386,11 +380,12 @@ Response Parameters
- name: name
- snapshot: snapshot_1
- user_id: user_id_2
- volume_id: volume_id
- volume_id: volume_id_5
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size
- id: id
- id: id_4
- metadata: metadata
- updated_at: updated_at
Response Example
----------------
@ -443,9 +438,9 @@ Response Parameters
- created_at: created_at
- name: name
- snapshot: snapshot_1
- id: id
- id: id_4
- size: size
- volume_id: volume_id
- volume_id: volume_id_5
- user_id: user_id_2
- metadata: metadata