docs: docs: Proper description format (box/box-openapi#530)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "f5a9cc9", "specHash": "630fc85", "version": "0.7.0" }
+{ "engineHash": "f5a9cc9", "specHash": "4beed7d", "version": "0.7.0" }

docs/ai.md

@@ -67,7 +67,7 @@ A successful response including the answer from the LLM.
 
 ## Get AI agent default configuration
 
-Get the AI agent default config
+Get the AI agent default config.
 
 This operation is performed by calling function `getAiAgentDefaultConfig`.
 

docs/avatars.md

@@ -64,8 +64,8 @@ client.getAvatars().createUserAvatar(user.getId(), new CreateUserAvatarRequestBo
 
 This function returns a value of type `UserAvatar`.
 
-* `ok`: Returns the `pic_urls` object with URLs to existing
-user avatars that were updated.* `created`: Returns the `pic_urls` object with URLS to user avatars
+`ok`: Returns the `pic_urls` object with URLs to existing
+user avatars that were updated.`created`: Returns the `pic_urls` object with URLS to user avatars
 uploaded to Box with the request.
 
 
@@ -96,6 +96,6 @@ client.getAvatars().deleteUserAvatar(user.getId())
 
 This function returns a value of type `void`.
 
-* `no_content`: Removes the avatar and returns an empty response.
+`no_content`: Removes the avatar and returns an empty response.
 
 

docs/collections.md

@@ -31,7 +31,7 @@ See the endpoint docs at
 
 This function returns a value of type `Collections`.
 
-Returns all collections for the given user
+Returns all collections for the given user.
 
 
 ## List collection items

docs/devicepinners.md

@@ -22,7 +22,7 @@ client.getDevicePinners().getDevicePinnerById(devicePinnerId)
 ### Arguments
 
 - devicePinnerId `String`
-  - The ID of the device pin Example: "2324234"
+  - The ID of the device pin. Example: "2324234"
 - headers `GetDevicePinnerByIdHeaders`
   - Headers of getDevicePinnerById method
 
@@ -51,7 +51,7 @@ client.getDevicePinners().deleteDevicePinnerById(devicePinnerId)
 ### Arguments
 
 - devicePinnerId `String`
-  - The ID of the device pin Example: "2324234"
+  - The ID of the device pin. Example: "2324234"
 - headers `DeleteDevicePinnerByIdHeaders`
   - Headers of deleteDevicePinnerById method
 
@@ -83,7 +83,7 @@ client.getDevicePinners().getEnterpriseDevicePinners(enterpriseId)
 ### Arguments
 
 - enterpriseId `String`
-  - The ID of the enterprise Example: "3442311"
+  - The ID of the enterprise. Example: "3442311"
 - queryParams `GetEnterpriseDevicePinnersQueryParams`
   - Query parameters of getEnterpriseDevicePinners method
 - headers `GetEnterpriseDevicePinnersHeaders`

docs/docgen.md

@@ -66,7 +66,7 @@ A list of Box Doc Gen jobs.
 
 ## Get Box Doc Gen jobs by batch ID
 
-Lists Box Doc Gen jobs in a batch
+Lists Box Doc Gen jobs in a batch.
 
 This operation is performed by calling function `getDocgenBatchJobByIdV2025R0`.
 

docs/docgentemplate.md

@@ -68,7 +68,7 @@ Returns a collection of templates.
 
 ## Delete Box Doc Gen template
 
-Unmarks file as Box Doc Gen template
+Unmarks file as Box Doc Gen template.
 
 This operation is performed by calling function `deleteDocgenTemplateByIdV2025R0`.
 

docs/filemetadata.md

@@ -59,9 +59,9 @@ client.getFileMetadata().getFileMetadataById(file.getId(), GetFileMetadataByIdSc
 - fileId `String`
   - 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"
 - scope `GetFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `String`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - headers `GetFileMetadataByIdHeaders`
   - Headers of getFileMetadataById method
 
@@ -98,9 +98,9 @@ client.getFileMetadata().createFileMetadataById(file.getId(), CreateFileMetadata
 - fileId `String`
   - 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"
 - scope `CreateFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `String`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - requestBody `Map<String, Object>`
   - Request body of createFileMetadataById method
 - headers `CreateFileMetadataByIdHeaders`
@@ -138,9 +138,9 @@ See the endpoint docs at
 - fileId `String`
   - 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"
 - scope `UpdateFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `String`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - requestBody `List<UpdateFileMetadataByIdRequestBody>`
   - Request body of updateFileMetadataById method
 - headers `UpdateFileMetadataByIdHeaders`
@@ -174,9 +174,9 @@ client.getFileMetadata().deleteFileMetadataById(file.getId(), DeleteFileMetadata
 - fileId `String`
   - 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"
 - scope `DeleteFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `String`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - headers `DeleteFileMetadataByIdHeaders`
   - Headers of deleteFileMetadataById method
 

docs/files.md

@@ -171,7 +171,7 @@ client.getFiles().getFileThumbnailUrl(thumbnailFile.getId(), GetFileThumbnailUrl
 - fileId `String`
   - 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"
 - extension `GetFileThumbnailUrlExtension`
-  - The file format for the thumbnail Example: "png"
+  - The file format for the thumbnail. Example: "png"
 - queryParams `GetFileThumbnailUrlQueryParams`
   - Query parameters of getFileThumbnailById method
 - headers `GetFileThumbnailUrlHeaders`
@@ -221,7 +221,7 @@ client.getFiles().getFileThumbnailById(thumbnailFile.getId(), GetFileThumbnailBy
 - fileId `String`
   - 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"
 - extension `GetFileThumbnailByIdExtension`
-  - The file format for the thumbnail Example: "png"
+  - The file format for the thumbnail. Example: "png"
 - queryParams `GetFileThumbnailByIdQueryParams`
   - Query parameters of getFileThumbnailById method
 - headers `GetFileThumbnailByIdHeaders`

docs/fileversionlegalholds.md

@@ -22,7 +22,7 @@ client.getFileVersionLegalHolds().getFileVersionLegalHoldById(fileVersionLegalHo
 ### Arguments
 
 - fileVersionLegalHoldId `String`
-  - The ID of the file version legal hold Example: "2348213"
+  - The ID of the file version legal hold. Example: "2348213"
 - headers `GetFileVersionLegalHoldByIdHeaders`
   - Headers of getFileVersionLegalHoldById method