Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use API tokens instead of passwords; change JIRA to Jira; update docs… #176

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use API tokens instead of passwords; change JIRA to Jira; update docs… #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# JIRA REST API Client
# Jira REST API Client
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this change, because in here it's library name, not Jira application itself.


[![Build Status](https://secure.travis-ci.org/chobie/jira-api-restclient.png)](http://travis-ci.org/chobie/jira-api-restclient)

You all know that JIRA supports REST API, right? It can be very useful, for example, during automation job creation and notification sending.
You all know that Jira supports REST API, right? It can be very useful, for example, during automation job creation and notification sending.

This library will ensure unforgettable expirience when working with JIRA through REST API. Hope you'll enjoy it.
This library will ensure unforgettable expirience when working with Jira through REST API. Hope you'll enjoy it.

## Usage

* JIRA Rest API Documents: https://docs.atlassian.com/jira/REST/latest/
* Jira REST API documentation: https://developer.atlassian.com/cloud/jira/platform/rest/

```php
<?php
Expand All @@ -18,7 +18,7 @@ use chobie\Jira\Issues\Walker;

$api = new Api(
'https://your-jira-project.net',
new Basic('yourname', 'password')
new Basic('yourname', 'apitoken')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both password and apitoken would work. It's better to leave existing code and add a comment, e.g.:

new Basic('yourname', 'password') // Use `apitoken` instead of password for Jira Cloud instances.

);

$walker = new Walker($api);
Expand All @@ -42,6 +42,11 @@ php composer.phar require chobie/jira-api-restclient ^2.0@dev

* [Composer](https://getcomposer.org/download/)

## Authentication

This client uses basic authentication on the Jira Cloud APIs. Basic authentication requests for Jira Cloud should use [API tokens](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) instead of Atlassian account passwords, as support for basic authentication with passwords has been [deprecated](https://community.developer.atlassian.com/t/announcement-deprecation-of-basic-authentication-with-passwords-and-cookie-based-authentication-in-jira-cloud-rest-apis/15687).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usage of Jira Cloud term alone is incorrect. Better replace on the Jira Cloud APIs with on the Jira Instance (standalone or in the cloud).



## License

JIRA REST API Client is released under the MIT License. See the bundled [LICENSE](LICENSE) file for details.
Jira REST API Client is released under the MIT License. See the bundled [LICENSE](LICENSE) file for details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this change, because in here it's library name, not Jira application itself.