Expand description
Free-tier Jira platform REST only (no Marketplace apps).
Endpoint map (official Cloud + Server/DC docs):
| Op | Endpoint | Notes |
|---|---|---|
| Probe | GET /rest/api/2/myself (+ serverInfo) | Cloud Free email+API token or Server PAT |
| Search | GET /rest/api/2/search?jql=&fields=summary | Free JQL; Server also allows POST search |
| Comments GET | GET /rest/api/2/issue/{key}/comment | Wiki string or Cloud ADF body |
| Comment POST | Server: POST /rest/api/2/.../comment wiki Β· Cloud: POST /rest/api/3/.../comment ADF | No paid formatters |
Import writes drafts under corpus/imports/ only. Write is explicit one-shot
comment post (review-before-migrate), not bulk library sync.
StructsΒ§
- Comment
Create πResponse - Comments
Response π - Issue
Comment - One comment on a Jira issue, with its body still in Jira wiki markup.
- Issue
Summary - One issue found by a JQL search: key plus its summary.
- Jira
Config - Jira instance connection details.
- Jira
Probe - Result of a free-tier connectivity probe (
/myself+ optional serverInfo). - Myself
Response π - Posted
Comment - One comment created via free REST POST.
- RawComment π
- RawUser π
- Search
Fields π - Search
Issue π - Search
Response π - Server
Info πResponse
EnumsΒ§
- Comment
Body Format - How to encode free write comment bodies for platform REST.
- Jira
Auth - How to authenticate against the Jira REST API.
FunctionsΒ§
- adf_
to_ πplain_ text - adf_
walk π - apply_
auth π - build_
comment_ πpost_ request - build_
comments_ πrequest_ at - build_
myself_ πrequest - build_
search_ πrequest_ at - build_
server_ πinfo_ request - comment_
body_ to_ text - Flatten free-platform comment bodies: wiki strings stay as-is; Cloud ADF (Atlassian Document Format) is reduced to plain text without Marketplace apps.
- comment_
post_ πpayload - comment_
post_ πurl - Free platform comment endpoints (official Cloud/Server REST β no Marketplace).
- default_
import_ dir - Where imported drafts land by default (never auto-indexed or quality-checked).
- draft_
markdown - Render one issueβs comments as a review draft: front matter plus one
section per comment.
idmust already carry thesnell-prefix. - fetch_
comments - Fetch all comments for one issue (api/2, then api/3 on Cloud-style hosts).
- format_
probe - Format a probe result for CLI stdout.
- http_
client π - import_
jira - Import issues matching
jqlintoout_diras review drafts (nevercorpus/responses/). Returns the paths written, or, whendry_runis set, the paths that would be written without touching the filesystem or fetching comments. - is_
cloud_ host - True when the base URL looks like Jira Cloud Free/Standard host.
- parse_
comment_ πcreate_ response - parse_
comments_ πresponse - parse_
myself_ πresponse - parse_
search_ πresponse - parse_
server_ πinfo_ response - plain_
text_ to_ adf - Build minimal free ADF document from plain/wiki text (Cloud comment write path).
- post_
comment_ from_ markdown - Convert a markdown corpus file with pandoc jira writer, then POST as a comment.
- post_
comment_ from_ markdown_ with_ format - Like
post_comment_from_markdownwith an explicit free-tier body format. - post_
issue_ comment - POST a comment via free platform REST (wiki on Server/DC, ADF on Cloud Free).
- post_
issue_ comment_ with_ format - Like
post_issue_commentwith an explicit body format. - probe_
jira - Probe free Jira REST: authenticated identity + optional server banner.
- search_
all_ issues - Search for issues matching
jql, paginating until Jira reports no more. - search_
page π - Execute one free-tier search page, trying platform URL candidates on failure.
- search_
url_ πcandidates - Free search URL candidates (Server v2 first; Cloud Free may prefer v3).
- slugify
- Turn a title into a slug: lowercase ASCII alphanumerics, everything else
collapsed to a single
-, with no leading, trailing, or repeated dash.