sym.sdk.integrations.jira

Helpers for interacting with the Jira API within the Sym SDK.

Functions

add_comment_to_issue(issue_id_or_key, comment)

Adds a comment to a Jira issue.

search_issues(jql[, fields, expand])

Returns a list of issues matching the given JQL query.
sym.sdk.integrations.jira.add_comment_to_issue(issue_id_or_key: str, comment: str, expand: Optional[List[str]] = None) → None

Adds a comment to a Jira issue.

See Jira’s API docs here for details.

Parameters

  • issue_id_or_key – The ID or key of the issue.

  • comment – A string to be added as a comment to the Jira issue.

  • expand – An optional list of strings indicating what additional information about issues to include in the response.

Raises

JiraError – If the issue does not exist.

sym.sdk.integrations.jira.search_issues(jql: str, fields: Optional[List[str]] = None, expand: Optional[List[str]] = None) → List[dict]

Returns a list of issues matching the given JQL query.

See Jira’s API docs for details.

Parameters

  • jql – A non-empty JQL expression.

  • fields – A list of fields to return for each issue. Use it to retrieve a subset of fields.

  • expand – An optional list of strings indicating what additional information about issues to include in the response.

Returns

A list of dictionaries representing Jira issues.

Raises

JiraError – If the JQL expression is empty.