Skip to content

Commit 57c53a6

Browse files
authored
document reserved keywords (#356)
1 parent 02b766b commit 57c53a6

File tree

5 files changed

+7
-175
lines changed

5 files changed

+7
-175
lines changed

docs/production/dbos-cloud/secrets.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ You can create or update a secret using the Cloud CLI:
1515
dbos-cloud app env create -s <secret-name> -v <secret-value>
1616
```
1717

18+
:::info
19+
A few secrets name are reserved and cannot be used. These are `DBOS_DATABASE_URL` and `DBOS_APP_HOSTNAME`.
20+
:::
21+
1822
For example, to create a secret named `API_KEY` with value `abc123`, run:
1923

2024
```

docs/python/reference/client.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -255,8 +255,8 @@ client.list_workflows(
255255
) -> List[WorkflowStatus]:
256256
```
257257

258-
Retrieve a list of [`WorkflowStatus`](#workflow-status) of all workflows matching specified criteria.
259-
Similar to [`DBOS.list_workflows`](./contexts.md#list_workflows).
258+
Retrieve a list of [`WorkflowStatus`](./contexts#workflow-status) of all workflows matching specified criteria.
259+
Similar to [`DBOS.list_workflows`](./contexts#list_workflows).
260260

261261
**Parameters:**
262262
- **workflow_ids**: Retrieve workflows with these IDs.
@@ -306,7 +306,7 @@ client.list_queued_workflows(
306306
) -> List[WorkflowStatus]:
307307
```
308308

309-
Retrieve a list of [`WorkflowStatus`](#workflow-status) of all **currently enqueued** workflows matching specified criteria.
309+
Retrieve a list of [`WorkflowStatus`](./contexts#workflow-status) of all **currently enqueued** workflows matching specified criteria.
310310
Similar to [`DBOS.list_queued_workflows`](./contexts.md#list_queued_workflows).
311311

312312
**Parameters:**

docs/python/reference/dbos-debugger.md

-82
This file was deleted.

docs/typescript/reference/tools/dbos-debugger.md

-82
This file was deleted.

docusaurus.config.js

-8
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,6 @@ const config = {
9090
from: '/typescript/reference/dbos-compiler',
9191
to: '/typescript/reference/tools/dbos-compiler',
9292
},
93-
{
94-
from: '/typescript/reference/time-travel-debugger',
95-
to: '/typescript/reference/tools/dbos-debugger',
96-
},
97-
{
98-
from: '/typescript/reference/tools/time-travel-debugger',
99-
to: '/typescript/reference/tools/dbos-debugger',
100-
},
10193
{
10294
from: '/typescript/reference/dbos-class',
10395
to: '/typescript/reference/transactapi/dbos-class',

0 commit comments

Comments
 (0)