From 2224a437af8ae5ae179d748205d26660303c27a4 Mon Sep 17 00:00:00 2001 From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Date: Thu, 11 Aug 2022 12:27:29 -0400 Subject: [PATCH] [DOCS] Add missing collapsible sections in case APIs (#138588) (#138640) (cherry picked from commit 01f8c7c4f2df0ddbcc9d0be2fe34eceb4d5dd059) Co-authored-by: Lisa Cawley --- docs/api/cases/cases-api-add-comment.asciidoc | 1 + docs/api/cases/cases-api-create.asciidoc | 14 ++++++++------ .../api/cases/cases-api-set-configuration.asciidoc | 1 + docs/api/cases/cases-api-update-comment.asciidoc | 1 + .../cases/cases-api-update-configuration.asciidoc | 1 + docs/api/cases/cases-api-update.asciidoc | 14 ++++++++------ 6 files changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/api/cases/cases-api-add-comment.asciidoc b/docs/api/cases/cases-api-add-comment.asciidoc index 69f886e3a5c9a..618f4a5de8842 100644 --- a/docs/api/cases/cases-api-add-comment.asciidoc +++ b/docs/api/cases/cases-api-add-comment.asciidoc @@ -29,6 +29,7 @@ You must have `all` privileges for the *Cases* feature in the *Management*, (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === {api-request-body-title} `alertId`:: diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc index 402521a4c31e7..b499e8436aa54 100644 --- a/docs/api/cases/cases-api-create.asciidoc +++ b/docs/api/cases/cases-api-create.asciidoc @@ -25,6 +25,7 @@ You must have `all` privileges for the *Cases* feature in the *Management*, (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === {api-request-body-title} `connector`:: @@ -34,12 +35,13 @@ default space is used. [%collapsible%open] ==== `fields`:: -(Required, object) An object containing the connector fields. +(Required, object) An object containing the connector fields. To create a case +without a connector, specify `null`. If you want to omit any individual field, +specify `null` as its value. + --- -To create a case without a connector, specify `null`. If you want to omit any -individual field, specify `null` as its value. - +.Properties of `fields` +[%collapsible%open] +===== For {ibm-r} connectors, specify: `issueTypes`::: @@ -103,7 +105,7 @@ For {swimlane} connectors, specify: `caseId`::: (Required, string) The case ID. --- +===== `id`:: (Required, string) The identifier for the connector. To create a case without a diff --git a/docs/api/cases/cases-api-set-configuration.asciidoc b/docs/api/cases/cases-api-set-configuration.asciidoc index 89ec6f0600717..2deaaf7fdff09 100644 --- a/docs/api/cases/cases-api-set-configuration.asciidoc +++ b/docs/api/cases/cases-api-set-configuration.asciidoc @@ -35,6 +35,7 @@ you must still specify all of the connector details. (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === {api-request-body-title} `closure_type`:: diff --git a/docs/api/cases/cases-api-update-comment.asciidoc b/docs/api/cases/cases-api-update-comment.asciidoc index b749d50a15c86..127d434602f84 100644 --- a/docs/api/cases/cases-api-update-comment.asciidoc +++ b/docs/api/cases/cases-api-update-comment.asciidoc @@ -29,6 +29,7 @@ The identifier for the case. To retrieve case IDs, use (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === {api-request-body-title} `alertId`:: diff --git a/docs/api/cases/cases-api-update-configuration.asciidoc b/docs/api/cases/cases-api-update-configuration.asciidoc index c1dcb2a71e57c..4bdaacf1f2355 100644 --- a/docs/api/cases/cases-api-update-configuration.asciidoc +++ b/docs/api/cases/cases-api-update-configuration.asciidoc @@ -35,6 +35,7 @@ The identifier for the configuration. To retrieve the configuration IDs, use (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === Request body `closure_type`:: diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc index 687622cce8ddd..53703908dde47 100644 --- a/docs/api/cases/cases-api-update.asciidoc +++ b/docs/api/cases/cases-api-update.asciidoc @@ -25,6 +25,7 @@ You must have `all` privileges for the *Cases* feature in the *Management*, (Optional, string) An identifier for the space. If it is not specified, the default space is used. +[role="child_attributes"] === {api-request-body-title} `cases`:: @@ -40,12 +41,13 @@ default space is used. [%collapsible%open] ===== `fields`:: -(Required, object) An object containing the connector fields. +(Required, object) An object containing the connector fields. To remove the +connector, specify `null`. If you want to omit any individual field, specify +`null` as its value. + --- -To remove the connector, specify `null`. If you want to omit any individual -field, specify `null` as its value. - +.Properties of `fields` +[%collapsible%open] +======= For {ibm-r} connectors, specify: `issueTypes`::: @@ -110,7 +112,7 @@ For {swimlane} connectors, specify: `caseId`::: (Required, string) The identifier for the case. --- +======= `id`:: (Required, string) The identifier for the connector. To remove the connector,