Skip to content

feat: allow following examples array #1219

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: allow following examples array #1219

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02a8102
feat: allow following examples array
entropitor Aug 25, 2025
bac3099
feat: also support examples for properties
entropitor Aug 25, 2025
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
12 changes: 10 additions & 2 deletions packages/docusaurus-plugin-openapi-docs/src/openapi/createSchemaExample.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,11 @@ function sampleFromProp(

// TODO: handle discriminators

if (prop.oneOf) {
if (prop.example !== undefined) {
obj[name] = prop.example;
} else if (prop.examples !== undefined && prop.examples.length > 0) {
obj[name] = prop.examples[0];
} else if (prop.oneOf) {
obj[name] = sampleFromSchema(prop.oneOf[0], context);
} else if (prop.anyOf) {
obj[name] = sampleFromSchema(prop.anyOf[0], context);
Expand All @@ -111,11 +115,15 @@ export const sampleFromSchema = (
try {
// deep copy schema before processing
let schemaCopy = JSON.parse(JSON.stringify(schema));
let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;
let { type, example, examples, allOf, properties, items, oneOf, anyOf } =
schemaCopy;

if (example !== undefined) {
return example;
}
if (examples !== undefined && examples.length > 0) {
return examples[0];
}

if (oneOf) {
if (properties) {
Expand Down