search

atlassian-api / atlassian-python-api

Atlassian Python REST API wrapper
https://atlassian-python-api.readthedocs.io
Apache License 2.0
1.29k stars 642 forks source link

BUG: Documentation https://atlassian-python-api.readthedocs.io #1365

Open neomafo88 opened 2 months ago

neomafo88 commented 2 months ago

To authenticate to the Atlassian Cloud APIs Jira, Confluence, ServiceDesk:

# Obtain an API token from: https://id.atlassian.com/manage-profile/security/api-tokens
# You cannot log-in with your regular password to these services.

jira = Jira(
    url='https://your-domain.atlassian.net',
    username=jira_username,
    password=jira_api_token,
    cloud=True)

confluence = Confluence(
    url='https://your-domain.atlassian.net',
    username=jira_username,
    password=jira_api_token,
    cloud=True)

service_desk = ServiceDesk(
    url='https://your-domain.atlassian.net',
    username=jira_username,
    password=jira_api_token,
    cloud=True)

password=jira_api_token, is copy-pasted across Jira, Confluence and ServiceDesk, without modification

gkowalc commented 2 months ago

It is a small thing but I agree we should use more generic username/password examples in docs so that there is no confusion. I have added quick PR for this docs improvement https://github.com/atlassian-api/atlassian-python-api/pull/1370