Liking cljdoc? Tell your friends :D

atlassian.config

Configuration + auth resolution for the Atlassian Cloud APIs.

Pure where it matters: this namespace reads environment variables (and an optional local, gitignored .env) into compact config maps and reports whether auth is ready WITHOUT making any network call. URL bases and the Authorization header are constructed here so the HTTP layer stays a dumb transport.

No secrets are ever written to tracked files. .env is gitignored.

Configuration + auth resolution for the Atlassian Cloud APIs.

Pure where it matters: this namespace reads environment variables (and an
optional local, gitignored `.env`) into compact config maps and reports
whether auth is ready WITHOUT making any network call. URL bases and the
Authorization header are constructed here so the HTTP layer stays a dumb
transport.

No secrets are ever written to tracked files. `.env` is gitignored.
raw docstring

auth-headerclj

(auth-header cfg)

Authorization header value. Cloud uses Basic base64(email:token); Data Center uses a Bearer personal access token.

Authorization header value. Cloud uses Basic `base64(email:token)`; Data
Center uses a Bearer personal access token.
sourceraw docstring

confluence-auth-statusclj

(confluence-auth-status)
(confluence-auth-status cfg)

Report whether required Confluence config is present. NEVER hits the network.

Report whether required Confluence config is present. NEVER hits the network.
sourceraw docstring

confluence-configclj

(confluence-config)
(confluence-config env-or-fn)

Build the Confluence config map from the environment. Because Confluence Cloud lives on the SAME site and uses the SAME API token as Jira, the resolver falls back to the Jira variables when Confluence-specific ones are absent:

CONFLUENCE_BASE_URL | JIRA_BASE_URL (site origin; /wiki optional) CONFLUENCE_USER_EMAIL | CONFLUENCE_EMAIL | JIRA_USER_EMAIL | JIRA_EMAIL CONFLUENCE_API_TOKEN | CONFLUENCE_API_KEY | JIRA_API_TOKEN | JIRA_API_KEY CONFLUENCE_INSTANCE_TYPE = cloud | datacenter (default cloud)

Pass a {"VAR" val} map (or resolver fn) to bypass the real environment.

Build the Confluence config map from the environment. Because Confluence Cloud
lives on the SAME site and uses the SAME API token as Jira, the resolver falls
back to the Jira variables when Confluence-specific ones are absent:

  CONFLUENCE_BASE_URL   | JIRA_BASE_URL          (site origin; `/wiki` optional)
  CONFLUENCE_USER_EMAIL | CONFLUENCE_EMAIL | JIRA_USER_EMAIL | JIRA_EMAIL
  CONFLUENCE_API_TOKEN  | CONFLUENCE_API_KEY | JIRA_API_TOKEN | JIRA_API_KEY
  CONFLUENCE_INSTANCE_TYPE = cloud | datacenter   (default cloud)

Pass a `{"VAR" val}` map (or resolver fn) to bypass the real environment.
sourceraw docstring

confluence-v1-baseclj

(confluence-v1-base cfg)

Root of the Confluence Cloud REST API v1, e.g. https://x.atlassian.net/wiki/rest/api

Root of the Confluence Cloud REST API v1, e.g. https://x.atlassian.net/wiki/rest/api
sourceraw docstring

confluence-v2-baseclj

(confluence-v2-base cfg)

Root of the Confluence Cloud REST API v2, e.g. https://x.atlassian.net/wiki/api/v2

Root of the Confluence Cloud REST API v2, e.g. https://x.atlassian.net/wiki/api/v2
sourceraw docstring

env-resolverclj

(env-resolver)
(env-resolver dotenv getenv)

Return a lookup fn (f "VAR") -> value-or-nil resolving process env over an optional .env file (process env wins). Pass overrides for testing.

Return a lookup fn `(f "VAR") -> value-or-nil` resolving process env over an
optional `.env` file (process env wins). Pass overrides for testing.
sourceraw docstring

issue-browse-urlclj

(issue-browse-url cfg issue-key)

Human browser URL for an issue, e.g. https://x.atlassian.net/browse/ABC-123

Human browser URL for an issue, e.g. https://x.atlassian.net/browse/ABC-123
sourceraw docstring

jira-agile-baseclj

(jira-agile-base cfg)

Root of the Jira Software Agile REST API, e.g. https://x.atlassian.net/rest/agile/1.0 (same path on Cloud and Data Center).

Root of the Jira Software Agile REST API, e.g.
https://x.atlassian.net/rest/agile/1.0 (same path on Cloud and Data Center).
sourceraw docstring

jira-api-baseclj

(jira-api-base cfg)

Root of the Jira platform REST API, e.g. https://x.atlassian.net/rest/api/3

Root of the Jira platform REST API, e.g. https://x.atlassian.net/rest/api/3
sourceraw docstring

jira-auth-statusclj

(jira-auth-status)
(jira-auth-status cfg)

Report whether required Jira config is present. NEVER hits the network.

Cloud auth needs base-url + email + token (Basic). Data Center PAT auth needs only base-url + token (Bearer). Returns a map with :configured? and the list of :missing variable names — :token itself is never echoed back.

Report whether required Jira config is present. NEVER hits the network.

Cloud auth needs base-url + email + token (Basic). Data Center PAT auth needs
only base-url + token (Bearer). Returns a map with `:configured?` and the list
of `:missing` variable names — `:token` itself is never echoed back.
sourceraw docstring

jira-configclj

(jira-config)
(jira-config env-or-fn)

Build the Jira config map from the environment (process env overlaid on a local .env). Accepts alternate variable names so it works against either the spec'd names or a typical Cloud .env:

JIRA_BASE_URL JIRA_USER_EMAIL | JIRA_EMAIL | JIRA_USER JIRA_API_TOKEN | JIRA_API_KEY JIRA_INSTANCE_TYPE = cloud | datacenter (default cloud) JIRA_API_VERSION (default 3 cloud, 2 datacenter)

Pass a {"VAR" val} map (or a resolver fn) to bypass the real environment — this is the seam tests use, so no test ever needs live credentials.

Build the Jira config map from the environment (process env overlaid on a
local `.env`). Accepts alternate variable names so it works against either the
spec'd names or a typical Cloud `.env`:

  JIRA_BASE_URL
  JIRA_USER_EMAIL | JIRA_EMAIL | JIRA_USER
  JIRA_API_TOKEN  | JIRA_API_KEY
  JIRA_INSTANCE_TYPE = cloud | datacenter   (default cloud)
  JIRA_API_VERSION                          (default 3 cloud, 2 datacenter)

Pass a `{"VAR" val}` map (or a resolver fn) to bypass the real environment —
this is the seam tests use, so no test ever needs live credentials.
sourceraw docstring

jira-software-baseclj

(jira-software-base cfg)

Root of the enhanced Jira Software API (enhanced sprint/epic endpoints), e.g. https://x.atlassian.net/rest/software/1.0.

Root of the enhanced Jira Software API (enhanced sprint/epic endpoints), e.g.
https://x.atlassian.net/rest/software/1.0.
sourceraw docstring

load-dotenvclj

(load-dotenv)
(load-dotenv path)

Parse a .env-style file into a {"VAR" "value"} map. Returns {} if the file is absent or unreadable. Tolerates export, single/double quotes, blank lines, and # comment lines. Never throws — a missing .env is normal.

Parse a `.env`-style file into a `{"VAR" "value"}` map. Returns `{}` if the
file is absent or unreadable. Tolerates `export `, single/double quotes, blank
lines, and `#` comment lines. Never throws — a missing `.env` is normal.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close