Skip to content

Commit fa88070

Browse files
box-sdk-buildbox-sdk-build
andauthored
docs(boxsdkgen): replace internal links with absolute links (box/box-openapi#570) (#1272)
Co-authored-by: box-sdk-build <[email protected]>
1 parent e4be5a8 commit fa88070

29 files changed

+101
-101
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "c370934", "specHash": "1e0848d", "version": "4.2.0" }
1+
{ "engineHash": "c370934", "specHash": "9d069ca", "version": "4.2.0" }

docs/sdk-gen/ai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,11 @@ A response including the answer from the LLM.
136136
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
137137

138138
To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
139-
or use the [metadata template API](g://metadata/templates/create).
139+
or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create).
140140

141-
This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
141+
This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).
142142

143-
For information about supported file formats and languages, see the [Extract metadata from file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
143+
For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.
144144

145145
This operation is performed by calling function `createAiExtractStructured`.
146146

docs/sdk-gen/archives.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Retrieves archives for an enterprise.
1212

13-
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
13+
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
1414

1515
This operation is performed by calling function `getArchivesV2025R0`.
1616

@@ -43,7 +43,7 @@ Returns a list of archives in the enterprise.
4343

4444
Creates an archive.
4545

46-
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
46+
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
4747

4848
This operation is performed by calling function `createArchiveV2025R0`.
4949

@@ -74,7 +74,7 @@ Returns a new archive object.
7474

7575
Permanently deletes an archive.
7676

77-
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
77+
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
7878

7979
This operation is performed by calling function `deleteArchiveByIdV2025R0`.
8080

@@ -105,7 +105,7 @@ Returns an empty response when the archive has been deleted.
105105

106106
Updates an archive.
107107

108-
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
108+
To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
109109

110110
This operation is performed by calling function `updateArchiveByIdV2025R0`.
111111

docs/sdk-gen/chunkedUploads.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Returns a new upload session.
7777

7878
Return information about an upload session.
7979

80-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.
80+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.
8181

8282
This operation is performed by calling function `getFileUploadSessionByUrl`.
8383

@@ -108,7 +108,7 @@ Returns an upload session object.
108108

109109
Return information about an upload session.
110110

111-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.
111+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.
112112

113113
This operation is performed by calling function `getFileUploadSessionById`.
114114

@@ -139,8 +139,8 @@ Returns an upload session object.
139139

140140
Uploads a chunk of a file for an upload session.
141141

142-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
143-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
142+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
143+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
144144

145145
This operation is performed by calling function `uploadFilePartByUrl`.
146146

@@ -175,8 +175,8 @@ Chunk has been uploaded successfully.
175175

176176
Uploads a chunk of a file for an upload session.
177177

178-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
179-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
178+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
179+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
180180

181181
This operation is performed by calling function `uploadFilePart`.
182182

@@ -213,8 +213,8 @@ Abort an upload session and discard all data uploaded.
213213

214214
This cannot be reversed.
215215

216-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
217-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
216+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
217+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
218218

219219
This operation is performed by calling function `deleteFileUploadSessionByUrl`.
220220

@@ -248,8 +248,8 @@ Abort an upload session and discard all data uploaded.
248248

249249
This cannot be reversed.
250250

251-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
252-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
251+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
252+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
253253

254254
This operation is performed by calling function `deleteFileUploadSessionById`.
255255

@@ -281,8 +281,8 @@ successfully aborted.
281281

282282
Return a list of the chunks uploaded to the upload session so far.
283283

284-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
285-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
284+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
285+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
286286

287287
This operation is performed by calling function `getFileUploadSessionPartsByUrl`.
288288

@@ -313,8 +313,8 @@ Returns a list of parts that have been uploaded.
313313

314314
Return a list of the chunks uploaded to the upload session so far.
315315

316-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
317-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
316+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
317+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
318318

319319
This operation is performed by calling function `getFileUploadSessionParts`.
320320

@@ -345,8 +345,8 @@ Returns a list of parts that have been uploaded.
345345

346346
Close an upload session and create a file from the uploaded chunks.
347347

348-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
349-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
348+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
349+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
350350

351351
This operation is performed by calling function `createFileUploadSessionCommitByUrl`.
352352

@@ -385,8 +385,8 @@ when all chunks have processed.
385385

386386
Close an upload session and create a file from the uploaded chunks.
387387

388-
The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
389-
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
388+
The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions)
389+
and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.
390390

391391
This operation is performed by calling function `createFileUploadSessionCommit`.
392392

docs/sdk-gen/fileVersionRetentions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
Retrieves all file version retentions for the given enterprise.
1010

1111
**Note**:
12-
File retention API is now **deprecated**.
12+
File retention API is now **deprecated**.
1313
To get information about files and file versions under retention,
14-
see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
14+
see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
1515

1616
This operation is performed by calling function `getFileVersionRetentions`.
1717

@@ -45,9 +45,9 @@ Returns a list of all file version retentions for the enterprise.
4545
Returns information about a file version retention.
4646

4747
**Note**:
48-
File retention API is now **deprecated**.
48+
File retention API is now **deprecated**.
4949
To get information about files and file versions under retention,
50-
see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
50+
see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
5151

5252
This operation is performed by calling function `getFileVersionRetentionById`.
5353

docs/sdk-gen/folders.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ in the folder.
1616
Passing `sort`, `direction`, `offset`, and `limit`
1717
parameters in query allows you to manage the
1818
list of returned
19-
[folder items](r://folder--full#param-item-collection).
19+
[folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
2020

2121
To fetch more items within the folder, use the
22-
[Get items in a folder](e://get-folders-id-items) endpoint.
22+
[Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
2323

2424
This operation is performed by calling function `getFolderById`.
2525

@@ -49,7 +49,7 @@ If you used query parameters like
4949
the *folder items list* will be affected accordingly.
5050

5151
To fetch more items within the folder, use the
52-
[Get items in a folder](e://get-folders-id-items)) endpoint.
52+
[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.
5353

5454
Not all available fields are returned by default. Use the
5555
[fields](#param-fields) query parameter to explicitly request

docs/sdk-gen/trashedFiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ Please note that only if the file itself has been moved to the
4545
trash can it be retrieved with this API call. If instead one of
4646
its parent folders was moved to the trash, only that folder
4747
can be inspected using the
48-
[`GET /folders/:id/trash`](e://get_folders_id_trash) API.
48+
[`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.
4949

5050
To list all items that have been moved to the trash, please
51-
use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
51+
use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)
5252
API.
5353

5454
This operation is performed by calling function `getTrashedFileById`.

docs/sdk-gen/trashedFolders.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ Please note that only if the folder itself has been moved to the
5252
trash can it be retrieved with this API call. If instead one of
5353
its parent folders was moved to the trash, only that folder
5454
can be inspected using the
55-
[`GET /folders/:id/trash`](e://get_folders_id_trash) API.
55+
[`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.
5656

5757
To list all items that have been moved to the trash, please
58-
use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
58+
use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)
5959
API.
6060

6161
This operation is performed by calling function `getTrashedFolderById`.

docs/sdk-gen/zipDownloads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ stopped and resumed, instead a new request for a zip archive would need to
6464
be created.
6565

6666
The URL of this endpoint should not be considered as fixed. Instead, use
67-
the [Create zip download](e://post_zip_downloads) API to request to create a
67+
the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a
6868
`zip` archive, and then follow the `download_url` field in the response to
6969
this endpoint.
7070

@@ -105,7 +105,7 @@ Subsequently this endpoint is valid for 12 hours from the start of the
105105
download.
106106

107107
The URL of this endpoint should not be considered as fixed. Instead, use
108-
the [Create zip download](e://post_zip_downloads) API to request to create a
108+
the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a
109109
`zip` archive, and then follow the `status_url` field in the response to
110110
this endpoint.
111111

src/sdk-gen/managers/ai.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,11 +495,11 @@ export class AiManager {
495495
* Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
496496
*
497497
* To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
498-
* or use the [metadata template API](g://metadata/templates/create).
498+
* or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create).
499499
*
500-
* This endpoint also supports [Enhanced Extract Agent](g://box-ai/ai-tutorials/extract-metadata-structured/#enhanced-extract-agent).
500+
* This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).
501501
*
502-
* For information about supported file formats and languages, see the [Extract metadata from file (structured)](g://box-ai/ai-tutorials/extract-metadata-structured) API guide.
502+
* For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.
503503
* @param {AiExtractStructured} requestBody Request body of createAiExtractStructured method
504504
* @param {CreateAiExtractStructuredOptionalsInput} optionalsInput
505505
* @returns {Promise<AiExtractStructuredResponse>}

0 commit comments

Comments
 (0)