Skip to content

fix(theme): prefill Send API Request from example fields (#544, #1079) #1476

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

Open
sserrata wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(theme): prefill Send API Request from example fields (#544, #1079) #1476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiItem/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,22 @@ export default function ApiItem(props: Props): JSX.Element {
(param: { in: "path" | "query" | "header" | "cookie" }) => {
const paramType = param.in;
const paramsArray: ParameterObject[] = params[paramType];
const defaultValue = (param as any).schema?.default;
const p = param as any;
// Prefill order: schema.default, then example sources. `default` is
// semantically a server-side fallback, so for required params authors
// typically rely on `example` / `examples`. See #544 and #1079.
const firstNamedExample =
p.examples && typeof p.examples === "object"
? (Object.values(p.examples)[0] as any)?.value
: undefined;
const prefill =
p.schema?.default ??
p.example ??
p.schema?.example ??
firstNamedExample;
const initialized =
defaultValue !== undefined
? ({ ...param, value: defaultValue } as unknown as ParameterObject)
prefill !== undefined
? ({ ...param, value: prefill } as unknown as ParameterObject)
: (param as ParameterObject);
paramsArray?.push(initialized);
}
Expand Down
Loading