Skip to content

Commit

Permalink
[DOCS] Create open API specification for run connector (#149274)
Browse files Browse the repository at this point in the history
(cherry picked from commit f78236a)
  • Loading branch information
lcawl committed Jan 26, 2023
1 parent a37bf49 commit 9145905
Show file tree
Hide file tree
Showing 35 changed files with 3,226 additions and 311 deletions.
510 changes: 493 additions & 17 deletions docs/api-generated/connectors/connector-apis-passthru.asciidoc

Large diffs are not rendered by default.

14 changes: 12 additions & 2 deletions docs/api/actions-and-connectors/execute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Runs a connector by ID.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
====

[[execute-connector-api-request]]
=== {api-request-title}

Expand Down Expand Up @@ -362,7 +368,7 @@ on the `subAction` value. This object is not required when `subAction` is
[%collapsible%open]
======
`comments`:::
(Optional, array of objects) Additional information that is sent to {sn-sir}.
(Optional, array of objects) Additional information that is sent to {sn-itsm}.
+
.Properties of `comments`
[%collapsible%open]
Expand All @@ -381,7 +387,7 @@ version::::
=======
`incident`:::
(Required, object) Information necessary to create or update a {sn-sir} incident.
(Required, object) Information necessary to create or update a {sn-itsm} incident.
+
.Properties of `incident`
[%collapsible%open]
Expand Down Expand Up @@ -520,6 +526,10 @@ to the security incident. The IPs are added as observables to the security incid
updated. Otherwise, a new incident is created.

`malware_hash`::::
(Optional, string or array of strings) A list of malware hashes related to the
security incident. The hashes are added as observables to the security incident.

`malware_url`::::
(Optional, string or array of strings) A list of malware URLs related to the
security incident. The URLs are added as observables to the security incident.

Expand Down
Loading

0 comments on commit 9145905

Please sign in to comment.