Confluence update or create method (atlassian-api#1050)

* Adjust fullwidth

* Cleanup mistake

Author: gonchik

atlassian/VERSION

@@ -1 +1 @@
-3.28.2
+3.29.0

atlassian/bitbucket/__init__.py

@@ -132,7 +132,7 @@ def get_users_info(self, user_filter=None, start=0, limit=25):
     def get_current_license(self):
         """
         Retrieves details about the current license, as well as the current status of the system with
-        regards to the installed license. The status includes the current number of users applied
+        regard to the installed license. The status includes the current number of users applied
         toward the license limit, as well as any status messages about the license (warnings about expiry
         or user counts exceeding license limits).
         The authenticated user must have ADMIN permission. Unauthenticated users, and non-administrators,
@@ -414,7 +414,7 @@ def _url_project_users(self, project_key):
 
     def project_users(self, key, start=0, limit=None, filter_str=None):
         """
-        Get users who has permission in project
+        Get users with permission in project
         :param key: The project key
         :param filter_str:  OPTIONAL: users filter string
         :param start:
@@ -447,9 +447,9 @@ def project_users_with_administrator_permissions(self, key):
 
     def project_grant_user_permissions(self, project_key, username, permission):
         """
-        Grant the specified project permission to an specific user
+        Grant the specified project permission to a specific user
         :param project_key: The project key
-        :param username: user name to be granted
+        :param username: username to be granted
         :param permission: the project permissions available are 'PROJECT_ADMIN', 'PROJECT_WRITE' and 'PROJECT_READ'
         :return:
         """
@@ -464,7 +464,7 @@ def project_remove_user_permissions(self, project_key, username):
         the specified project or a higher global permission to call this resource.
         In addition, a user may not revoke their own project permissions if they do not have a higher global permission.
         :param project_key: The project key
-        :param username: user name to be granted
+        :param username: username to be granted
         :return:
         """
         url = self._url_project_users(project_key)
@@ -496,7 +496,7 @@ def project_groups(self, key, start=0, limit=None, filter_str=None):
 
     def project_grant_group_permissions(self, project_key, group_name, permission):
         """
-        Grant the specified project permission to an specific group
+        Grant the specified project permission to a specific group
         :param project_key: The project key
         :param group_name: group to be granted
         :param permission: the project permissions available are 'PROJECT_ADMIN', 'PROJECT_WRITE' and 'PROJECT_READ'
@@ -801,7 +801,7 @@ def reindex_repo(self, project_key, repository_slug):
 
     def reindex_repo_dev_panel(self, project_key, repository_slug):
         """
-        Reindex all of the Jira issues related to this repository_slug, including branches and pull requests.
+        Reindex all the Jira issues related to this repository_slug, including branches and pull requests.
         This automatically happens as part of an upgrade, and calling this manually should only be required
         if something unforeseen happens and the index becomes out of sync.
         The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
@@ -917,7 +917,7 @@ def _url_repo_users(self, project_key, repo):
 
     def repo_users(self, project_key, repo_key, start=0, limit=None, filter_str=None):
         """
-        Get users who has permission in repository
+        Get users with permission in repository
         :param start:
         :param limit:
         :param project_key: The project key
@@ -937,7 +937,7 @@ def repo_users(self, project_key, repo_key, start=0, limit=None, filter_str=None
 
     def repo_grant_user_permissions(self, project_key, repo_key, username, permission):
         """
-        Grant the specified repository permission to an specific user
+        Grant the specified repository permission to a specific user
         :param project_key: The project key
         :param repo_key: The repository key (slug)
         :param username: user name to be granted
@@ -1032,7 +1032,7 @@ def repo_groups_with_administrator_permissions(self, project_key, repo_key):
 
     def repo_grant_group_permissions(self, project_key, repo_key, groupname, permission):
         """
-        Grant the specified repository permission to an specific group
+        Grant the specified repository permission to a specific group
         Promote or demote a group's permission level for the specified repository. Available repository permissions are:
             REPO_READ
             REPO_WRITE
@@ -1830,9 +1830,9 @@ def delete_pull_request_comment(self, project_key, repository_slug, pull_request
         Delete a comment.
         Only the repository admin or user who created a comment may update it.
 
-        Note: the supplied supplied JSON object must contain a version
+        Note: the supplied JSON object must contain a version
         that must match the server's version of the comment
-        or the delete will fail.
+        or delete will fail.
         """
         url = self._url_pull_request_comment(project_key, repository_slug, pull_request_id, comment_id)
         data = {"version": comment_version}

atlassian/bitbucket/cloud/repositories/pipelines.py

@@ -256,4 +256,4 @@ def log(self, start=None, end=None):
 
         if start is None:
             return response.content
-        return (response.headers["Content-Range"].split("/")[1], response.content)
+        return response.headers["Content-Range"].split("/")[1], response.content

atlassian/bitbucket/server/projects/__init__.py

@@ -37,7 +37,10 @@ def create(self, name, key, description, avatar=None):
 
         API docs: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp148
         """
-        return self.__get_object(self.post(None, data={"name": name, "key": key, "description": description}))
+        data = {"name": name, "key": key, "description": description}
+        if avatar:
+            data["avatar"] = avatar
+        return self.__get_object(self.post(None, data=data))
 
     def each(self, name=None, permission=None):
         """

atlassian/confluence.py

@@ -1493,6 +1493,7 @@ def update_page(
         minor_edit=False,
         version_comment=None,
         always_update=False,
+        full_width=False,
     ):
         """
         Update page if already exist
@@ -1506,9 +1507,10 @@ def update_page(
             If False then notifications will be sent.
         :param version_comment: Version comment
         :param always_update: Whether always to update (suppress content check)
+        :param full_width: OPTIONAL: Default False
         :return:
         """
-        log.info('Updating {type} "{title}"'.format(title=title, type=type))
+        log.info('Updating {type} "{title}" with {parent_id}'.format(title=title, type=type, parent_id=parent_id))
 
         if not always_update and body is not None and self.is_page_content_is_already_updated(page_id, body, title):
             return self.get_page_by_id(page_id)
@@ -1537,6 +1539,9 @@ def update_page(
         if version_comment:
             data["version"]["message"] = version_comment
 
+        if full_width is True:
+            data["metadata"]["properties"]["content-appearance-draft"] = {"value": "full-width"}
+            data["metadata"]["properties"]["content-appearance-published"] = {"value": "full-width"}
         try:
             response = self.put("rest/api/content/{0}".format(page_id), data=data)
         except HTTPError as e:
@@ -1699,6 +1704,7 @@ def update_or_create(
         minor_edit=False,
         version_comment=None,
         editor=None,
+        full_width=False,
     ):
         """
         Update page or create a page if it is not exists
@@ -1709,6 +1715,7 @@ def update_or_create(
         :param minor_edit: Update page without notification
         :param version_comment: Version comment
         :param editor: OPTIONAL: v2 to be created in the new editor
+        :param full_width: OPTIONAL: Default is False
         :return:
         """
         space = self.get_page_space(parent_id)
@@ -1724,6 +1731,7 @@ def update_or_create(
                 representation=representation,
                 minor_edit=minor_edit,
                 version_comment=version_comment,
+                full_width=full_width,
             )
         else:
             result = self.create_page(
@@ -1733,6 +1741,7 @@ def update_or_create(
                 body=body,
                 representation=representation,
                 editor=editor,
+                full_width=full_width,
             )
 
         log.info(

atlassian/insight.py

@@ -2,6 +2,7 @@
 import logging
 
 from .rest_client import AtlassianRestAPI
+from deprecated import deprecated
 
 log = logging.getLogger(__name__)
 
@@ -197,7 +198,7 @@ def start_import_configuration(self, import_id):
         :param import_id:
         :return:
         """
-        url = self.url_joiner(self.api_root, "import/start/{import_id}")
+        url = self.url_joiner(self.api_root, "import/start/{import_id}".format(import_id=import_id))
         return self.post(url)
 
     # Index
@@ -279,22 +280,22 @@ def get_object(self, object_id):
         url = self.url_joiner(self.api_root, "object/{id}".format(id=object_id))
         return self.get(url)
 
-    def update_object(self, object_id, objectTypeId, attributes, hasAvatar=False, avatarUUID=""):
+    def update_object(self, object_id, object_type_id, attributes, has_avatar=False, avatar_UUID=""):
         """
         Update an existing object in Insight
 
         :param object_id:
-        :param objectTypeId:
+        :param object_type_id:
         :param attributes:
-        :param hasAvatar:
-        :param avatarUUID:
+        :param has_avatar:
+        :param avatar_UUID:
         :return:
         """
         body = {
             "attributes": attributes,
-            "objectTypeId": objectTypeId,
-            "avatarUUID": avatarUUID,
-            "hasAvatar": hasAvatar,
+            "objectTypeId": object_type_id,
+            "avatarUUID": avatar_UUID,
+            "hasAvatar": has_avatar,
         }
         url = self.url_joiner(self.api_root, "object/{id}".format(id=object_id))
         return self.put(url, data=body)
@@ -313,7 +314,7 @@ def get_object_attributes(self, object_id):
         """
         List all attributes for the given object
 
-        :param id:
+        :param object_id:
         :return:
         """
         url = self.url_joiner(self.api_root, "object/{id}/attributes".format(id=object_id))
@@ -323,7 +324,7 @@ def get_object_history(self, object_id, asc=False, abbreviate=True):
         """
         Retrieve the history entries for this object
 
-        :param id:
+        :param object_id:
         :param asc:
         :param abbreviate:
         :return:
@@ -332,11 +333,17 @@ def get_object_history(self, object_id, asc=False, abbreviate=True):
         url = self.url_joiner(self.api_root, "object/{id}/history".format(id=object_id))
         return self.get(url, params=params)
 
+    @deprecated(version="3.29.0", reason="Use get_object_reference_info()")
     def get_object_referenceinfo(self, object_id):
+        """Let's use the get_object_reference_info()"""
+        log.warning("Please, be informed that is deprecated as typo naming")
+        self.get_object_reference_info(object_id)
+
+    def get_object_reference_info(self, object_id):
         """
         Find all references for an object
 
-        :param id:
+        :param object_id:
         :return:
         """
         url = self.url_joiner(self.api_root, "object/{id}/referenceinfo".format(id=object_id))
@@ -439,7 +446,7 @@ def list_objectschema(self):
         url = self.url_joiner(self.api_root, "objectschema/list")
         return self.get(url)
 
-    def create_objectschema(self, objectSchemaKey, description):
+    def create_objectschema(self, object_schema_key, description):
         raise NotImplementedError
 
     def get_objectschema(self, schema_id):

atlassian/jira.py

@@ -1653,6 +1653,7 @@ def user_property(self, username=None, account_id=None, key_property=None):
         :param key_property:
         :return:
         """
+        params = {}
         if username or not self.cloud:
             params = {"username": username}
         elif account_id or self.cloud:
@@ -2731,7 +2732,7 @@ def add_field(self, field_id, screen_id, tab_id):
     Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/search
     """
 
-    def jql(self, jql, fields="*all", start=0, limit=None, expand=None, validate_query=None, advanced_mode=None):
+    def jql(self, jql, fields="*all", start=0, limit=None, expand=None, validate_query=None):
         """
         Get issues from jql search result with all related fields
         :param jql:
@@ -2740,7 +2741,7 @@ def jql(self, jql, fields="*all", start=0, limit=None, expand=None, validate_que
         :param limit: OPTIONAL: The limit of the number of issues to return, this may be restricted by
                 fixed system limits. Default by built-in method: 50
         :param expand: OPTIONAL: expand the search result
-        :param validate_query: Whether to validate the JQL query
+        :param validate_query: OPTIONAL: Whether to validate the JQL query
         :return:
         """
         params = {}
@@ -3750,6 +3751,7 @@ def tempo_timesheets_get_worklogs(
         url = "rest/tempo-timesheets/3/worklogs/"
         return self.get(url, params=params)
 
+    # noinspection PyIncorrectDocstring
     def tempo_4_timesheets_find_worklogs(self, **params):
         """
         Find existing worklogs with searching parameters.

atlassian/rest_client.py

@@ -304,6 +304,14 @@ def post(
         advanced_mode=False,
     ):
         """
+        :param path:
+        :param data:
+        :param json:
+        :param headers:
+        :param files:
+        :param params:
+        :param trailing:
+        :param absolute:
         :param advanced_mode: bool, OPTIONAL: Return the raw response
         :return: if advanced_mode is not set - returns dictionary. If it is set - returns raw response.
         """
@@ -334,6 +342,13 @@ def put(
         advanced_mode=False,
     ):
         """
+        :param path: Path of request
+        :param data:
+        :param headers: adjusted headers, usually it's default
+        :param files:
+        :param trailing:
+        :param params:
+        :param absolute:
         :param advanced_mode: bool, OPTIONAL: Return the raw response
         :return: if advanced_mode is not set - returns dictionary. If it is set - returns raw response.
         """
@@ -363,6 +378,12 @@ def delete(
     ):
         """
         Deletes resources at given paths.
+        :param path:
+        :param data:
+        :param headers:
+        :param params:
+        :param trailing:
+        :param absolute:
         :param advanced_mode: bool, OPTIONAL: Return the raw response
         :rtype: dict
         :return: Empty dictionary to have consistent interface.

docs/confluence.rst

@@ -70,7 +70,7 @@ Page actions
 .. code-block:: python
 
     # Create page from scratch
-    confluence.create_page(space, title, body, parent_id=None, type='page', representation='storage', editor='v2')
+    confluence.create_page(space, title, body, parent_id=None, type='page', representation='storage', editor='v2', full_width=False)
 
     # This method removes a page, if it has recursive flag, method removes including child pages
     confluence.remove_page(page_id, status=None, recursive=False)
@@ -85,10 +85,10 @@ Page actions
     confluence.remove_page_as_draft(page_id)
 
     # Update page if already exist
-    confluence.update_page(page_id, title, body, parent_id=None, type='page', representation='storage', minor_edit=False)
+    confluence.update_page(page_id, title, body, parent_id=None, type='page', representation='storage', minor_edit=False, full_width=False)
 
     # Update page or create page if it is not exists
-    confluence.update_or_create(parent_id, title, body, representation='storage')
+    confluence.update_or_create(parent_id, title, body, representation='storage', full_width=False)
 
     # Append body to page if already exist
     confluence.append_page(page_id, title, append_body, parent_id=None, type='page', representation='storage', minor_edit=False)