Adding `jira_query` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add jira_query

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

jira_query = "1.6.0"

The jira_query library will be automatically available globally. Read the jira_query library documentation.

Back to the crate overview.

Readme

jira_query

Access issues on a remote Jira instance.

Description

The jira_query crate is a Rust library that can query a Jira instance using its REST API. It returns a strongly typed representation of the requested issues.

This library provides no functionality to create or modify issues. The access is read-only.

Usage

Basic anonymous query

Without logging in, search for a single ticket and check for its priority:

use tokio;
use jira_query::JiraInstance;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let jira = JiraInstance::at("https://issues.redhat.com".to_string())?;

    let issue = jira.issue("CS-1113").await?;

    assert_eq!(issue.fields.priority.name, "Normal");

    Ok(())
}

Advanced query

Use an API key to log into Jira. Search for all CentOS Stream tickets that are of the Blocker priority. Check that there is more than one ticket:

use tokio;
use jira_query::{Auth, JiraInstance, Pagination};

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let jira = JiraInstance::at("https://bugzilla.redhat.com".to_string())?
        .authenticate(Auth::ApiKey("My API Key".to_string()))
        .paginate(Pagination::ChunkSize(32));

    let query = r#"project="CentOS Stream" AND priority=Blocker"#;

    let issues = jira.search(query).await?;

    assert!(issues.len() > 1);

    Ok(())
}

A note on semantic versioning

This crate reserves the right to make limited breaking changes to the Jira structs in minor versions (X.Y).

The reason is that the official Jira documentation does not specify which fields in the JSON body are optional (Option<T>) and which are mandatory (T). Rather than exposing all fields as optional, this crate tries to process fields as mandatory until proven otherwise in testing. As a consequence, minor releases must occasionally turn a mandatory field to an optional field.

Adding jira_query library as a dependency

Adding `jira_query` library as a dependency