Skip to content

Commit 14c7978

Browse files
committed
Add docs
1 parent 7d53963 commit 14c7978

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

docs/user/alerting/action-types/jira.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ Priority:: The priority of the incident.
6969
Labels:: The labels of the incident.
7070
Title:: A title for the issue, used for searching the contents of the knowledge base.
7171
Description:: The details about the incident.
72+
Parent:: The parent issue id or key. Only for `Sub-task` issue types.
73+
Priority:: The priority of the incident.
7274
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
7375

7476
[[configuring-jira]]

x-pack/plugins/actions/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -274,12 +274,12 @@ Running the action by scheduling a task means that we will no longer have a user
274274

275275
The following table describes the properties of the `options` object.
276276

277-
| Property | Description | Type |
278-
| -------- | ------------------------------------------------------------------------------------------------------ | ------ |
279-
| id | The id of the action you want to execute. | string |
280-
| params | The `params` value to give the action type executor. | object |
281-
| spaceId | The space id the action is within. | string |
282-
| apiKey | The Elasticsearch API key to use for context. (Note: only required and used when security is enabled). | string |
277+
| Property | Description | Type |
278+
| -------- | ------------------------------------------------------------------------------------------------------ | ---------------- |
279+
| id | The id of the action you want to execute. | string |
280+
| params | The `params` value to give the action type executor. | object |
281+
| spaceId | The space id the action is within. | string |
282+
| apiKey | The Elasticsearch API key to use for context. (Note: only required and used when security is enabled). | string |
283283
| source | The source of the execution, either an HTTP request or a reference to a Saved Object. | object, optional |
284284

285285
## Example
@@ -308,11 +308,11 @@ This api runs the action and asynchronously returns the result of running the ac
308308

309309
The following table describes the properties of the `options` object.
310310

311-
| Property | Description | Type |
312-
| -------- | ------------------------------------------------------------------------------------ | ------ |
313-
| id | The id of the action you want to execute. | string |
314-
| params | The `params` value to give the action type executor. | object |
315-
| source | The source of the execution, either an HTTP request or a reference to a Saved Object.| object, optional |
311+
| Property | Description | Type |
312+
| -------- | ------------------------------------------------------------------------------------- | ---------------- |
313+
| id | The id of the action you want to execute. | string |
314+
| params | The `params` value to give the action type executor. | object |
315+
| source | The source of the execution, either an HTTP request or a reference to a Saved Object. | object, optional |
316316

317317
## Example
318318

@@ -330,7 +330,7 @@ const result = await actionsClient.execute({
330330
},
331331
source: asSavedObjectExecutionSource({
332332
id: '573891ae-8c48-49cb-a197-0cd5ec34a88b',
333-
type: 'alert'
333+
type: 'alert',
334334
}),
335335
});
336336
```
@@ -620,6 +620,7 @@ The Jira action uses the [V2 API](https://developer.atlassian.com/cloud/jira/pla
620620
| issueType | The id of the issue type in Jira. | string _(optional)_ |
621621
| priority | The name of the priority in Jira. Example: `Medium`. | string _(optional)_ |
622622
| labels | An array of labels. | string[] _(optional)_ |
623+
| parent | The parent issue id or key. Only for `Sub-task` issue types. | string _(optional)_ |
623624
| comments | The comments of the case. A comment is of the form `{ commentId: string, version: string, comment: string }` | object[] _(optional)_ |
624625

625626
#### `subActionParams (issueTypes)`

0 commit comments

Comments
 (0)