mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
[DOCS] Add jira connector details to run connector API (#134622)
This commit is contained in:
parent
9d435e23c6
commit
74df8c1736
1 changed files with 128 additions and 2 deletions
|
@ -50,6 +50,104 @@ depending on the connector type. For information about the parameter properties,
|
||||||
refer to <<action-types>>.
|
refer to <<action-types>>.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
.Jira connectors
|
||||||
|
[%collapsible%open]
|
||||||
|
====
|
||||||
|
`subAction`::
|
||||||
|
(Required, string) The action to test. Valid values include: `fieldsByIssueType`,
|
||||||
|
`getFields`, `getIncident`, `issue`, `issues`, `issueTypes`, and `pushToService`.
|
||||||
|
|
||||||
|
`subActionParams`::
|
||||||
|
(Required^*^, object) The set of configuration properties, which vary depending
|
||||||
|
on the `subAction` value. This object is not required when `subAction` is
|
||||||
|
`getFields` or `issueTypes`.
|
||||||
|
+
|
||||||
|
.Properties when `subAction` is `fieldsByIssueType`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
`id`:::
|
||||||
|
(Required, string) The Jira issue type identifier. For example, `10024`.
|
||||||
|
=====
|
||||||
|
+
|
||||||
|
.Properties when `subAction` is `getIncident`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
`externalId`:::
|
||||||
|
(Required, string) The Jira issue identifier. For example, `71778`.
|
||||||
|
=====
|
||||||
|
+
|
||||||
|
.Properties when `subAction` is `issue`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
`id`:::
|
||||||
|
(Required, string) The Jira issue identifier. For example, `71778`.
|
||||||
|
=====
|
||||||
|
+
|
||||||
|
.Properties when `subAction` is `issues`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
`title`:::
|
||||||
|
(Required, string) The title of the Jira issue.
|
||||||
|
=====
|
||||||
|
+
|
||||||
|
.Properties when `subAction` is `pushToService`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
comments:::
|
||||||
|
(Optional, array of objects) Additional information that is sent to Jira.
|
||||||
|
+
|
||||||
|
.Properties of `comments`
|
||||||
|
[%collapsible%open]
|
||||||
|
======
|
||||||
|
comment::::
|
||||||
|
(string) A comment related to the incident. For example, describe how to
|
||||||
|
troubleshoot the issue.
|
||||||
|
|
||||||
|
commentId::::
|
||||||
|
(integer) A unique identifier for the comment.
|
||||||
|
======
|
||||||
|
|
||||||
|
incident:::
|
||||||
|
(Required, object) Information necessary to create or update a Jira incident.
|
||||||
|
+
|
||||||
|
.Properties of `incident`
|
||||||
|
[%collapsible%open]
|
||||||
|
======
|
||||||
|
`description`::::
|
||||||
|
(Optional, string) The details about the incident.
|
||||||
|
|
||||||
|
`externalId`::::
|
||||||
|
(Optional, string) The Jira issue identifier. If present, the incident is
|
||||||
|
updated. Otherwise, a new incident is created.
|
||||||
|
|
||||||
|
`labels`::::
|
||||||
|
(Optional, array of strings) The labels for the incident. For example,
|
||||||
|
`["LABEL1"]`. NOTE: Labels cannot contain spaces.
|
||||||
|
|
||||||
|
`issueType`::::
|
||||||
|
(Optional, integer) The type of incident. For example, `10006`. To obtain the
|
||||||
|
list of valid values, set `subAction` to `issueTypes`.
|
||||||
|
|
||||||
|
`parent`::::
|
||||||
|
(Optional, string) The ID or key of the parent issue. Applies only to `Sub-task`
|
||||||
|
types of issues.
|
||||||
|
|
||||||
|
`priority`::::
|
||||||
|
(Optional, string) The incident priority level. For example, `Lowest`.
|
||||||
|
|
||||||
|
`summary`::::
|
||||||
|
(Required, string) A summary of the incident.
|
||||||
|
|
||||||
|
`title`::::
|
||||||
|
(Optional, string) A title for the incident, used for searching the contents of
|
||||||
|
the knowledge base.
|
||||||
|
======
|
||||||
|
=====
|
||||||
|
|
||||||
|
For more information, refer to
|
||||||
|
{kibana-ref}/jira-action-type.html[{jira} connector and action].
|
||||||
|
====
|
||||||
|
|
||||||
.Server log connectors
|
.Server log connectors
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
|
@ -102,7 +200,7 @@ The API returns the following:
|
||||||
"items": [
|
"items": [
|
||||||
{
|
{
|
||||||
"index": {
|
"index": {
|
||||||
"_index": "updated-index",
|
"_index": "test-index",
|
||||||
"_id": "iKyijHcBKCsmXNFrQe3T",
|
"_id": "iKyijHcBKCsmXNFrQe3T",
|
||||||
"_version": 1,
|
"_version": 1,
|
||||||
"result": "created",
|
"result": "created",
|
||||||
|
@ -111,7 +209,7 @@ The API returns the following:
|
||||||
"successful": 1,
|
"successful": 1,
|
||||||
"failed": 0
|
"failed": 0
|
||||||
},
|
},
|
||||||
"_seq_no": 7,
|
"_seq_no": 0,
|
||||||
"_primary_term": 1,
|
"_primary_term": 1,
|
||||||
"status": 201
|
"status": 201
|
||||||
}
|
}
|
||||||
|
@ -141,4 +239,32 @@ The API returns the following:
|
||||||
[source,sh]
|
[source,sh]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
{"status":"ok","connector_id":"7fc7b9a0-ecc9-11ec-8736-e7d63118c907"}
|
{"status":"ok","connector_id":"7fc7b9a0-ecc9-11ec-8736-e7d63118c907"}
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
Retrieve the list of issue types for a Jira connector:
|
||||||
|
|
||||||
|
[source,sh]
|
||||||
|
--------------------------------------------------
|
||||||
|
POST api/actions/connector/b3aad810-edbe-11ec-82d1-11348ecbf4a6/_execute
|
||||||
|
{
|
||||||
|
"params": {
|
||||||
|
"subAction": "issueTypes"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
--------------------------------------------------
|
||||||
|
// KIBANA
|
||||||
|
|
||||||
|
The API returns the following:
|
||||||
|
|
||||||
|
[source,sh]
|
||||||
|
--------------------------------------------------
|
||||||
|
{
|
||||||
|
"status":"ok",
|
||||||
|
"data":[
|
||||||
|
{"id":"10024","name":"Improvement"},{"id":"10006","name":"Task"},
|
||||||
|
{"id":"10007","name":"Sub-task"},{"id":"10025","name":"New Feature"},
|
||||||
|
{"id":"10023","name":"Bug"},{"id":"10000","name":"Epic"}
|
||||||
|
],
|
||||||
|
"connector_id":"b3aad810-edbe-11ec-82d1-11348ecbf4a6"
|
||||||
|
}
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
Loading…
Add table
Add a link
Reference in a new issue