From 34025f18cf2e94033997d27dfe25eceef4668ed3 Mon Sep 17 00:00:00 2001 From: Gustavo Herzmann Date: Tue, 14 Mar 2023 17:48:30 -0300 Subject: [PATCH] Add upload-only parameter to dcmanager api-ref docs Updates the api-ref parameter list and the request/response examples to include the new upload-only option from the DC patch orchestration strategy. Story: 2010584 Task: 47650 Signed-off-by: Gustavo Herzmann Change-Id: I2bba78d5db1a876df3324a333925a9f75fdd8625 --- api-ref/source/api-ref-dcmanager-v1.rst | 1 + api-ref/source/parameters.yaml | 7 +++++++ .../sw-update-strategy-get-response.json | 4 +++- .../sw-update-strategy-post-request.json | 3 ++- .../sw-update-strategy-post-response.json | 4 +++- 5 files changed, 16 insertions(+), 3 deletions(-) diff --git a/api-ref/source/api-ref-dcmanager-v1.rst b/api-ref/source/api-ref-dcmanager-v1.rst index 810b10168..e023c2c6a 100644 --- a/api-ref/source/api-ref-dcmanager-v1.rst +++ b/api-ref/source/api-ref-dcmanager-v1.rst @@ -1204,6 +1204,7 @@ serviceUnavailable (503) - stop-on-failure: stop_on_failure - subcloud-apply-type: subcloud_apply_type - type: sw_update_strategy_type + - upload-only: patch_strategy_upload_only Request Example ---------------- diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 60dd49f22..0f85214b1 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -304,6 +304,13 @@ openstack_installed: in: body required: true type: boolean +patch_strategy_upload_only: + description: | + Flag to indicate whether patches should only be uploaded to the subclouds + or not. This parameter is only used by 'patch' type strategies. + in: body + required: false + type: boolean region_name: description: | The name provisioned for the subcloud (synonym for subcloud name). diff --git a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-response.json b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-response.json index ea0864ec5..3553c118f 100644 --- a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-response.json +++ b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-get-response.json @@ -5,7 +5,9 @@ "stop-on-failure": true, "max-parallel-subclouds": "2", "subcloud-apply-type": "serial", - "extra-args": null, + "extra-args": { + "upload-only": true + }, "created-at": "2018-02-25T23:23:53.852473", "updated-at": null } diff --git a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-request.json b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-request.json index f35ae5fd1..32572e1ed 100644 --- a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-request.json +++ b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-request.json @@ -2,5 +2,6 @@ "subcloud-apply-type": "serial", "type": "patch", "stop-on-failure": "true", - "max-parallel-subclouds": 2 + "max-parallel-subclouds": 2, + "upload-only": "true" } diff --git a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-response.json b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-response.json index ea0864ec5..3553c118f 100644 --- a/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-response.json +++ b/api-ref/source/samples/sw-update-strategy/sw-update-strategy-post-response.json @@ -5,7 +5,9 @@ "stop-on-failure": true, "max-parallel-subclouds": "2", "subcloud-apply-type": "serial", - "extra-args": null, + "extra-args": { + "upload-only": true + }, "created-at": "2018-02-25T23:23:53.852473", "updated-at": null }