Skip to content

Fix URLs in the archives guide #778

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.

Sign up for GitHub

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

Merged
superojla merged 12 commits into from
Jul 28, 2025
Merged

Fix URLs in the archives guide #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5c2d61e
Create guides for Box Archive APIs
psatala-box Jun 23, 2025
eef2bf3
Fix linter issue
psatala-box Jun 23, 2025
8e47949
Address review comments
psatala-box Jun 24, 2025
3340e20
Update list of supported APIs
psatala-box Jun 24, 2025
6d72996
Add information about contacting customer support
psatala-box Jun 25, 2025
3aece79
Add information about not allowing edits
psatala-box Jun 26, 2025
4eb8155
Address review comments
psatala-box Jun 27, 2025
9f64ff5
Update wording
psatala-box Jun 27, 2025
d91aab4
Apply review comments
psatala-box Jun 30, 2025
117a9bd
Apply review comments
psatala-box Jul 24, 2025
f73c1a0
Fix URLs in the archives guide
psatala-box Jul 25, 2025
7999910
Merge branch 'staging' into ddoc-1320/create-guide-for-archive-apis
psatala-box Jul 25, 2025
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 content/guides/archives/add-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The `id` parameter is the ID of the file/folder you want to add to the archive.
To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body.
This can be either an ID of an archive or the ID of a folder that is inside an archive.

[Create Archive]: e://post-archives
[Create Archive]: https://developer.box.com/reference/v2025.0/post-archives/
[Update file]: e://put-files-id
[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id
[Update folder]: e://put-folders-id
Expand Down
2 changes: 1 addition & 1 deletion content/guides/archives/restore-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To specify the destination, use the `parent.id` [parameter][Update parent id of
This is the ID of a folder (can be owned by any user) where you want to restore the file/folder.

To restore a file/folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the
`parent.user_id` [parameter][Update parent user id of file] in the request body.
`parent.user_id` [parameter][Update parent user id of folder] in the request body.

@psatala-box psatala-box Jul 25, 2025

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small update for consistency - the parent.id parameter links to folder, not file, so changing accordingly


[Update file]: e://put-files-id
[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id
Expand Down
6 changes: 3 additions & 3 deletions content/guides/archives/supported-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ See the table below for the full list of those APIs.
| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. |
| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. |

[Create archive]: e://post-archives
[List archives]: e://get-archives
[Delete archive]: e://delete-archives-id
[Create archive]: https://developer.box.com/reference/v2025.0/post-archives/
[List archives]: https://developer.box.com/reference/v2025.0/get-archives/
[Delete archive]: https://developer.box.com/reference/v2025.0/delete-archives-id/
Comment on lines +50 to +52

@psatala-box psatala-box Jul 25, 2025

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to update all URLs for the new archive endpoints since they are in the 2025.0 version. I'm not sure if the short notations supports that. Can this be achieved this way?

Suggested change
[Create archive]: https://developer.box.com/reference/v2025.0/post-archives/
[List archives]: https://developer.box.com/reference/v2025.0/get-archives/
[Delete archive]: https://developer.box.com/reference/v2025.0/delete-archives-id/
[Create archive]: e://v2025.0/post-archives
[List archives]: e://v2025.0/get-archives
[Delete archive]: e://v2025.0/delete-archives-id

[Update file]: e://put-files-id
[Update folder]: e://put-folders-id
[Upload file]: e://post-files-content
Expand Down
Loading