From 04ce5179bb15393343ba8474fa3868f465c1370a Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 12 Sep 2018 14:32:16 -0400 Subject: [PATCH] api-ref: document no_snapshots default for volume transfer API This documents the default value (False) for the no_snapshots parameter to the 3.55 volume transfer API and also fixes the no_snapshots value in the API sample to use proper json. Change-Id: I852a04c0b772de64fa82c9c1630dff8ba6454eeb --- api-ref/source/v3/parameters.yaml | 2 +- api-ref/source/v3/samples/volume-transfer-create-request.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 6e65ea1e786..426d168c30b 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -1935,7 +1935,7 @@ new_type: type: string no_snapshots: description: | - Transfer volume without snapshots. + Transfer volume without snapshots. Defaults to False if not specified. in: body required: false min_version: 3.55 diff --git a/api-ref/source/v3/samples/volume-transfer-create-request.json b/api-ref/source/v3/samples/volume-transfer-create-request.json index e7e29450e10..48dc1ce0631 100644 --- a/api-ref/source/v3/samples/volume-transfer-create-request.json +++ b/api-ref/source/v3/samples/volume-transfer-create-request.json @@ -2,6 +2,6 @@ "transfer": { "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37", "name": "first volume", - "no_snapshots": False, + "no_snapshots": false, } }