Skip to content

Docs: Restore API reference metadata and add Nimbus playground - #359

Merged
Blargian merged 1 commit into
mainfrom
codex/nimbus-api-reference-audit
Sep 21, 2026
Merged

Blargian merged 1 commit into
mainfrom
codex/nimbus-api-reference-audit

Conversation

@dhtclk

@dhtclk dhtclk commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Nimbus API pages were missing production metadata and a usable in-page request playground. Restore OpenAPI-derived permission descriptions and sidebar beta/deprecation badges, hide prose-specific page actions, and retain the Nimbus reference alongside a modal API playground.

The playground supports endpoint selection, authentication, parameters, schema-driven body fields and independent JSON drafts, request samples, response examples, and actual response body/headers with copy and download controls. It reuses shared button/card styles and Nimbus-generated examples. Initialization failures display an error and Retry action.

Validation: Astro check passed across 625 files (0 errors, 0 warnings); all 7 request-model tests passed. Local desktop checks covered endpoint and schema-variant switching, array controls, invalid JSON handling, modal state preservation, keyboard response tabs, Escape/focus return, and highlighted samples. No live API requests were sent in the final audit. Initialization failure recovery and response downloads still need end-to-end verification in the deployed preview.

Known limitations: unfinished nested JSON drafts are discarded when switching editor modes; malformed JSON responses currently surface a parse error without retaining the HTTP response display. Mobile behavior and full authenticated request/cancellation flows were not covered by the final audit.

Changelog category (leave one):

  • Improvement

Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):

Restore Cloud API reference permissions and status badges and add an interactive Nimbus API playground.

@github-actions

github-actions Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

🕵

Preview Deployment Components Updated (UTC)
Docs preview 🟢 Ready English: 🟢 Ready; translations: Production fallback 2026-09-17 20:45 UTC

@dhtclk
dhtclk requested a review from Blargian September 17, 2026 20:41

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using high effort and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ce67821. Configure here.

(e as Error).name === "AbortError"
? "Request cancelled."
: (e as Error).message,
);

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Malformed JSON hides response details

Medium Severity

Pretty-printing runs JSON.parse on any JSON content type and an invalid body throws before setResponse. The catch path only stores an error, so status, headers, and the raw payload never appear after a completed HTTP response.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce67821. Configure here.

} finally {
setSending(false);
abort.current = null;
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Form resubmits during active request

Medium Severity

send does not ignore an in-flight request. Submitting the form again, including with Enter, starts a second fetch and replaces the abort controller. The first request’s finally then clears sending and abort, so Cancel no longer stops the live call.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce67821. Configure here.

@Blargian
Blargian merged commit 2820020 into main Sep 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants