Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Create open API specification for create/update connector #148691

Merged
merged 8 commits into from
Jan 17, 2023
Merged

[DOCS] Create open API specification for create/update connector #148691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8c8bf00
[DOCS] Add open API specification for create connector
lcawl Jan 10, 2023
9a4064f
[DOCS] Add open API specification for update connector
lcawl Jan 10, 2023
fd9082d
[DOCS] Add stubs for all connector types
lcawl Jan 11, 2023
540e00d
[DOCS] Update connector example fixed
lcawl Jan 11, 2023
c520e5e
[DOCS] Add 4xx responses
lcawl Jan 12, 2023
21e7edd
Merge branch 'main' into create-connector
lcawl Jan 16, 2023
28506e9
Merge branch 'main' into create-connector
lcawl Jan 17, 2023
c58e8e8
Merge branch 'main' into create-connector
lcawl Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,098 changes: 1,065 additions & 33 deletions docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 15 additions & 9 deletions docs/api/actions-and-connectors/create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Creates a connector.

[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>>.
====

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

Expand Down Expand Up @@ -121,9 +127,9 @@ the selected user field is `Email`, the user identifier should be the user's
email address. This property is required when `isOAuth` is `true`.

`usesTableApi`::
(Optional, string) Determines whether the connector uses the Table API or the
(Optional, boolean) Determines whether the connector uses the Table API or the
Import Set API. This property is supported only for {sn-itsm} and {sn-sir}
connectors.
connectors. The default value is `true`.
+
NOTE: If this property is set to false, the Elastic application should be
installed in {sn}.
Expand Down Expand Up @@ -152,7 +158,7 @@ installed in {sn}.
(Optional, object) Mapping for the alert ID.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -167,7 +173,7 @@ installed in {sn}.
(Optional, object) Mapping for the case ID.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -182,7 +188,7 @@ installed in {sn}.
(Optional, object) Mapping for the case name.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -197,7 +203,7 @@ installed in {sn}.
(Optional, object) Mapping for the case comments.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -212,7 +218,7 @@ installed in {sn}.
(Optional, object) Mapping for the case description.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -227,7 +233,7 @@ installed in {sn}.
(Optional, object) Mapping for the name of the alert's rule.

`fieldType`::::
(Required, Object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand All @@ -242,7 +248,7 @@ installed in {sn}.
(Optional, object) Mapping for the severity.

`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.

`id`::::
(Required, string) The id of the field in {swimlane}.
Expand Down
6 changes: 6 additions & 0 deletions docs/api/actions-and-connectors/update.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Updates the attributes for a connector.

[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>>.
====

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

Expand Down
Loading