Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions api-reference/admins/accounts-with-sandboxes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'List Accounts with Sandboxes'
openapi: 'GET /api/admins/accounts-with-sandboxes'
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

python - <<'PY'
import json
from pathlib import Path

spec = json.loads(Path("api-reference/openapi.json").read_text())
paths = spec.get("paths", {})
target = "/api/admins/accounts-with-sandboxes"

print("target_exists:", target in paths)
print("admin_paths:")
for path, ops in sorted(paths.items()):
    if path.startswith("/api/admins"):
        methods = ", ".join(sorted(k.upper() for k in ops.keys()))
        print(f"  {path}: {methods}")
PY

Repository: recoupable/docs

Length of output: 111


Change the openapi reference to an existing endpoint.

Line 3 references GET /api/admins/accounts-with-sandboxes, which does not exist in api-reference/openapi.json. Only GET /api/admins is defined. This will cause the API reference page to fail to render, breaking the new Admins nav entry.

Either add the GET /api/admins/accounts-with-sandboxes endpoint to the OpenAPI spec or update line 3 to reference GET /api/admins.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@api-reference/admins/accounts-with-sandboxes.mdx` at line 3, The openapi
header in admins/accounts-with-sandboxes.mdx references a non-existent endpoint;
update the frontmatter `openapi` value from "GET
/api/admins/accounts-with-sandboxes" to the existing "GET /api/admins" (or
alternatively add the missing endpoint to api-reference/openapi.json); locate
the `openapi:` line in admins/accounts-with-sandboxes.mdx and replace the path
so it matches the OpenAPI spec (ensure the string exactly matches the entry name
"GET /api/admins").

---
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@
{
"group": "Admins",
"pages": [
"api-reference/admins/check"
"api-reference/admins/check",
"api-reference/admins/accounts-with-sandboxes"
]
},
{
Expand Down