Skip to content

Commit 2d88fc8

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

35 files changed

+211
-167
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": "5.2.0" }
1+
{ "engineHash": "c370934", "specHash": "9d069ca", "version": "5.2.0" }

docs/sdkgen/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/sdkgen/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

@@ -41,7 +41,7 @@ Returns a list of archives in the enterprise.
4141

4242
Creates an archive.
4343

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

4646
This operation is performed by calling function `createArchiveV2025R0`.
4747

@@ -72,7 +72,7 @@ Returns a new archive object.
7272

7373
Permanently deletes an archive.
7474

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

7777
This operation is performed by calling function `deleteArchiveByIdV2025R0`.
7878

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

104104
Updates an archive.
105105

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

108108
This operation is performed by calling function `updateArchiveByIdV2025R0`.
109109

docs/sdkgen/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

@@ -173,8 +173,8 @@ Chunk has been uploaded successfully.
173173

174174
Uploads a chunk of a file for an upload session.
175175

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

179179
This operation is performed by calling function `uploadFilePart`.
180180

@@ -209,8 +209,8 @@ Abort an upload session and discard all data uploaded.
209209

210210
This cannot be reversed.
211211

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

215215
This operation is performed by calling function `deleteFileUploadSessionByUrl`.
216216

@@ -244,8 +244,8 @@ Abort an upload session and discard all data uploaded.
244244

245245
This cannot be reversed.
246246

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

250250
This operation is performed by calling function `deleteFileUploadSessionById`.
251251

@@ -277,8 +277,8 @@ successfully aborted.
277277

278278
Return a list of the chunks uploaded to the upload session so far.
279279

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

283283
This operation is performed by calling function `getFileUploadSessionPartsByUrl`.
284284

@@ -311,8 +311,8 @@ Returns a list of parts that have been uploaded.
311311

312312
Return a list of the chunks uploaded to the upload session so far.
313313

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

317317
This operation is performed by calling function `getFileUploadSessionParts`.
318318

@@ -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

@@ -383,8 +383,8 @@ when all chunks have processed.
383383

384384
Close an upload session and create a file from the uploaded chunks.
385385

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

389389
This operation is performed by calling function `createFileUploadSessionCommit`.
390390

docs/sdkgen/downloads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ redirects** setting enabled to automatically
3838
follow HTTP `3xx` responses as redirects. If not, the request
3939
will return `302` instead.
4040
For details, see
41-
the [download file guide](g://downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will
41+
the [download file guide](https://developer.box.com/guides/downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will
4242
be returned indicating the time in seconds after which the file will
4343
be available for the client to download.
4444

@@ -79,7 +79,7 @@ redirects** setting enabled to automatically
7979
follow HTTP `3xx` responses as redirects. If not, the request
8080
will return `302` instead.
8181
For details, see
82-
the [download file guide](g://downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will
82+
the [download file guide](https://developer.box.com/guides/downloads/file#download-url).If the file is not ready to be downloaded yet `Retry-After` header will
8383
be returned indicating the time in seconds after which the file will
8484
be available for the client to download.
8585

docs/sdkgen/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

@@ -43,9 +43,9 @@ Returns a list of all file version retentions for the enterprise.
4343
Returns information about a file version retention.
4444

4545
**Note**:
46-
File retention API is now **deprecated**.
46+
File retention API is now **deprecated**.
4747
To get information about files and file versions under retention,
48-
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.
48+
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.
4949

5050
This operation is performed by calling function `getFileVersionRetentionById`.
5151

docs/sdkgen/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

@@ -51,7 +51,7 @@ If you used query parameters like
5151
the *folder items list* will be affected accordingly.
5252

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

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

docs/sdkgen/trashedfiles.md

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

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

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

docs/sdkgen/trashedfolders.md

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

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

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

docs/sdkgen/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

0 commit comments

Comments
 (0)