IntegrationsJiraActions
List Jira issue comments
List comments on a Jira issue with bounded pagination.
comments.list · Jira · v1
Details
Scopes
read:jira-workoffline_access
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
issue_id_or_key | string | Yes | minLength 1; maxLength 64 |
start_at | integer | No | minimum 0; maximum 10000 |
max_results | integer | No | minimum 1; maximum 50 |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
comments | array<object> | Yes | maxItems 50 |
comments[] | object | Yes | additionalProperties false |
comments[].id | string | Yes | minLength 1; maxLength 64 |
comments[].body | object | No | additionalProperties false |
comments[].body.type | string | Yes | enum doc |
comments[].body.version | integer | Yes | minimum 1; maximum 1 |
comments[].body.content | array<object> | Yes | minItems 1; maxItems 32 |
comments[].body.content[] | object | Yes | additionalProperties false |
comments[].body.content[].type | string | Yes | enum paragraph | heading | bulletList | orderedList |
comments[].body.content[].attrs | object | No | additionalProperties false |
comments[].body.content[].attrs.level | integer | No | minimum 1; maximum 6 |
comments[].body.content[].content | array<object> | No | maxItems 64 |
comments[].body.content[].content[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].type | string | Yes | enum text | hardBreak | listItem | paragraph | heading |
comments[].body.content[].content[].text | string | No | minLength 1; maxLength 2000 |
comments[].body.content[].content[].marks | array<object> | No | maxItems 8 |
comments[].body.content[].content[].marks[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
comments[].body.content[].content[].marks[].attrs | object | No | additionalProperties false |
comments[].body.content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
comments[].body.content[].content[].attrs | object | No | additionalProperties false |
comments[].body.content[].content[].attrs.level | integer | No | minimum 1; maximum 6 |
comments[].body.content[].content[].content | array<object> | No | maxItems 64 |
comments[].body.content[].content[].content[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].content[].type | string | Yes | enum text | hardBreak | paragraph | heading |
comments[].body.content[].content[].content[].text | string | No | minLength 1; maxLength 2000 |
comments[].body.content[].content[].content[].marks | array<object> | No | maxItems 8 |
comments[].body.content[].content[].content[].marks[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
comments[].body.content[].content[].content[].marks[].attrs | object | No | additionalProperties false |
comments[].body.content[].content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
comments[].body.content[].content[].content[].attrs | object | No | additionalProperties false |
comments[].body.content[].content[].content[].attrs.level | integer | No | minimum 1; maximum 6 |
comments[].body.content[].content[].content[].content | array<object> | No | maxItems 64 |
comments[].body.content[].content[].content[].content[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].content[].content[].type | string | Yes | enum text | hardBreak |
comments[].body.content[].content[].content[].content[].text | string | No | minLength 1; maxLength 2000 |
comments[].body.content[].content[].content[].content[].marks | array<object> | No | maxItems 8 |
comments[].body.content[].content[].content[].content[].marks[] | object | Yes | additionalProperties false |
comments[].body.content[].content[].content[].content[].marks[].type | string | Yes | enum strong | em | code | underline | strike | link |
comments[].body.content[].content[].content[].content[].marks[].attrs | object | No | additionalProperties false |
comments[].body.content[].content[].content[].content[].marks[].attrs.href | string | No | minLength 8; maxLength 2048; pattern ^https://; format uri |
comments[].author | object | No | additionalProperties false |
comments[].author.account_id | string | No | minLength 1; maxLength 128 |
comments[].author.display_name | string | No | maxLength 255 |
comments[].author.active | boolean | No | — |
comments[].created | string | No | maxLength 64 |
comments[].updated | string | No | maxLength 64 |
start_at | integer | No | minimum 0; maximum 10000 |
max_results | integer | No | minimum 1; maximum 50 |
total | integer | No | minimum 0 |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"issue_id_or_key": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"start_at": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"max_results": {
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"issue_id_or_key"
]
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"comments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"body": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"doc"
]
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"paragraph",
"heading",
"bulletList",
"orderedList"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak",
"listItem",
"paragraph",
"heading"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak",
"paragraph",
"heading"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"maximum": 6
}
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"hardBreak"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"marks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"strong",
"em",
"code",
"underline",
"strike",
"link"
]
},
"attrs": {
"type": "object",
"additionalProperties": false,
"properties": {
"href": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https://",
"format": "uri"
}
}
}
},
"required": [
"type"
]
},
"maxItems": 8
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"maxItems": 64
}
},
"required": [
"type"
]
},
"minItems": 1,
"maxItems": 32
}
},
"required": [
"type",
"version",
"content"
]
},
"author": {
"type": "object",
"additionalProperties": false,
"properties": {
"account_id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"display_name": {
"type": "string",
"maxLength": 255
},
"active": {
"type": "boolean"
}
}
},
"created": {
"type": "string",
"maxLength": 64
},
"updated": {
"type": "string",
"maxLength": 64
}
},
"required": [
"id"
]
},
"maxItems": 50
},
"start_at": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"max_results": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"comments"
]
}