docs: Improve descriptions of types (box/box-openapi#527) (#600)

Co-authored-by: box-sdk-build <[email protected]>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "20cb559", "specHash": "2da99e0", "version": "1.14.0" }
+{ "engineHash": "20cb559", "specHash": "a54170e", "version": "1.14.0" }

box_sdk_gen/managers/files.py

@@ -371,7 +371,10 @@ def update_file_by_id(
         Example: "12345"
                 :type file_id: str
                 :param name: An optional different name for the file. This can be used to
-        rename the file., defaults to None
+        rename the file.
+
+        File names must be unique within their parent folder. The name check is case-insensitive, so a file
+        named `New File` cannot be created in a parent folder that already contains a folder named `new file`., defaults to None
                 :type name: Optional[str], optional
                 :param description: The description for a file. This can be seen in the right-hand sidebar panel
         when viewing a file in the Box web app. Additionally, this index is used in

box_sdk_gen/managers/folders.py

@@ -464,7 +464,7 @@ def update_folder_by_id(
         if_match: Optional[str] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
     ) -> FolderFull:
-        """
+        r"""
                 Updates a folder. This can be also be used to move the folder,
 
                 create shared links, update collaborations, and more.
@@ -481,7 +481,16 @@ def update_folder_by_id(
         always represented by the ID `0`.
         Example: "12345"
                 :type folder_id: str
-                :param name: The optional new name for this folder., defaults to None
+                :param name: The optional new name for this folder.
+
+        The following restrictions to folder names apply: names containing
+        non-printable ASCII characters, forward and backward slashes
+        (`/`, `\`), names with trailing spaces, and names `.` and `..` are
+        not allowed.
+
+        Folder names must be unique within their parent folder. The name check is case-insensitive,
+        so a folder named `New Folder` cannot be created in a parent folder that already contains
+        a folder named `new folder`., defaults to None
                 :type name: Optional[str], optional
                 :param description: The optional description of this folder, defaults to None
                 :type description: Optional[str], optional
@@ -826,13 +835,14 @@ def create_folder(
                 Creates a new empty folder within the specified parent folder.
                 :param name: The name for the new folder.
 
-        There are some restrictions to the file name. Names containing
+        The following restrictions to folder names apply: names containing
         non-printable ASCII characters, forward and backward slashes
-        (`/`, `\`), as well as names with trailing spaces are
-        prohibited.
+        (`/`, `\`), names with trailing spaces, and names `.` and `..` are
+        not allowed.
 
-        Additionally, the names `.` and `..` are
-        not allowed either.
+        Folder names must be unique within their parent folder. The name check is case-insensitive,
+        so a folder named `New Folder` cannot be created in a parent folder that already contains
+        a folder named `new folder`.
                 :type name: str
                 :param parent: The parent folder to create the new folder within.
                 :type parent: CreateFolderParent

box_sdk_gen/managers/uploads.py

@@ -97,7 +97,10 @@ def __init__(
         **kwargs
     ):
         """
-                :param name: The name of the file
+                :param name: The name of the file.
+
+        File names must be unique within their parent folder. The name check is case-insensitive, so a file
+        named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
                 :type name: str
                 :param parent: The parent folder to upload the file to
                 :type parent: UploadFileAttributesParentField
@@ -140,7 +143,10 @@ def __init__(
         **kwargs
     ):
         """
-                :param name: The name of the file
+                :param name: The name of the file.
+
+        File names must be unique within their parent folder. The name check is case-insensitive, so a file
+        named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
                 :type name: str
                 :param parent: The parent folder to upload the file to
                 :type parent: UploadWithPreflightCheckAttributesParentField

docs/files.md

@@ -72,7 +72,7 @@ client.files.update_file_by_id(
 - file_id `str`
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - name `Optional[str]`
-  - An optional different name for the file. This can be used to rename the file.
+  - An optional different name for the file. This can be used to rename the file. File names must be unique within their parent folder. The name check is case-insensitive, so a file named `New File` cannot be created in a parent folder that already contains a folder named `new file`.
 - description `Optional[str]`
   - The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.
 - parent `Optional[UpdateFileByIdParent]`

docs/folders.md

@@ -91,7 +91,7 @@ client.folders.update_folder_by_id(
 - folder_id `str`
   - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345"
 - name `Optional[str]`
-  - The optional new name for this folder.
+  - The optional new name for this folder. The following restrictions to folder names apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed. Folder names must be unique within their parent folder. The name check is case-insensitive, so a folder named `New Folder` cannot be created in a parent folder that already contains a folder named `new folder`.
 - description `Optional[str]`
   - The optional description of this folder
 - sync_state `Optional[UpdateFolderByIdSyncState]`
@@ -234,7 +234,7 @@ client.folders.create_folder(new_folder_name, CreateFolderParent(id="0"))
 ### Arguments
 
 - name `str`
-  - The name for the new folder. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), as well as names with trailing spaces are prohibited. Additionally, the names `.` and `..` are not allowed either.
+  - The name for the new folder. The following restrictions to folder names apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed. Folder names must be unique within their parent folder. The name check is case-insensitive, so a folder named `New Folder` cannot be created in a parent folder that already contains a folder named `new folder`.
 - parent `CreateFolderParent`
   - The parent folder to create the new folder within.
 - folder_upload_email `Optional[CreateFolderFolderUploadEmail]`