Skip to content

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

Open
mansilladev wants to merge 1 commit into
console-helpers:masterfrom
mansilladev:master
Open

Use API tokens instead of passwords; change JIRA to Jira; update docs…#176
mansilladev wants to merge 1 commit into
console-helpers:masterfrom
mansilladev:master

Conversation

@mansilladev

Copy link
Copy Markdown

… URL

Comment thread README.md
@@ -1,14 +1,14 @@
# JIRA REST API Client
# Jira REST API Client

Copy link
Copy Markdown
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.

Comment thread README.md
$api = new Api(
'https://your-jira-project.net',
new Basic('yourname', 'password')
new Basic('yourname', 'apitoken')

Copy link
Copy Markdown
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.

Comment thread README.md
## 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
Copy Markdown
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.

Comment thread README.md

## 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
Copy Markdown
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).

@glensc

glensc commented Dec 6, 2018

Copy link
Copy Markdown
Contributor

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.

@aik099

aik099 commented Dec 6, 2018

Copy link
Copy Markdown
Member

@mansilladev , any updates?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants