Skip to content

Commit d8255f8

Browse files
richiemcilroyrichiemcilroy
committed
docs: generate API reference pages and LLM documentation
1 parent 8db8a22 commit d8255f8

32 files changed

Lines changed: 3403 additions & 0 deletions

‎apps/docs/content/docs/api-reference/artifacts/list-artifacts.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: List collected artifacts
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /v1/sandboxes/{id}/artifacts
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/artifacts","method":"get"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/artifacts/register-artifacts.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Register artifact paths
3+
full: true
4+
_openapi:
5+
method: POST
6+
route: /v1/sandboxes/{id}/artifacts
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/artifacts","method":"post"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/exec/exec-command.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Execute a command
3+
description: 'Runs a command in the sandbox. Set `wait: false` for async execution.'
4+
full: true
5+
_openapi:
6+
method: POST
7+
route: /v1/sandboxes/{id}/exec
8+
toc: []
9+
structuredData:
10+
headings: []
11+
contents:
12+
- content: 'Runs a command in the sandbox. Set `wait: false` for async execution.'
13+
---
14+
15+
{/* This file was generated by Fumadocs.
16+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
17+
18+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/exec","method":"post"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/exec/get-exec.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Get exec status
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /v1/sandboxes/{id}/exec/{execId}
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/exec/{execId}","method":"get"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/exec/list-execs.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: List execs
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /v1/sandboxes/{id}/execs
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/execs","method":"get"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/exec/stream-exec-output.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Stream exec output (SSE)
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /v1/sandboxes/{id}/exec/{execId}/stream
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/exec/{execId}/stream","method":"get"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/files/delete-file.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Delete a file
3+
full: true
4+
_openapi:
5+
method: DELETE
6+
route: /v1/sandboxes/{id}/files
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/files","method":"delete"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/files/get-file.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Download or list files
3+
description: >-
4+
Set `list=true` to list directory contents, otherwise downloads the file at
5+
`path`.
6+
full: true
7+
_openapi:
8+
method: GET
9+
route: /v1/sandboxes/{id}/files
10+
toc: []
11+
structuredData:
12+
headings: []
13+
contents:
14+
- content: >-
15+
Set `list=true` to list directory contents, otherwise downloads the
16+
file at `path`.
17+
---
18+
19+
{/* This file was generated by Fumadocs.
20+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
21+
22+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/files","method":"get"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/files/upload-file.mdx‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Upload a file
3+
description: >-
4+
Writes the raw request body to `path`. `batch=true` only increases the size
5+
limit; it does not unpack tarballs or perform directory extraction.
6+
full: true
7+
_openapi:
8+
method: PUT
9+
route: /v1/sandboxes/{id}/files
10+
toc: []
11+
structuredData:
12+
headings: []
13+
contents:
14+
- content: >-
15+
Writes the raw request body to `path`. `batch=true` only increases the
16+
size limit; it does not unpack tarballs or perform directory
17+
extraction.
18+
---
19+
20+
{/* This file was generated by Fumadocs.
21+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
22+
23+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/v1/sandboxes/{id}/files","method":"put"}]} webhooks={[]} hasHead={false} />

‎apps/docs/content/docs/api-reference/health/get-health.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Basic health check
3+
full: true
4+
_openapi:
5+
method: GET
6+
route: /health
7+
toc: []
8+
structuredData:
9+
headings: []
10+
contents: []
11+
---
12+
13+
{/* This file was generated by Fumadocs.
14+
Do not edit this file directly. Any changes should be made by running the generation command again. */}
15+
16+
<APIPage document={"content/docs/api-reference/openapi.json"} operations={[{"path":"/health","method":"get"}]} webhooks={[]} hasHead={false} />

0 commit comments

Comments
 (0)