Atlassian Document Format (ADF) helpers.
Jira Cloud v3 takes and returns rich text as ADF — a nested JSON document tree, not a string. Two directions live here:
adf->text : best-effort flatten an ADF value to compact plain text for
reading (lossy: tables/media/mentions collapse to text).doc / text->adf / paragraph : build minimal valid ADF documents for
write paths (create issue description, add comment, etc.).Full-fidelity ADF is always reachable by passing your own document map to the endpoint functions; these helpers just cover the common cases.
Atlassian Document Format (ADF) helpers.
Jira Cloud v3 takes and returns rich text as ADF — a nested JSON document
tree, not a string. Two directions live here:
- `adf->text` : best-effort flatten an ADF value to compact plain text for
reading (lossy: tables/media/mentions collapse to text).
- `doc` / `text->adf` / `paragraph` : build minimal valid ADF documents for
write paths (create issue description, add comment, etc.).
Full-fidelity ADF is always reachable by passing your own document map to the
endpoint functions; these helpers just cover the common cases.Jira Cloud Issue Attachments API endpoints.
All fns take a client (built with atlassian.jira.client/client) as their
first argument. Path params follow as positional args. Query params and
request body are passed via an optional trailing opts map.
Jira Cloud Issue Attachments API endpoints. All fns take a `client` (built with `atlassian.jira.client/client`) as their first argument. Path params follow as positional args. Query params and request body are passed via an optional trailing `opts` map.
Jira Cloud bulk issue operations.
All functions delegate to atlassian.jira.client/request. Build a client
with (atlassian.jira.client/client) and pass it as the first argument.
Write operations accept a body map and an optional opts map for query
params. Read operations accept an optional opts map.
Jira Cloud bulk issue operations. All functions delegate to `atlassian.jira.client/request`. Build a client with `(atlassian.jira.client/client)` and pass it as the first argument. Write operations accept a `body` map and an optional `opts` map for query params. Read operations accept an optional `opts` map.
Jira client handle + the request seam every atlassian.jira.* endpoint
namespace is built on.
A Jira client is an atlassian.client handle whose :config is a Jira config
map (see atlassian.config/jira-config). Build one from the environment with
(client), or pass an explicit config to (client cfg).
Endpoint namespaces never build URLs themselves — they call request with a
path RELATIVE to the API root and an optional :api selecting which Jira REST
surface to hit:
(require '[atlassian.jira.client :as jira]) (def c (jira/client)) (jira/request c {:method :get :path "/issue/ABC-123" :query {:fields "summary,status"}})
;; agile board endpoint: (jira/request c {:api :agile :method :get :path "/board"})
:api is one of :platform (default, /rest/api/3), :agile (/rest/agile/1.0),
or :software (/rest/software/1.0).
Jira client handle + the `request` seam every atlassian.jira.* endpoint
namespace is built on.
A Jira client is an `atlassian.client` handle whose `:config` is a Jira config
map (see `atlassian.config/jira-config`). Build one from the environment with
`(client)`, or pass an explicit config to `(client cfg)`.
Endpoint namespaces never build URLs themselves — they call `request` with a
path RELATIVE to the API root and an optional `:api` selecting which Jira REST
surface to hit:
(require '[atlassian.jira.client :as jira])
(def c (jira/client))
(jira/request c {:method :get :path "/issue/ABC-123"
:query {:fields "summary,status"}})
;; agile board endpoint:
(jira/request c {:api :agile :method :get :path "/board"})
`:api` is one of :platform (default, /rest/api/3), :agile (/rest/agile/1.0),
or :software (/rest/software/1.0).Jira Cloud issue comments and comment properties.
Covers two tag groups from the Jira Platform v3 REST API:
Comment bodies are Atlassian Document Format (ADF). Use
atlassian.jira.adf/text->adf to build a valid body from plain text.
Jira Cloud issue comments and comment properties.
Covers two tag groups from the Jira Platform v3 REST API:
- Issue comments (/rest/api/3/issue/{issueIdOrKey}/comment, /rest/api/3/comment/list)
- Issue comment properties (/rest/api/3/comment/{commentId}/properties/...)
Comment bodies are Atlassian Document Format (ADF). Use
`atlassian.jira.adf/text->adf` to build a valid body from plain text.Jira Cloud Dashboard endpoints.
All functions take a client (built via atlassian.jira.client/client) as
their first arg and delegate to atlassian.jira.client/request.
Jira Cloud Dashboard endpoints. All functions take a client (built via `atlassian.jira.client/client`) as their first arg and delegate to `atlassian.jira.client/request`.
Jira field configuration and field scheme endpoints.
Covers two API surface areas:
All issue-field-configuration ops are marked DEPRECATED by Atlassian; they still work and are included in full.
Jira field configuration and field scheme endpoints.
Covers two API surface areas:
- Field schemes (/rest/api/3/config/fieldschemes/*)
- Issue field configs (/rest/api/3/fieldconfiguration* and
/rest/api/3/fieldconfigurationscheme*)
All issue-field-configuration ops are marked DEPRECATED by Atlassian; they
still work and are included in full.Jira Cloud REST API — Issue fields, custom field contexts, and custom field options endpoint functions.
Every function delegates to atlassian.jira.client/request. Build a client
with (atlassian.jira.client/client) and pass it as the first argument.
Jira Cloud REST API — Issue fields, custom field contexts, and custom field options endpoint functions. Every function delegates to `atlassian.jira.client/request`. Build a client with `(atlassian.jira.client/client)` and pass it as the first argument.
Jira Cloud Filters + Filter Sharing API.
One public function per operation in /rest/api/3/filter. Build a client with
atlassian.jira.client/client, then call any function here with it as the
first argument.
Jira Cloud Filters + Filter Sharing API. One public function per operation in /rest/api/3/filter. Build a client with `atlassian.jira.client/client`, then call any function here with it as the first argument.
Jira Cloud Issue Properties and Issue Type Properties endpoints.
Covers both issue-level and issue-type-level entity property CRUD, plus bulk
set/delete operations. All fns delegate to atlassian.jira.client/request.
Jira Cloud Issue Properties and Issue Type Properties endpoints. Covers both issue-level and issue-type-level entity property CRUD, plus bulk set/delete operations. All fns delegate to `atlassian.jira.client/request`.
Jira Issues API — one public fn per operation in the Issues group.
All fns take a client (built via atlassian.jira.client/client) as the
first arg, then required path params, then an optional opts map for query
params and/or a body map for write operations.
Description/comment fields that accept rich text expect ADF documents.
Use atlassian.jira.adf/text->adf to build one from a plain string.
Jira Issues API — one public fn per operation in the Issues group. All fns take a `client` (built via `atlassian.jira.client/client`) as the first arg, then required path params, then an optional `opts` map for query params and/or a `body` map for write operations. Description/comment fields that accept rich text expect ADF documents. Use `atlassian.jira.adf/text->adf` to build one from a plain string.
Jira Cloud issue types, issue type schemes, and issue type screen schemes.
Covers:
Jira Cloud issue types, issue type schemes, and issue type screen schemes. Covers: - Issue types (/rest/api/3/issuetype) - Issue type schemes (/rest/api/3/issuetypescheme) - Issue type screen schemes (/rest/api/3/issuetypescreenscheme)
Jira issue links and remote issue links endpoints.
Covers three groups of operations:
Jira issue links and remote issue links endpoints.
Covers three groups of operations:
- Issue remote links (/rest/api/3/issue/{issueIdOrKey}/remotelink)
- Issue links (/rest/api/3/issueLink)
- Issue link types (/rest/api/3/issueLinkType)Miscellaneous Jira Cloud REST API endpoints.
Covers: announcement banners, application properties, application roles, audit records, avatars, global configuration, Jira expressions, license metrics, labels, preferences, redaction, server info, tasks, and webhooks.
Miscellaneous Jira Cloud REST API endpoints. Covers: announcement banners, application properties, application roles, audit records, avatars, global configuration, Jira expressions, license metrics, labels, preferences, redaction, server info, tasks, and webhooks.
Jira notification scheme endpoints.
Covers the /rest/api/3/notificationscheme surface: listing, creating, updating, and deleting notification schemes, and managing individual notifications within a scheme.
Jira notification scheme endpoints. Covers the /rest/api/3/notificationscheme surface: listing, creating, updating, and deleting notification schemes, and managing individual notifications within a scheme.
Jira Cloud permissions, permission schemes, and issue security schemes.
Covers:
Jira Cloud permissions, permission schemes, and issue security schemes.
Covers:
- /mypermissions, /permissions — current-user and all permissions
- /permissionscheme — CRUD on permission schemes and grants
- /issuesecurityschemes — CRUD on issue security schemes, levels, and members
- /project/{id}/permissionscheme, /project/{id}/securitylevel — project-scoped opsJira Plans (Advanced Roadmaps) endpoint functions.
Covers plan lifecycle (create, get, update, archive, trash, duplicate) and team membership within a plan (Atlassian teams and plan-only teams).
All functions take a client built with atlassian.jira.client/client as the
first argument.
Jira Plans (Advanced Roadmaps) endpoint functions. Covers plan lifecycle (create, get, update, archive, trash, duplicate) and team membership within a plan (Atlassian teams and plan-only teams). All functions take a client built with `atlassian.jira.client/client` as the first argument.
Jira Cloud endpoints for issue priorities, priority schemes, issue resolutions, and statuses.
All functions delegate to atlassian.jira.client/request and take a client
handle as their first argument (build one with atlassian.jira.client/client).
Jira Cloud endpoints for issue priorities, priority schemes, issue resolutions, and statuses. All functions delegate to `atlassian.jira.client/request` and take a client handle as their first argument (build one with `atlassian.jira.client/client`).
Jira Cloud Project Roles and Project Role Actors endpoints.
Covers the /rest/api/3/project/{projectIdOrKey}/role* and /rest/api/3/role* surfaces for managing project roles, their members (actors), and global default actors.
Jira Cloud Project Roles and Project Role Actors endpoints.
Covers the /rest/api/3/project/{projectIdOrKey}/role* and /rest/api/3/role*
surfaces for managing project roles, their members (actors), and global
default actors.Jira Cloud project, component, version, category, and project-template endpoints.
One public fn per operation defined in resources/openapi/groups/projects.edn.
All functions delegate to atlassian.jira.client/request.
Jira Cloud project, component, version, category, and project-template endpoints. One public fn per operation defined in resources/openapi/groups/projects.edn. All functions delegate to `atlassian.jira.client/request`.
Jira Cloud screens, screen tabs, screen tab fields, and screen schemes.
Jira Cloud screens, screen tabs, screen tab fields, and screen schemes.
Jira search and JQL endpoint functions.
Covers issue search, JQL autocomplete, JQL parsing/sanitization, and issue navigator column settings from the Jira Cloud Platform REST API v3.
Jira search and JQL endpoint functions. Covers issue search, JQL autocomplete, JQL parsing/sanitization, and issue navigator column settings from the Jira Cloud Platform REST API v3.
Jira Cloud Users, User Search, User Properties, and Groups endpoints.
One public fn per operation in resources/openapi/groups/users.edn. All fns
delegate to atlassian.jira.client/request.
Jira Cloud Users, User Search, User Properties, and Groups endpoints. One public fn per operation in resources/openapi/groups/users.edn. All fns delegate to `atlassian.jira.client/request`.
Jira Cloud endpoint functions for issue watchers and votes.
Covers the Issue watchers and Issue votes API surfaces:
Jira Cloud endpoint functions for issue watchers and votes.
Covers the Issue watchers and Issue votes API surfaces:
- bulk-is-watching POST /rest/api/3/issue/watching
- get-votes GET /rest/api/3/issue/{issueIdOrKey}/votes
- add-vote POST /rest/api/3/issue/{issueIdOrKey}/votes
- remove-vote DELETE /rest/api/3/issue/{issueIdOrKey}/votes
- get-issue-watchers GET /rest/api/3/issue/{issueIdOrKey}/watchers
- add-watcher POST /rest/api/3/issue/{issueIdOrKey}/watchers
- remove-watcher DELETE /rest/api/3/issue/{issueIdOrKey}/watchersJira Cloud workflow, workflow-scheme, status, and status-category endpoints.
All functions take a client (from atlassian.jira.client/client) as their
first argument. Optional query params are passed via the trailing opts map.
Jira Cloud workflow, workflow-scheme, status, and status-category endpoints. All functions take a `client` (from `atlassian.jira.client/client`) as their first argument. Optional query params are passed via the trailing `opts` map.
Jira Cloud worklog, time-tracking, and worklog-property endpoint functions.
Covers:
Every function takes a client built by atlassian.jira.client/client as
its first argument. Required path params follow; an optional opts map (query
params) or a body map (request body) trail at the end per the contract.
Jira Cloud worklog, time-tracking, and worklog-property endpoint functions. Covers: - Issue worklogs (CRUD, bulk delete/move, list by ID) - Worklog change feeds (deleted/updated since) - Time tracking configuration - Worklog entity properties Every function takes a `client` built by `atlassian.jira.client/client` as its first argument. Required path params follow; an optional `opts` map (query params) or a `body` map (request body) trail at the end per the contract.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |