Skip to content

Commit 8619a8c

Browse files
committed
modified api reference style
1 parent 898f992 commit 8619a8c

File tree

1 file changed

+7
-83
lines changed

1 file changed

+7
-83
lines changed

docs/self-hosting/methods/download-config.md

Lines changed: 7 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -43,59 +43,15 @@ Replace `v2.3.4` with the version you need. See the [releases page](https://plan
4343
- `airgapped-docker-compose-{platform}.yml`
4444
- `variables.env`
4545

46-
---
47-
48-
## API reference
49-
50-
<div class="api-endpoint-badge">
51-
<span class="method get">GET</span>
52-
<span class="path">/api/v2/setup/</span>
53-
</div>
54-
55-
<div class="api-two-column">
56-
<div class="api-left">
57-
58-
**Base URL:** `https://prime.plane.so`
59-
60-
**Authentication:** Not required (public endpoint)
61-
62-
<div class="params-section">
63-
64-
### Query parameters
65-
66-
<div class="params-list">
67-
68-
<ApiParam name="version" type="string" :required="true">
69-
70-
Release tag (e.g., `v2.3.4`).
71-
72-
</ApiParam>
73-
74-
<ApiParam name="airgapped" type="boolean">
75-
76-
Set to `true` for airgapped compose files. Defaults to `false`.
77-
78-
</ApiParam>
79-
80-
<ApiParam name="platform" type="string">
81-
82-
Target architecture: `amd64` or `arm64`. Defaults to `amd64`. Only applies when `airgapped=true`.
46+
## Parameters
8347

84-
</ApiParam>
48+
| Parameter | Required | Default | Description |
49+
|-----------|----------|---------|-------------|
50+
| `version` | Yes || Release tag (e.g., `v2.3.4`) |
51+
| `airgapped` | No | `false` | Set to `true` for airgapped compose files |
52+
| `platform` | No | `amd64` | Target architecture: `amd64` or `arm64`. Only applies when `airgapped=true`. |
8553

86-
</div>
87-
</div>
88-
89-
<div class="params-section">
90-
91-
### Response
92-
93-
**Success (200):** Returns a zip archive containing the config files.
94-
95-
- Content-Type: `application/zip`
96-
- Content-Disposition: `attachment; filename="plane-{version}.zip"`
97-
98-
### Errors
54+
### Error responses
9955

10056
| Status | Cause | Response |
10157
|--------|-------|----------|
@@ -106,35 +62,3 @@ Target architecture: `amd64` or `arm64`. Defaults to `amd64`. Only applies when
10662
| 404 | Config files missing from release | `{"error": "assets not found in release: <filenames>"}` |
10763
| 500 | GitHub API failure | `{"error": "Failed to fetch release information"}` |
10864

109-
</div>
110-
111-
</div>
112-
<div class="api-right">
113-
114-
<CodePanel :languages="['cURL']">
115-
<template #curl>
116-
117-
```bash
118-
# Download standard config files
119-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" \
120-
-o plane.zip
121-
122-
# Download airgapped config (AMD64)
123-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true" \
124-
-o plane.zip
125-
126-
# Download airgapped config (ARM64)
127-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4&airgapped=true&platform=arm64" \
128-
-o plane.zip
129-
130-
# Verify zip contents without extracting
131-
curl "https://prime.plane.so/api/v2/setup/?version=v2.3.4" \
132-
-o plane.zip && unzip -l plane.zip
133-
```
134-
135-
</template>
136-
137-
</CodePanel>
138-
139-
</div>
140-
</div>

0 commit comments

Comments
 (0)