From cc2962af4acf02a511faf5b8358d7447994ac2a6 Mon Sep 17 00:00:00 2001 From: Alexander Chadin Date: Mon, 13 Aug 2018 16:44:15 +0300 Subject: [PATCH] Add hostname to API Reference This patch set adds hostname attribute to Audit and ActionPlan resources in API Reference. Change-Id: I187d44dc401d3d1770452022b8610570d459cc98 --- api-ref/source/parameters.yaml | 12 ++++++++++++ .../samples/actionplan-list-detailed-response.json | 3 ++- api-ref/source/samples/actionplan-show-response.json | 3 ++- .../source/samples/actionplan-start-response.json | 3 ++- api-ref/source/samples/audit-cancel-response.json | 3 ++- api-ref/source/samples/audit-create-response.json | 3 ++- .../source/samples/audit-list-detailed-response.json | 3 ++- api-ref/source/samples/audit-show-response.json | 3 ++- api-ref/source/samples/audit-update-response.json | 3 ++- api-ref/source/watcher-api-v1-actionplans.inc | 4 ++++ api-ref/source/watcher-api-v1-audits.inc | 5 +++++ 11 files changed, 37 insertions(+), 8 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index c0596b2ec..9448a71b8 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -170,6 +170,12 @@ actionplan_global_efficacy: in: body required: false type: array +actionplan_hostname: + description: | + Hostname the actionplan is running on + in: body + required: false + type: string actionplan_state: description: | State of this action plan. To get more information about states and @@ -191,6 +197,12 @@ audit_goal: in: body required: false type: string +audit_hostname: + description: | + Hostname the audit is running on + in: body + required: false + type: string audit_interval: description: | Time interval between audit's execution. diff --git a/api-ref/source/samples/actionplan-list-detailed-response.json b/api-ref/source/samples/actionplan-list-detailed-response.json index 74fda48e5..cf2dd4e0c 100644 --- a/api-ref/source/samples/actionplan-list-detailed-response.json +++ b/api-ref/source/samples/actionplan-list-detailed-response.json @@ -20,7 +20,8 @@ "deleted_at": null, "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", - "created_at": "2018-04-10T11:59:52.640067+00:00" + "created_at": "2018-04-10T11:59:52.640067+00:00", + "hostname": "controller" } ] } diff --git a/api-ref/source/samples/actionplan-show-response.json b/api-ref/source/samples/actionplan-show-response.json index 3cf57077d..ce8af09fb 100644 --- a/api-ref/source/samples/actionplan-show-response.json +++ b/api-ref/source/samples/actionplan-show-response.json @@ -16,5 +16,6 @@ "updated_at": "2018-04-10T11:59:52.640067+00:00", "strategy_name": "dummy_with_resize", "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", - "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a" + "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", + "hostname": "controller" } \ No newline at end of file diff --git a/api-ref/source/samples/actionplan-start-response.json b/api-ref/source/samples/actionplan-start-response.json index 3261de289..aaf7ea9bc 100644 --- a/api-ref/source/samples/actionplan-start-response.json +++ b/api-ref/source/samples/actionplan-start-response.json @@ -18,5 +18,6 @@ "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", "created_at": "2018-04-10T11:59:12.592729+00:00", - "deleted_at": null + "deleted_at": null, + "hostname": null } \ No newline at end of file diff --git a/api-ref/source/samples/audit-cancel-response.json b/api-ref/source/samples/audit-cancel-response.json index 4fd6f0e10..886109acb 100644 --- a/api-ref/source/samples/audit-cancel-response.json +++ b/api-ref/source/samples/audit-cancel-response.json @@ -47,5 +47,6 @@ ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", - "updated_at": "2018-04-06T11:54:01.266447+00:00" + "updated_at": "2018-04-06T11:54:01.266447+00:00", + "hostname": "controller" } \ No newline at end of file diff --git a/api-ref/source/samples/audit-create-response.json b/api-ref/source/samples/audit-create-response.json index 7c43be508..e4dcccbe4 100644 --- a/api-ref/source/samples/audit-create-response.json +++ b/api-ref/source/samples/audit-create-response.json @@ -47,5 +47,6 @@ ], "strategy_name": "workload_stabilization", "next_run_time": null, - "updated_at": null + "updated_at": null, + "hostname": null } \ No newline at end of file diff --git a/api-ref/source/samples/audit-list-detailed-response.json b/api-ref/source/samples/audit-list-detailed-response.json index 19ee6a2f6..f96da65d1 100644 --- a/api-ref/source/samples/audit-list-detailed-response.json +++ b/api-ref/source/samples/audit-list-detailed-response.json @@ -49,7 +49,8 @@ ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T09:46:00", - "updated_at": "2018-04-06T09:44:01.604146+00:00" + "updated_at": "2018-04-06T09:44:01.604146+00:00", + "hostname": "controller" } ] } \ No newline at end of file diff --git a/api-ref/source/samples/audit-show-response.json b/api-ref/source/samples/audit-show-response.json index ee6305e98..c8ddb28f5 100644 --- a/api-ref/source/samples/audit-show-response.json +++ b/api-ref/source/samples/audit-show-response.json @@ -47,5 +47,6 @@ ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", - "updated_at": "2018-04-06T11:54:01.266447+00:00" + "updated_at": "2018-04-06T11:54:01.266447+00:00", + "hostname": "controller" } \ No newline at end of file diff --git a/api-ref/source/samples/audit-update-response.json b/api-ref/source/samples/audit-update-response.json index 4fd6f0e10..886109acb 100644 --- a/api-ref/source/samples/audit-update-response.json +++ b/api-ref/source/samples/audit-update-response.json @@ -47,5 +47,6 @@ ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", - "updated_at": "2018-04-06T11:54:01.266447+00:00" + "updated_at": "2018-04-06T11:54:01.266447+00:00", + "hostname": "controller" } \ No newline at end of file diff --git a/api-ref/source/watcher-api-v1-actionplans.inc b/api-ref/source/watcher-api-v1-actionplans.inc index 219978e0c..7fa122019 100644 --- a/api-ref/source/watcher-api-v1-actionplans.inc +++ b/api-ref/source/watcher-api-v1-actionplans.inc @@ -50,6 +50,7 @@ version 1: - efficacy_indicators: actionplan_efficacy_indicators - global_efficacy: actionplan_global_efficacy - links: links + - hostname: actionplan_hostname **Example JSON representation of an Action Plan:** @@ -137,6 +138,7 @@ Response - efficacy_indicators: actionplan_efficacy_indicators - global_efficacy: actionplan_global_efficacy - links: links + - hostname: actionplan_hostname **Example JSON representation of an Action Plan:** @@ -174,6 +176,7 @@ Response - efficacy_indicators: actionplan_efficacy_indicators - global_efficacy: actionplan_global_efficacy - links: links + - hostname: actionplan_hostname **Example JSON representation of an Audit:** @@ -229,6 +232,7 @@ version 1: - efficacy_indicators: actionplan_efficacy_indicators - global_efficacy: actionplan_global_efficacy - links: links + - hostname: actionplan_hostname **Example JSON representation of an Action Plan:** diff --git a/api-ref/source/watcher-api-v1-audits.inc b/api-ref/source/watcher-api-v1-audits.inc index f06181d1f..19656cfbd 100644 --- a/api-ref/source/watcher-api-v1-audits.inc +++ b/api-ref/source/watcher-api-v1-audits.inc @@ -83,6 +83,7 @@ version 1: - state: audit_state - scope: audittemplate_scope - links: links + - hostname: audit_hostname **Example JSON representation of an Audit:** @@ -178,6 +179,7 @@ Response - state: audit_state - scope: audittemplate_scope - links: links + - hostname: audit_hostname **Example JSON representation of an Audit:** @@ -221,6 +223,7 @@ Response - state: audit_state - scope: audittemplate_scope - links: links + - hostname: audit_hostname **Example JSON representation of an Audit:** @@ -272,6 +275,7 @@ version 1: - state: audit_state - scope: audittemplate_scope - links: links + - hostname: audit_hostname **Example JSON representation of an Audit:** @@ -323,6 +327,7 @@ Response - state: audit_state - scope: audittemplate_scope - links: links + - hostname: audit_hostname **Example JSON representation of an Audit:**