From 28627a04b273fc4ea03193f0001f2a38b0983db5 Mon Sep 17 00:00:00 2001 From: liyi Date: Wed, 12 Jul 2017 10:32:11 +0800 Subject: [PATCH] Update profile types APIs doc Some examples need update. Change-Id: I21c9b218510e920fd58d4663dba3d3e9f4abf539 --- .../samples/profile-type-ops-response.json | 13 +++++++++++-- .../profile-type-show-response-v1.5.json | 19 ++++++++++--------- .../samples/profile-type-show-response.json | 17 +++++++++-------- .../profile-types-list-response-v1.5.json | 12 ++++++++++++ .../samples/profile-types-list-response.json | 3 +++ 5 files changed, 45 insertions(+), 19 deletions(-) diff --git a/api-ref/source/samples/profile-type-ops-response.json b/api-ref/source/samples/profile-type-ops-response.json index 5afea00c..86846e0e 100644 --- a/api-ref/source/samples/profile-type-ops-response.json +++ b/api-ref/source/samples/profile-type-ops-response.json @@ -1,11 +1,20 @@ { "operations": { "reboot": { - "description": "reboot the specified VM instance", + "description": "Reboot the nova server.", "parameters": { "type": { + "constraints": [ + { + "constraint": [ + "SOFT", + "HARD" + ], + "type": "AllowedValues" + } + ], "default": "SOFT", - "description": "Type of reboot requested", + "description": "Type of reboot which can be 'SOFT' or 'HARD'.", "required": false, "type": "String" } diff --git a/api-ref/source/samples/profile-type-show-response-v1.5.json b/api-ref/source/samples/profile-type-show-response-v1.5.json index 0f9871bc..720b7e62 100644 --- a/api-ref/source/samples/profile-type-show-response-v1.5.json +++ b/api-ref/source/samples/profile-type-show-response-v1.5.json @@ -5,7 +5,6 @@ "context": { "default": {}, "description": "A dictionary for specifying the customized context for stack operations", - "readonly": false, "required": false, "type": "Map", "updatable": false @@ -13,7 +12,6 @@ "disable_rollback": { "default": true, "description": "A boolean specifying whether a stack operation can be rolled back.", - "readonly": false, "required": false, "type": "Boolean", "updatable": true @@ -21,7 +19,6 @@ "environment": { "default": {}, "description": "A map that specifies the environment used for stack operations.", - "readonly": false, "required": false, "type": "Map", "updatable": true @@ -29,7 +26,6 @@ "files": { "default": {}, "description": "Contents of files referenced by the template, if any.", - "readonly": false, "required": false, "type": "Map", "updatable": true @@ -37,26 +33,31 @@ "parameters": { "default": {}, "description": "Parameters to be passed to Heat for stack operations.", - "readonly": false, "required": false, "type": "Map", "updatable": true }, "template": { + "default": {}, "description": "Heat stack template.", - "readonly": false, - "required": true, + "required": false, "type": "Map", "updatable": true }, + "template_url": { + "default": "", + "description": "Heat stack template url.", + "required": false, + "type": "String", + "updatable": true + }, "timeout": { "description": "A integer that specifies the number of minutes that a stack operation times out.", - "readonly": false, "required": false, "type": "Integer", "updatable": true } - } + }, "support_status": { "1.0": [ { diff --git a/api-ref/source/samples/profile-type-show-response.json b/api-ref/source/samples/profile-type-show-response.json index bc238c0f..90d2d514 100644 --- a/api-ref/source/samples/profile-type-show-response.json +++ b/api-ref/source/samples/profile-type-show-response.json @@ -5,7 +5,6 @@ "context": { "default": {}, "description": "A dictionary for specifying the customized context for stack operations", - "readonly": false, "required": false, "type": "Map", "updatable": false @@ -13,7 +12,6 @@ "disable_rollback": { "default": true, "description": "A boolean specifying whether a stack operation can be rolled back.", - "readonly": false, "required": false, "type": "Boolean", "updatable": true @@ -21,7 +19,6 @@ "environment": { "default": {}, "description": "A map that specifies the environment used for stack operations.", - "readonly": false, "required": false, "type": "Map", "updatable": true @@ -29,7 +26,6 @@ "files": { "default": {}, "description": "Contents of files referenced by the template, if any.", - "readonly": false, "required": false, "type": "Map", "updatable": true @@ -37,21 +33,26 @@ "parameters": { "default": {}, "description": "Parameters to be passed to Heat for stack operations.", - "readonly": false, "required": false, "type": "Map", "updatable": true }, "template": { + "default": {}, "description": "Heat stack template.", - "readonly": false, - "required": true, + "required": false, "type": "Map", "updatable": true }, + "template_url": { + "default": "", + "description": "Heat stack template url.", + "required": false, + "type": "String", + "updatable": true + }, "timeout": { "description": "A integer that specifies the number of minutes that a stack operation times out.", - "readonly": false, "required": false, "type": "Integer", "updatable": true diff --git a/api-ref/source/samples/profile-types-list-response-v1.5.json b/api-ref/source/samples/profile-types-list-response-v1.5.json index a58095d4..5d51596f 100644 --- a/api-ref/source/samples/profile-types-list-response-v1.5.json +++ b/api-ref/source/samples/profile-types-list-response-v1.5.json @@ -1,5 +1,17 @@ { "profile_types": [ + { + "name": "container.dockerinc.docker", + "version": "1.0", + "support_status": { + "1.0": [ + { + "status": "EXPERIMENTAL", + "since": "2017.02" + } + ] + } + }, { "name": "os.heat.stack", "version": "1.0", diff --git a/api-ref/source/samples/profile-types-list-response.json b/api-ref/source/samples/profile-types-list-response.json index 53093f40..fcf5cf74 100644 --- a/api-ref/source/samples/profile-types-list-response.json +++ b/api-ref/source/samples/profile-types-list-response.json @@ -1,5 +1,8 @@ { "profile_types": [ + { + "name": "container.dockerinc.docker-1.0" + }, { "name": "os.heat.stack-1.0" },