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

Jump to bottom

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

Open
neomafo88 opened this issue Apr 10, 2024 · 1 comment
Open

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

neomafo88 opened this issue Apr 10, 2024 · 1 comment

Comments

@neomafo88
Copy link

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 pushed a commit to gkowalc/atlassian-python-api that referenced this issue Apr 12, 2024
improving index.rst docs atlassian-api#1365
5596fd5
@gkowalc gkowalc mentioned this issue Apr 12, 2024
Merged
@gkowalc
Copy link
Contributor

gkowalc commented Apr 12, 2024 •
edited

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 #1370

gonchik pushed a commit that referenced this issue Apr 22, 2024
@gkowalc
[Confluence] added new endpoints for confluence whiteboards + docs + …
85458f1 
…example (#1377)

* fixing minor issue in scrap_regex_from_issue method

* new Confluence method scrap_regex_from_page+ docs + examples

* added method get_attachments_ids_from_page to jira.py

* added method download_attachments_from_issue

* refactoring download_all_attachments_from_page method

* finished download_attachments_from_issue

* added two new methods: download_attachments.from_issue  and get_attachments_ids_from_issue

* added fix to the infinitive loop

* adding reursion depth condition

* fixed reursion depth condition

* added update4d jira.py with new method + docs +example

* added update4d jira.py with new method + docs +exampl

* fix flake8 issue

* hotfix get_issue_tree_recursive

* added expand to get_issue method, added new method

* get_issue_status_changelog method

* included param expand in get_issue method decription

* WIP PR changes - #1357

* improving index.rst docs #1365

* added whiteboard methods

* added confluence whiteboard endpoints

---------

Co-authored-by: gkowalc <>
Co-authored-by: Greg <gkowalc>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gkowalc @neomafo88