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).(client)(client cfg)Build a Jira client handle. With no args resolves config from the environment
(process env overlaid on a local .env) and throws a clear ex-info if
required credentials are missing. Pass an explicit Jira config map to bypass
the environment.
Build a Jira client handle. With no args resolves config from the environment (process env overlaid on a local `.env`) and throws a clear ex-info if required credentials are missing. Pass an explicit Jira config map to bypass the environment.
(request client {:keys [path api] :as opts})Perform a Jira request and return the parsed, keywordized JSON body on 2xx.
opts: :method - :get :post :put :delete (default :get) :path - path relative to the chosen API root, e.g. "/issue/ABC-123" :api - :platform (default) | :agile | :software :query - query-param map (sequential values -> repeated pairs) :body - EDN value, JSON-encoded into the request body :headers - extra request headers :throw? - throw ex-info on non-2xx (default true)
Delegates to atlassian.client/request; see it for error semantics.
Perform a Jira request and return the parsed, keywordized JSON body on 2xx. opts: :method - :get :post :put :delete (default :get) :path - path relative to the chosen API root, e.g. "/issue/ABC-123" :api - :platform (default) | :agile | :software :query - query-param map (sequential values -> repeated pairs) :body - EDN value, JSON-encoded into the request body :headers - extra request headers :throw? - throw ex-info on non-2xx (default true) Delegates to `atlassian.client/request`; see it for error semantics.
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 |