Skip to content

Commit 0b1367d

Browse files
committed
Regenerate for the backup and delete-graph docs
1 parent f98eed5 commit 0b1367d

4 files changed

Lines changed: 34 additions & 26 deletions

File tree

‎robosystems_client/api/backup/get_backup_download_url.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ def sync_detailed(
8888
"""Get temporary download URL for backup
8989
9090
Generate a temporary download URL for a backup. The filename carries the extension listed as
91-
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
92-
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
91+
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
92+
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
9393
file; decompress it with `zstd -d`.
9494
9595
Args:
@@ -128,8 +128,8 @@ def sync(
128128
"""Get temporary download URL for backup
129129
130130
Generate a temporary download URL for a backup. The filename carries the extension listed as
131-
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
132-
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
131+
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
132+
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
133133
file; decompress it with `zstd -d`.
134134
135135
Args:
@@ -163,8 +163,8 @@ async def asyncio_detailed(
163163
"""Get temporary download URL for backup
164164
165165
Generate a temporary download URL for a backup. The filename carries the extension listed as
166-
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
167-
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
166+
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
167+
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
168168
file; decompress it with `zstd -d`.
169169
170170
Args:
@@ -201,8 +201,8 @@ async def asyncio(
201201
"""Get temporary download URL for backup
202202
203203
Generate a temporary download URL for a backup. The filename carries the extension listed as
204-
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
205-
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
204+
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
205+
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
206206
file; decompress it with `zstd -d`.
207207
208208
Args:

‎robosystems_client/api/graph_operations/delete_graph.py‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,12 @@ def sync_detailed(
115115
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
116116
graph usable through the current billing period and tear it down at the period boundary via the
117117
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
118-
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
119-
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
120-
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
121-
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
118+
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
119+
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
120+
lands on the organization's account balance at once and is applied to its next invoice, so a graph
121+
created right after is charged the difference; on an invoiced plan it is a credit line on that
122+
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
123+
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
122124
(operational authority). Not allowed on shared repositories.
123125
124126
**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
@@ -180,10 +182,12 @@ def sync(
180182
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
181183
graph usable through the current billing period and tear it down at the period boundary via the
182184
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
183-
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
184-
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
185-
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
186-
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
185+
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
186+
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
187+
lands on the organization's account balance at once and is applied to its next invoice, so a graph
188+
created right after is charged the difference; on an invoiced plan it is a credit line on that
189+
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
190+
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
187191
(operational authority). Not allowed on shared repositories.
188192
189193
**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
@@ -240,10 +244,12 @@ async def asyncio_detailed(
240244
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
241245
graph usable through the current billing period and tear it down at the period boundary via the
242246
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
243-
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
244-
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
245-
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
246-
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
247+
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
248+
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
249+
lands on the organization's account balance at once and is applied to its next invoice, so a graph
250+
created right after is charged the difference; on an invoiced plan it is a credit line on that
251+
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
252+
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
247253
(operational authority). Not allowed on shared repositories.
248254
249255
**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
@@ -303,10 +309,12 @@ async def asyncio(
303309
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
304310
graph usable through the current billing period and tear it down at the period boundary via the
305311
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
306-
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
307-
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
308-
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
309-
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
312+
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
313+
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
314+
lands on the organization's account balance at once and is applied to its next invoice, so a graph
315+
created right after is charged the difference; on an invoiced plan it is a credit line on that
316+
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
317+
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
310318
(operational authority). Not allowed on shared repositories.
311319
312320
**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours

‎robosystems_client/models/backup_create_request.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class BackupCreateRequest:
1515
"""Request model for creating a backup.
1616
1717
Attributes:
18-
backup_format (str | Unset): Backup format - only 'full_dump' is supported (complete .lbug database file)
18+
backup_format (str | Unset): Backup format - only 'full_dump' is supported (complete .lbdb database file)
1919
Default: 'full_dump'.
2020
backup_type (str | Unset): Backup type - only 'full' is supported Default: 'full'.
2121
retention_days (int | Unset): Retention period in days, further capped to the graph tier's maximum (7/30/90). 90

‎robosystems_client/models/backup_response.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class BackupResponse:
3838
backups taken before memory was included, which make no claim either way — distinct from false, which means the
3939
graph had none.
4040
download_extension (None | str | Unset): Extension the download will carry, and therefore how to unpack it:
41-
'.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null only
41+
'.lbdb.zip' is a ZIP holding the LadybugDB database file, '.lbdb.zst' is zstd-compressed (`zstd -d`). Null only
4242
when the backup has no stored object yet.
4343
"""
4444

0 commit comments

Comments
 (0)