mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
[DOCS] Add Jira and index connector details to update connector API (#133692)
This commit is contained in:
parent
7206958949
commit
ca6e1ff31a
3 changed files with 37 additions and 15 deletions
|
@ -28,7 +28,7 @@ include::actions-and-connectors/delete.asciidoc[leveloffset=+1]
|
|||
include::actions-and-connectors/get.asciidoc[leveloffset=+1]
|
||||
include::actions-and-connectors/get_all.asciidoc[leveloffset=+1]
|
||||
include::actions-and-connectors/list.asciidoc[]
|
||||
include::actions-and-connectors/update.asciidoc[]
|
||||
include::actions-and-connectors/update.asciidoc[leveloffset=+1]
|
||||
include::actions-and-connectors/execute.asciidoc[]
|
||||
include::actions-and-connectors/legacy/index.asciidoc[]
|
||||
include::actions-and-connectors/legacy/get.asciidoc[]
|
||||
|
|
|
@ -34,6 +34,8 @@ You must have `all` privileges for the *Actions and Connectors* feature in the
|
|||
(Required, object) The configuration for the connector. Configuration properties
|
||||
vary depending on the connector type. For example:
|
||||
+
|
||||
--
|
||||
// tag::connector-config[]
|
||||
.Index connectors
|
||||
[%collapsible%open]
|
||||
====
|
||||
|
@ -51,7 +53,7 @@ request. The default value is `false`.
|
|||
For more information, refer to
|
||||
{kibana-ref}/index-action-type.html[Index connector and action].
|
||||
====
|
||||
+
|
||||
|
||||
.{jira} connectors
|
||||
[%collapsible%open]
|
||||
====
|
||||
|
@ -65,8 +67,10 @@ For more information, refer to
|
|||
For more information, refer to
|
||||
{kibana-ref}/jira-action-type.html[{jira} connector and action].
|
||||
====
|
||||
+
|
||||
|
||||
For more configuration properties, refer to <<action-types>>.
|
||||
// end::connector-config[]
|
||||
--
|
||||
|
||||
`connector_type_id`::
|
||||
(Required, string) The connector type ID for the connector.
|
||||
|
@ -75,7 +79,7 @@ For more configuration properties, refer to <<action-types>>.
|
|||
(Required, string) The display name for the connector.
|
||||
|
||||
`secrets`::
|
||||
(Required, object) The secrets configuration for the connector. Secrets
|
||||
(Required^*^, object) The secrets configuration for the connector. Secrets
|
||||
configuration properties vary depending on the connector type. For information
|
||||
about the secrets configuration properties, refer to <<action-types>>.
|
||||
+
|
||||
|
@ -83,6 +87,8 @@ about the secrets configuration properties, refer to <<action-types>>.
|
|||
WARNING: Remember these values. You must provide them each time you call the <<update-connector-api, update>> API.
|
||||
--
|
||||
+
|
||||
--
|
||||
// tag::connector-secrets[]
|
||||
.{jira} connectors
|
||||
[%collapsible%open]
|
||||
====
|
||||
|
@ -93,6 +99,8 @@ authentication.
|
|||
`email`::
|
||||
(Required, string) The account email for HTTP Basic authentication.
|
||||
====
|
||||
// end::connector-secrets[]
|
||||
--
|
||||
|
||||
[[create-connector-api-request-codes]]
|
||||
=== {api-response-codes-title}
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
[[update-connector-api]]
|
||||
=== Update connector API
|
||||
== Update connector API
|
||||
++++
|
||||
<titleabbrev>Update connector</titleabbrev>
|
||||
++++
|
||||
|
@ -7,14 +7,14 @@
|
|||
Updates the attributes for an existing connector.
|
||||
|
||||
[[update-connector-api-request]]
|
||||
==== Request
|
||||
=== Request
|
||||
|
||||
`PUT <kibana host>:<port>/api/actions/connector/<id>`
|
||||
|
||||
`PUT <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`
|
||||
|
||||
[[update-connector-api-params]]
|
||||
==== Path parameters
|
||||
=== Path parameters
|
||||
|
||||
`id`::
|
||||
(Required, string) The ID of the connector.
|
||||
|
@ -22,26 +22,40 @@ Updates the attributes for an existing connector.
|
|||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[role="child_attributes"]
|
||||
[[update-connector-api-request-body]]
|
||||
==== Request body
|
||||
|
||||
`name`::
|
||||
(Required, string) The new name of the connector.
|
||||
=== Request body
|
||||
|
||||
`config`::
|
||||
(Required, object) The new connector configuration. Configuration properties vary depending on the connector type. For information about the configuration properties, refer to <<action-types,Action and connector types>>.
|
||||
(Required, object) The new connector configuration. Configuration properties
|
||||
vary depending on the connector type. For example:
|
||||
+
|
||||
--
|
||||
include::create.asciidoc[tag=connector-config]
|
||||
--
|
||||
|
||||
`name`::
|
||||
(Required, string) The new name of the connector.
|
||||
|
||||
`secrets`::
|
||||
(Required, object) The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. For information about the secrets configuration properties, refer to <<action-types,Action and connector types>>.
|
||||
(Required^*^, object) The updated secrets configuration for the connector. Secrets
|
||||
properties vary depending on the connector type. For information about the
|
||||
secrets configuration properties, refer to
|
||||
<<action-types,Action and connector types>>.
|
||||
+
|
||||
--
|
||||
include::create.asciidoc[tag=connector-secrets]
|
||||
--
|
||||
|
||||
|
||||
[[update-connector-api-codes]]
|
||||
==== Response code
|
||||
=== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[update-connector-api-example]]
|
||||
==== Example
|
||||
=== Example
|
||||
|
||||
[source,sh]
|
||||
--------------------------------------------------
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue