User Guide

Synapse-Jira User Guide

Synapse-Jira adds new Storm commands to allow you to query the Jira API using your existing API key.

Getting Started

Check with your Admin to enable permissions and find out if you need a personal API key, domain, and/or username.

Examples

Setting your personal API key

To set-up a personal use API key:

> jira.setup.apikey --self myapikey
Setting Synapse-Jira API key for the current user.

Setting your personal API domain

To set-up a personal use API domain:

> jira.setup.domain --self mydomain.atlassian.net
Setting Synapse-Jira API domain for the current user.

Setting your personal API username

To set-up a personal use API username:

> jira.setup.username --self [email protected]
Setting Synapse-Jira API username for the current user.

Display the list of Jira users

> jira.users
1. John Doe
2. Bill Madison
3. Ronald Donald
4. Foo Bar
5. John Wick

Search for issues in project “MDR” and create nodes from the results

> jira.issue.search 'project = "MDR"' --yield
WARNING: The property proj:ticket:ext:id is deprecated or using a deprecated type and will be removed in 3.0.0
proj:ticket=ce4c4eff4b5b2405634254a8d8cd645d
        .created = 2024/12/20 18:04:54.130
        :created = 2021/06/16 14:00:27.777
        :creator = 5a7ed0b4045f10ad16db3372d9e346ee
        :ext:id = MDR-12
        :ext:url = https://vertexproject.atlassian.net/rest/api/3/issue/15979
        :name = As: User Want: Vroom Vroom So: Analysis
        :priority = none
        :project = a9c82c18fd00b6f5cd13ce897171f49c
        :status = new
        :type = bug
        :updated = 2021/06/16 14:00:27.777
proj:ticket=e8bfc7034258364901a6f43ac139f56e
        .created = 2024/12/20 18:04:54.225
        :created = 2021/06/15 20:06:56.239
        :creator = 5a7ed0b4045f10ad16db3372d9e346ee
        :desc = More priority levels.
        :ext:id = MDR-11
        :ext:url = https://vertexproject.atlassian.net/rest/api/3/issue/15966
        :name = as: cisphyx w: highest priority issue s: test more priority levels
        :priority = highest
        :project = a9c82c18fd00b6f5cd13ce897171f49c
        :status = new
        :type = new feature
        :updated = 2021/06/15 20:06:56.239

Search for issues in project “MDR” with priority “Highest” and display the results

> jira.issue.search 'project = "MDR" and priority="Highest"' --dry-run
Total matching issues: 1

id: MDR-11
url: https://vertexproject.atlassian.net/rest/api/3/issue/15966
name: as: cisphyx w: highest priority issue s: test more priority levels
desc: More priority levels.
type: New Feature
status: new
priority: Highest
reporter: 5dc9a9d1a4a2d70dbffece84
created: 2021-06-15T16:06:56.239-0400
updated: 2021-06-15T16:06:56.239-0400

Create an issue of type “Bug” in the project “MDR”

> jira.issue.create MDR Bug "As: User Want: Vroom Vroom So: Analysis"
Made MDR-8

Use of meta:source nodes

Synapse-Jira uses a meta:source node and -(seen)> light weight edges to track nodes observed from the Jira API.

> meta:source=234bc70639056c7f8400c2429fcb70ea
meta:source=234bc70639056c7f8400c2429fcb70ea
        .created = 2024/12/20 18:04:54.109
        :name = jira api

Storm can be used to filter nodes to include/exclude nodes which have been observed by Synapse-Jira. The following example shows how to filter the results of a query to include only results observed by Synapse-Jira:

> proj:project +{ <(seen)- meta:source=234bc70639056c7f8400c2429fcb70ea }
proj:project=a9c82c18fd00b6f5cd13ce897171f49c
        .created = 2024/12/20 18:04:54.157
        :name = mdr