Module types 

Structs

Board

A Jira Agile board.

BoardSearchResponse

Paginated board response from the Agile API.

Comment

CommentList

CreateIssueResponse

Response from creating an issue.

Field

A Jira field (system or custom).

FieldSchema

The schema of a field, describing its type.

Issue

Jira issue as returned by the search and issue endpoints.

IssueFields

IssueLink

An issue link (relationship between two issues).

IssueLinkType

The type of an issue link (e.g. “Blocks”, “Duplicate”).

IssueTypeField

LinkedIssue

A summary view of an issue referenced in a link.

LinkedIssueFields

Myself

Current authenticated user.

PriorityField

Project

Jira project.

ProjectSearchResponse

Response from the paginated project search endpoint.

SearchJqlPage

Raw page from the Jira Cloud /rest/api/3/search/jql endpoint.

SearchJqlSkipPage

Lightweight page response used when walking the cursor forward with fields=["id"]. The returned issue objects then lack a fields sub-object, so the regular Issue deserialization would fail — we only need the issue count and the next cursor here.

SearchResponse

Response from the Jira search endpoint.

Sprint

A Jira sprint.

SprintSearchResponse

Paginated sprint response from the Agile API.

StatusCategory

Workflow category for a status (e.g. “new”, “indeterminate”, “done”).

StatusField

Transition

A single issue transition (workflow action).

TransitionTo

The target status of a transition.

TransitionsResponse

Response from the transitions endpoint.

User

A Jira user returned from the user search endpoint.

UserField

WorklogEntry

A single worklog entry on an issue.

Functions

escape_jql

Escape a value for use inside a JQL double-quoted string literal.

extract_adf_text

Extract plain text from an ADF node or a plain string value.

text_to_adf

Build an Atlassian Document Format document from plain text.