Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion nimble-storage/nimble-csp-api-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -405,11 +405,23 @@
"schema": {
"type": "string"
}
},
{
"name": "mode",
"in": "query",
"required": false,
"description": "Optional response-behavior selector for the snapshot list. When set to `exists`, the CSP performs a lightweight existence check for snapshots of the given `volume_id` instead of returning the full list, avoiding loading all snapshot metadata into memory (used by the volume-delete precondition check). In this mode the response array contains at most one snapshot — a single element if any snapshot exists, or an empty array if none do. When omitted, the full list of snapshots is returned (default). CSPs that do not implement this optimization ignore the parameter and return the full list, so callers must rely only on whether the array is non-empty.",
"schema": {
"type": "string",
"enum": [
"exists"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"description": "Success. Returns the array of snapshots for the volume. When `mode=exists` is supplied, the array contains at most one element (empty if the volume has no snapshots).",
"content": {
"application/json": {
"schema": {
Expand Down
10 changes: 9 additions & 1 deletion nimble-storage/nimble-csp-api-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,17 @@ paths:
required: false
schema:
type: string
- name: mode
in: query
required: false
description: Optional response-behavior selector for the snapshot list. When set to `exists`, the CSP performs a lightweight existence check for snapshots of the given `volume_id` instead of returning the full list, avoiding loading all snapshot metadata into memory (used by the volume-delete precondition check). In this mode the response array contains at most one snapshot — a single element if any snapshot exists, or an empty array if none do. When omitted, the full list of snapshots is returned (default). CSPs that do not implement this optimization ignore the parameter and return the full list, so callers must rely only on whether the array is non-empty.
schema:
type: string
enum:
- exists
responses:
'200':
description: Success
description: Success. Returns the array of snapshots for the volume. When `mode=exists` is supplied, the array contains at most one element (empty if the volume has no snapshots).
content:
application/json:
schema:
Expand Down
22 changes: 21 additions & 1 deletion openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -254,9 +254,29 @@ paths:
required: false
schema:
type: string
- name: mode
in: query
required: false
description: >-
Optional response-behavior selector for the snapshot list. When set to
`exists`, the CSP performs a lightweight existence check for snapshots of
the given `volume_id` instead of returning the full list, avoiding loading
all snapshot metadata into memory (used by the volume-delete precondition
check). In this mode the response array contains at most one snapshot — a
single element if any snapshot exists, or an empty array if none do. When
omitted, the full list of snapshots is returned (default). CSPs that do not
implement this optimization ignore the parameter and return the full list,
so callers must rely only on whether the array is non-empty.
schema:
type: string
enum:
- exists
responses:
"200":
description: Success
description: >-
Success. Returns the array of snapshots for the volume. When
`mode=exists` is supplied, the array contains at most one element
(empty if the volume has no snapshots).
content:
application/json:
schema:
Expand Down
Loading