Skip to content

Commit

Permalink
Merge pull request #1428 from SEKOIA-IO/update-automation-library-doc…
Browse files Browse the repository at this point in the history
…umentation

Refresh automation library documentation
  • Loading branch information
squioc authored Nov 10, 2023
2 parents 91d2e57 + 4b38bf0 commit d9a52bf
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
67 changes: 67 additions & 0 deletions _shared_content/automate/library/atlassian-jira.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Atlassian JIRA

![Atlassian JIRA](/assets/playbooks/library/atlassian-jira.png){ align=right width=150 }

Integrates with JIRA

## Configuration

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `domain` | `string` | Your organization JIRA domain (e.g. 'sandbox.atlassian.net') |
| `email` | `string` | Email of the user |
| `api_key` | `string` | API Key to use to connect to JIRA API endpoints |

## Actions

### Change Status of an Issue

Change status of an issue in JIRA

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `issue_key` | `string` | Issue key (e.g. PROJ-1) |
| `status_name` | `string` | Exact name of the status (e.g. 'To Do') |

### Comment Issue

Add comment to an issue in JIRA

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `issue_key` | `string` | Issue key (e.g. PROJ-1) |
| `comment` | `string` | Text of a comment |

### Create Issue

Create issue in JIRA

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `project_key` | `string` | Project key (e.g. 'PRJ') |
| `summary` | `string` | Summary of an issue (e.g. 'Fix a bug') |
| `issue_type` | `string` | Issue type (e.g. 'Task') |
| `due_date` | `string` | Due date (e.g. '2023-10-31')' |
| `labels` | `string` | Comma-separated labels (e.g. 'devops,support') |
| `assignee` | `string` | Exact display name of an assignee (e.g. John Doe) |
| `reporter` | `string` | Exact display name of a reporter (e.g. Jane Doe) |
| `priority` | `string` | Issue priority (e.g. Highest) |
| `parent_key` | `string` | Key of a parent issue (e.g. PRJ-1) |


**Outputs**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `issue_key` | `string` | Key of the created issue |


## Extra

Module **`Atlassian JIRA` v1.0.4**
Binary file added docs/assets/playbooks/library/atlassian-jira.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ nav:
- Actions: xdr/features/automate/actions.md
- Actions Library:
- AWS: xdr/features/automate/library/aws.md
- Atlassian JIRA: xdr/features/automate/library/atlassian-jira.md
- Azure Active Directory: xdr/features/automate/library/azure-active-directory.md
- BinaryEdge's API: xdr/features/automate/library/binaryedge-s-api.md
- Censys: xdr/features/automate/library/censys.md
Expand Down Expand Up @@ -424,6 +425,7 @@ nav:
- Actions: tip/features/automate/actions.md
- Actions Library:
- AWS: tip/features/automate/library/aws.md
- Atlassian JIRA: tip/features/automate/library/atlassian-jira.md
- Azure Active Directory: tip/features/automate/library/azure-active-directory.md
- BinaryEdge's API: tip/features/automate/library/binaryedge-s-api.md
- Censys: tip/features/automate/library/censys.md
Expand Down

0 comments on commit d9a52bf

Please sign in to comment.