[confluence cloud] double/confusing cloud specification in init

atlassian-api / atlassian-python-api

Atlassian Python REST API wrapper

https://atlassian-python-api.readthedocs.io

Apache License 2.0

1.34k stars 660 forks source link

[confluence cloud] double/confusing cloud specification in init #997

Open dloeckx opened 2 years ago

dloeckx commented 2 years ago

Recently, pdf export from Confluence Cloud has been improved, see #201 . This requires api_version="cloud" to be passed during init of the Confluence instance.

However, two different parameters concerning the cloud can be passed during initialisation: cloud=True and api_version="cloud". This is very confusing (see #718 , #892 , #981 ). Moreover, it also seems to be redundant, and it seems the cloud=True parameter is never used.

I would suggest to remove one of both parameters.

Spacetown commented 2 years ago

In my opinion both arguments are needed but the value api_veraion="cloud" is wrong. The version is normally used in the url and has a value of 1, 2, latest, ... The two places relaying on the value of the api_version should be changed to the cloud flag and the documentation should be adapted.