Skip to content

Test: auto-generate the Machines API tab (do not merge) #2569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kcmartin wants to merge 2 commits into from
Closed

Test: auto-generate the Machines API tab (do not merge) #2569

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c63292d
Test: auto-generate the Machines API tab from the spec
kcmartin Oct 15, 2026
a430a48
Test: move the spec to its own sidebar group
kcmartin Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 7 additions & 158 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1452,171 +1452,20 @@
},
{
"tab": "Machines API",
"openapi": {
"directory": "api/machines",
"source": "/api/machines/openapi.json"
},
"pages": [
{
"group": "Machines API",
"pages": [
"api/machines/index",
{
"group": "Apps",
"icon": "grid-2",
"pages": [
"GET /v1/apps",
"POST /v1/apps",
"GET /v1/apps/{app_name}",
"DELETE /v1/apps/{app_name}",
"POST /v1/apps/{app_name}/deploy_token",
"GET /v1/apps/{app_name}/ip_assignments",
"POST /v1/apps/{app_name}/ip_assignments",
"DELETE /v1/apps/{app_name}/ip_assignments/{ip}"
]
},
{
"group": "Machines",
"icon": "server",
"pages": [
"GET /v1/apps/{app_name}/machines",
"POST /v1/apps/{app_name}/machines",
"GET /v1/apps/{app_name}/machines/{machine_id}",
"POST /v1/apps/{app_name}/machines/{machine_id}",
"DELETE /v1/apps/{app_name}/machines/{machine_id}",
"POST /v1/apps/{app_name}/machines/{machine_id}/cordon",
"GET /v1/apps/{app_name}/machines/{machine_id}/events",
"POST /v1/apps/{app_name}/machines/{machine_id}/exec",
"GET /v1/apps/{app_name}/machines/{machine_id}/lease",
"POST /v1/apps/{app_name}/machines/{machine_id}/lease",
"DELETE /v1/apps/{app_name}/machines/{machine_id}/lease",
"GET /v1/apps/{app_name}/machines/{machine_id}/memory",
"PUT /v1/apps/{app_name}/machines/{machine_id}/memory",
"POST /v1/apps/{app_name}/machines/{machine_id}/memory/reclaim",
"GET /v1/apps/{app_name}/machines/{machine_id}/metadata",
"PUT /v1/apps/{app_name}/machines/{machine_id}/metadata",
"PATCH /v1/apps/{app_name}/machines/{machine_id}/metadata",
"GET /v1/apps/{app_name}/machines/{machine_id}/metadata/{key}",
"POST /v1/apps/{app_name}/machines/{machine_id}/metadata/{key}",
"DELETE /v1/apps/{app_name}/machines/{machine_id}/metadata/{key}",
"GET /v1/apps/{app_name}/machines/{machine_id}/ps",
"POST /v1/apps/{app_name}/machines/{machine_id}/restart",
"POST /v1/apps/{app_name}/machines/{machine_id}/signal",
"POST /v1/apps/{app_name}/machines/{machine_id}/start",
"POST /v1/apps/{app_name}/machines/{machine_id}/stop",
"POST /v1/apps/{app_name}/machines/{machine_id}/suspend",
"POST /v1/apps/{app_name}/machines/{machine_id}/uncordon",
"GET /v1/apps/{app_name}/machines/{machine_id}/versions",
"GET /v1/apps/{app_name}/machines/{machine_id}/wait"
]
},
{
"group": "Volumes",
"icon": "hard-drive",
"pages": [
"GET /v1/apps/{app_name}/volumes",
"POST /v1/apps/{app_name}/volumes",
"GET /v1/apps/{app_name}/volumes/{volume_id}",
"PUT /v1/apps/{app_name}/volumes/{volume_id}",
"DELETE /v1/apps/{app_name}/volumes/{volume_id}",
"PUT /v1/apps/{app_name}/volumes/{volume_id}/extend",
"GET /v1/apps/{app_name}/volumes/{volume_id}/snapshots",
"POST /v1/apps/{app_name}/volumes/{volume_id}/snapshots"
]
},
{
"group": "Postgres Clusters",
"icon": "database",
"pages": [
"GET /v1/postgres",
"POST /v1/postgres",
"GET /v1/postgres/{postgres_cluster_id}",
"DELETE /v1/postgres/{postgres_cluster_id}",
"POST /v1/postgres/{postgres_cluster_id}/attachments",
"DELETE /v1/postgres/{postgres_cluster_id}/attachments/{app_name}",
"GET /v1/postgres/{postgres_cluster_id}/backups",
"POST /v1/postgres/{postgres_cluster_id}/backups",
"GET /v1/postgres/{postgres_cluster_id}/databases",
"POST /v1/postgres/{postgres_cluster_id}/databases",
"DELETE /v1/postgres/{postgres_cluster_id}/databases/{database_name}",
"GET /v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions",
"POST /v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions",
"DELETE /v1/postgres/{postgres_cluster_id}/databases/{database_name}/extensions/{extension_name}",
"POST /v1/postgres/{postgres_cluster_id}/fork",
"GET /v1/postgres/{postgres_cluster_id}/queries/active",
"GET /v1/postgres/{postgres_cluster_id}/queries/slow",
"POST /v1/postgres/{postgres_cluster_id}/restore",
"GET /v1/postgres/{postgres_cluster_id}/users",
"POST /v1/postgres/{postgres_cluster_id}/users",
"DELETE /v1/postgres/{postgres_cluster_id}/users/{username}",
"PATCH /v1/postgres/{postgres_cluster_id}/users/{username}",
"GET /v1/postgres/{postgres_cluster_id}/users/{username}/credentials",
"POST /v1/postgres/{postgres_cluster_id}/users/{username}/rotate_password"
]
},
{
"group": "Secrets",
"icon": "lock",
"pages": [
"GET /v1/apps/{app_name}/secretkeys",
"GET /v1/apps/{app_name}/secretkeys/{secret_name}",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}",
"DELETE /v1/apps/{app_name}/secretkeys/{secret_name}",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}/decrypt",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}/encrypt",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}/generate",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}/sign",
"POST /v1/apps/{app_name}/secretkeys/{secret_name}/verify",
"GET /v1/apps/{app_name}/secrets",
"POST /v1/apps/{app_name}/secrets",
"GET /v1/apps/{app_name}/secrets/{secret_name}",
"POST /v1/apps/{app_name}/secrets/{secret_name}",
"DELETE /v1/apps/{app_name}/secrets/{secret_name}"
]
},
{
"group": "TLS Certificates",
"icon": "shield-check",
"pages": [
"GET /v1/apps/{app_name}/certificates",
"POST /v1/apps/{app_name}/certificates/acme",
"POST /v1/apps/{app_name}/certificates/custom",
"GET /v1/apps/{app_name}/certificates/{hostname}",
"DELETE /v1/apps/{app_name}/certificates/{hostname}",
"DELETE /v1/apps/{app_name}/certificates/{hostname}/acme",
"POST /v1/apps/{app_name}/certificates/{hostname}/check",
"DELETE /v1/apps/{app_name}/certificates/{hostname}/custom"
]
},
{
"group": "Tokens",
"icon": "key",
"pages": [
"POST /v1/tokens/authenticate",
"POST /v1/tokens/authorize",
"GET /v1/tokens/current",
"POST /v1/tokens/kms",
"POST /v1/tokens/oidc"
]
},
{
"group": "Organizations",
"icon": "building",
"pages": [
"GET /v1/orgs/{org_slug}/machines",
"GET /v1/orgs/{org_slug}/volumes"
]
},
{
"group": "Platform",
"icon": "globe",
"pages": [
"POST /v1/platform/placements",
"GET /v1/platform/regions"
]
},
"api/machines/models"
]
},
{
"group": "Endpoints",
"openapi": {
"directory": "api/machines",
"source": "/api/machines/openapi.json"
}
}
]
},
Expand Down
Loading