Skip to content

Commit 06b6f94

Browse files
committed
docs: Link Archive Developer guide from the endpoint specification (box/box-openapi#545)
1 parent dbb29fd commit 06b6f94

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "f39bd50", "specHash": "9ccadb1", "version": "0.1.0" }
1+
{ "engineHash": "f39bd50", "specHash": "bad862d", "version": "0.1.0" }

box_sdk_gen/managers/archives.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ def get_archives_v2025_r0(
6363
) -> ArchivesV2025R0:
6464
"""
6565
Retrieves archives for an enterprise.
66+
67+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
68+
6669
:param limit: The maximum number of items to return per page., defaults to None
6770
:type limit: Optional[int], optional
6871
:param marker: Defines the position marker at which to begin returning results. This is
@@ -103,6 +106,9 @@ def create_archive_v2025_r0(
103106
) -> ArchiveV2025R0:
104107
"""
105108
Creates an archive.
109+
110+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
111+
106112
:param name: The name of the archive.
107113
:type name: str
108114
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
@@ -139,6 +145,9 @@ def delete_archive_by_id_v2025_r0(
139145
) -> None:
140146
"""
141147
Permanently deletes an archive.
148+
149+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
150+
142151
:param archive_id: The ID of the archive.
143152
Example: "982312"
144153
:type archive_id: str

docs/archives.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
Retrieves archives for an enterprise.
1010

11+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
12+
1113
This operation is performed by calling function `get_archives_v2025_r0`.
1214

1315
See the endpoint docs at
@@ -40,6 +42,8 @@ Returns a list of archives in the enterprise.
4042

4143
Creates an archive.
4244

45+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
46+
4347
This operation is performed by calling function `create_archive_v2025_r0`.
4448

4549
See the endpoint docs at
@@ -70,6 +74,8 @@ Returns a new archive object.
7074

7175
Permanently deletes an archive.
7276

77+
To learn more about the archive APIs, see the [Archive API Guide](g://archives).
78+
7379
This operation is performed by calling function `delete_archive_by_id_v2025_r0`.
7480

7581
See the endpoint docs at

0 commit comments

Comments
 (0)