Skip to content

Commit

Permalink
[DOCS] Add missing collapsible sections in case APIs (#138588) (#138640)
Browse files Browse the repository at this point in the history
(cherry picked from commit 01f8c7c)

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
kibanamachine and lcawl authored Aug 11, 2022
1 parent 614a5c8 commit 2224a43
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-add-comment.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand Down
14 changes: 8 additions & 6 deletions docs/api/cases/cases-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand All @@ -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`:::
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-set-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand Down
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-update-comment.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand Down
1 change: 1 addition & 0 deletions docs/api/cases/cases-api-update-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand Down
14 changes: 8 additions & 6 deletions docs/api/cases/cases-api-update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand All @@ -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`:::
Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 2224a43

Please sign in to comment.