Conversation
![chatgpt-codex-connector[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9efad07980
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Deploying qf-api-docs with
|
| Latest commit: |
7fa5796
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3df8854a.qf-api-docs.pages.dev |
| Branch Preview URL: | https://feat-api-demo-panel-refresh.qf-api-docs.pages.dev |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f4276ba8a0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bdf395aa40
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
This PR refreshes the shared Docusaurus OpenAPI ApiDemoPanel (request “try it” UI) by swizzling multiple theme components to present clearer request sections (Environment/Auth/Params) and a more prominent execute control, while adding lightweight regression checks for the overrides.
Changes:
- Added swizzled
ApiDemoPanelUI components (Request/Server/Auth/Params/Execute/etc.) plus shared styling/utilities to improve scanability and UX. - Reworked server selection into an always-visible “Environment” section with a URL preview and server-variable inputs.
- Added
node:testcoverage asserting key headings/labels/CTA text and a few behavioral guardrails.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/api-demo-panel-ui.test.cjs | Adds regression tests that assert the presence of the new headings/labels/CTA and a few key UI behaviors via source inspection. |
| src/theme/ApiDemoPanel/utils.ts | Centralizes label/formatting helpers for auth/server display, plus select option normalization. |
| src/theme/ApiDemoPanel/shared.module.css | Introduces shared styles for the refreshed request panel layout, fields, and primary action presentation. |
| src/theme/ApiDemoPanel/Request/index.tsx | Updates the request panel summary and embeds the primary execute CTA in the summary row. |
| src/theme/ApiDemoPanel/Server/index.tsx | Implements the new “Environment” section with server selection, URL preview, and server variable editors. |
| src/theme/ApiDemoPanel/Authorization/index.tsx | Implements the “Authorization” section with human-readable field labeling and helper text. |
| src/theme/ApiDemoPanel/ParamOptions/index.tsx | Groups params into required vs optional sections, collapses optional by default, and adds array/enum handling UI. |
| src/theme/ApiDemoPanel/ParamOptions/styles.module.css | Adds styles for the optional toggle and array item controls. |
| src/theme/ApiDemoPanel/Execute/index.tsx | Promotes a primary “Send API Request” button and preserves a validation gate to disable execution. |
| src/theme/ApiDemoPanel/SecuritySchemes/index.tsx | Adds an “Authentication Details” disclosure panel for the selected scheme(s). |
| src/theme/ApiDemoPanel/FormItem/index.tsx | Adds a shared field wrapper with label/type/required badge and helper/description text. |
| src/theme/ApiDemoPanel/FormTextInput/index.tsx | Adds a shared text input with consistent styling and placeholder sanitization. |
| src/theme/ApiDemoPanel/FormSelect/index.tsx | Adds a shared select component with normalized options and consistent styling. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7499cf367c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Hooray! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Summary
What Changed
ApiDemoPanelcomponents forRequest,Server,Authorization,ParamOptions,Execute,SecuritySchemes,FormItem,FormTextInput, andFormSelectEdit/Hideinteraction with an always-visibleEnvironmentsection and readable URL previewAccess TokenandClient IDwhile keeping the raw header names visible as helper textEnvironment,Authorization,Required Parameters, andOptional Parameters, with optional parameters collapsed by defaultSend API Requestaction so it reads as the primary CTA while preserving the existing validation gate and request execution behaviornode:testcoverage for the refreshed headings, auth label mapping, and primary execute CTAWhy
The interactive docs were already functional, but the try-it experience still reflected the stock theme behavior:
This change keeps the underlying request-building and execution logic intact while making the docs easier for developers to use.
Impact
Validation
node --test tests\\api-demo-panel-ui.test.cjs tests\\prelive-docs-config.test.cjs tests\\user-related-env-paths.test.cjs tests\\user-related-env-ui.test.cjsNO_UPDATE_NOTIFIER=1 npx docusaurus buildAuthored by Basit Minhas.