JiraAPIWrapper#

class langchain_community.utilities.jira.JiraAPIWrapper[source]#

Bases: BaseModel

Wrapper for Jira API. You can connect to Jira with either an API token or OAuth2. - with API token, you need to provide the JIRA_USERNAME and JIRA_API_TOKEN

environment variables or arguments.

ex: JIRA_USERNAME=your_username JIRA_API_TOKEN=your_api_token - with OAuth2, you need to provide the JIRA_OAUTH2 environment variable or

argument as a dict having as fields “client_id” and “token” which is a dict containing at least “access_token” and “token_type”.

ex: JIRA_OAUTH2=’{“client_id”: “your_client_id”, “token”:

{“access_token”: “your_access_token”,”token_type”: “bearer”}}’

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param confluence: Any = None#
param jira_api_token: str | None = None#

Jira API token when you choose to connect to Jira with api token.

param jira_cloud: bool | None = None#
param jira_instance_url: str | None = None#
param jira_oauth2: JiraOauth2 | str | None = None#

Jira OAuth2 token when you choose to connect to Jira with oauth2.

param jira_username: str | None = None#
issue_create(query: str) → str[source]#
Parameters:

query (str)

Return type:

str

other(query: str) → str[source]#
Parameters:

query (str)

Return type:

str

page_create(query: str) → str[source]#
Parameters:

query (str)

Return type:

str

parse_issues(
issues: Dict,
) → List[dict][source]#
Parameters:

issues (Dict)

Return type:

List[dict]

parse_projects(
projects: List[dict],
) → List[dict][source]#
Parameters:

projects (List[dict])

Return type:

List[dict]

project() → str[source]#
Return type:

str

run(mode: str, query: str) → str[source]#
Parameters:

  • mode (str)

  • query (str)

Return type:

str

search(query: str) → str[source]#
Parameters:

query (str)

Return type:

str

Examples using JiraAPIWrapper