Jira

2023-07-31T08:18:54.983Z 58af9fc8-f9f3-43ad-9068-a3a4c1ec291a INFO # Jira v1.2.3

Table of Contents

• Context
  • username
  • url
  • userToken
• Actions
  • Find issues
  • Add comment to issue
  • Find one issue
  • Update Issue
  • Create Issue

Contexts

username

url

userToken

Actions

Find issues

Find issues

Inputs

{
  "jql": "project=QA", /*Jira Query language (create your jql on Jira and use the query from url)(required)*/
  "startAt": "number", /*Index to startat*/
  "maxResults": 18, /*How many results you need*/
  "fields": [ /*Specific fields to get*/
    "id, key, summary, ...",
  ]
}

Outputs

Http Code 200

{
    "issues": [
        {
            "link": "string",
            "key": "string",
            "id": "string"
        }
    ]
}

Http Code 422

{
    "message": "string"
}

Http Code 500

{
    "message": "string"
}

Http Code 502

{
    "message": "string"
}

Add comment to issue

Add comment to an existing issue

Inputs

{
  "issueKey": "QA-31", /*Issue key(required)*/
  "comment": "This is a new comment", /*Comment to add*/
}

Outputs

Http Code 200

null

Http Code 422

{
    "message": "string"
}

Http Code 500

{
    "message": "string"
}

Http Code 502

{
    "message": "string"
}

Find one issue

Find one issue

Inputs

{
  "jql": "project=QA", /*Jira Query language (create your jql on Jira and use the query from url)(required)*/
  "fields": [ /*Specific fields to get*/
    "id, key, summary, ...",
  ]
}

Outputs

Http Code 200

{
    "type": "object",
    "description": "Recovered issue",
    "properties": {
        "link": {
            "type": "string",
            "description": "Issue link",
            "required": true
        },
        "key": {
            "type": "string",
            "description": "Issue key",
            "required": true
        },
        "id": {
            "type": "string",
            "description": "Issue ID",
            "required": true
        }
    }
}

Http Code 422

{
    "message": "string"
}

Http Code 500

{
    "message": "string"
}

Http Code 502

{
    "message": "string"
}

Update Issue

Update an issue

Inputs

{
  "issueKey": "QA-31", /*Issue key(required)*/
  "summary": "Add endpoint to update app description", /*Summary of the issue*/
  "description": "string", /*Description of the issue*/
}

Outputs

Http Code 200

{
    "message": "string"
}

Http Code 422

{
    "message": "string"
}

Http Code 500

{
    "message": "string"
}

Http Code 502

{
    "message": "string"
}

Create Issue

Create an issue

Inputs

{
  "projectKey": "MYPROJECT", /*Key of the project(required)*/
  "issueType": "Task", /*Type of the issue(required)*/
  "parentKey": "MYPROJECT-13", /*Key of the parent issue*/
  "summary": "Add endpoint to update app description", /*Summary of the issue(required)*/
  "description": "string", /*Description of the issue*/
}

Outputs

Http Code 200

{
    "link": "string",
    "key": "string",
    "id": "string"
}

Http Code 422

{
    "message": "string"
}

Http Code 500

{
    "message": "string"
}

Http Code 502

{
    "message": "string"
}