Use API tokens instead of passwords; change JIRA to Jira; update docs… #176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aik099
requested changes
Mar 6, 2018
| @@ -1,14 +1,14 @@ | |||
| # JIRA REST API Client | |||
| # Jira REST API Client | |||
There was a problem hiding this comment.
Please revert this change, because in here it's library name, not Jira application itself.
| @@ -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') | |||
There was a problem hiding this comment.
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.
| ## 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. |
There was a problem hiding this comment.
Please revert this change, because in here it's library name, not Jira application itself.
| @@ -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). | |||
There was a problem hiding this comment.
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).
|
I'm here just to confirm, that i just used api token instead of password, no code changes are neccessary. just docs update is fine. |
|
@mansilladev , any updates? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
… URL