Skip to content

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

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.

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "20cb559", "specHash": "2da99e0", "version": "1.15.1" }
{ "engineHash": "20cb559", "specHash": "a54170e", "version": "1.15.1" }
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion src/managers/files.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,10 @@ export interface UpdateFileByIdRequestBodyCollectionsField {
export interface UpdateFileByIdRequestBody {
/**
* An optional different name for the file. This can be used to
* rename the file. */
* 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`. */
readonly name?: string;
/**
* The description for a file. This can be seen in the right-hand sidebar panel
Expand Down
22 changes: 16 additions & 6 deletions src/managers/folders.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,16 @@ export interface UpdateFolderByIdRequestBodyCollectionsField {
}
export interface UpdateFolderByIdRequestBody {
/**
* 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`. */
readonly name?: string;
/**
* The optional description of this folder */
Expand Down Expand Up @@ -811,13 +820,14 @@ export interface CreateFolderRequestBody {
/**
* 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`. */
readonly name: string;
/**
* The parent folder to create the new folder within. */
Expand Down
10 changes: 8 additions & 2 deletions src/managers/uploads.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,10 @@ export interface UploadFileRequestBodyAttributesParentField {
}
export interface UploadFileRequestBodyAttributesField {
/**
* The name of the file */
* 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`. */
readonly name: string;
/**
* The parent folder to upload the file to */
Expand Down Expand Up @@ -396,7 +399,10 @@ export interface UploadWithPreflightCheckRequestBodyAttributesParentField {
}
export interface UploadWithPreflightCheckRequestBodyAttributesField {
/**
* The name of the file */
* 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`. */
readonly name: string;
/**
* The parent folder to upload the file to */
Expand Down