GithubHelp home page GithubHelp logo

jiraswift's Introduction

JiraSwift

Swift Platforms Xcode License Twitter: @cpageler93

JiraSwift is a HTTP client for Jira implemented in swift based on swift-server/async-http-client.

Framework Usage

JQL Search

let jira = JiraClient(baseURL: "https://jira.tinyspeck.com", 
                      username: "your_username", 
                      password: "your_password")

// jira.search.post(jql: String) returns EventLoopFuture<SearchResult>
// you can work with .wait() or .whenComplete { result }
let result = try jira.search.post(jql: "key in (XXX027-65, XXX038-3, XXX027-58)").wait()

Implemented Methods

Implemented Route / Method Route
myself.get() /rest/api/2/myself
search.post() /rest/api/2/search
serverInfo.get() /rest/api/2/serverInfo
project.list() /rest/api/2/project
project.types() /rest/api/2/project/type

Command Line Interface

Environment

You can either setup your environment

# setup environment
JIRA_URL=https://your_jira_url
JIRA_USERNAME=your_username
JIRA_PASSWORD=your_password

jira search --jql "key in (XYZ027-65, XYZ038-3, XYZ027-58)"

Or pass all values as options to jira the command

jira search --url "https://your_jira_url" \
            --username "your_username" \
            --password "your_password" \
            --jql "key in (XYZ027-65, XYZ038-3, XYZ027-58)"

Commands

Command Description
search Search for Issues with JQL
project list List all projects
project types List all project types

Contribute

Feel free to add a missing REST API method or create an issue if you want me to implement it!

Jira REST API Documentation

jiraswift's People

Contributors

cpageler93 avatar ddosip avatar rfldhs avatar yasumoto avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.