Skip to content

refactor: refactor request and response example #1161

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

refactor: refactor request and response example #1161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afaa92a
feat: refactor request and response example
dsuket Jun 11, 2025
084cf87
fix: primitive
dsuket Jun 13, 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
253 changes: 2 additions & 251 deletions packages/docusaurus-plugin-openapi-docs/src/openapi/createRequestExample.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,258 +5,9 @@
* LICENSE file in the root directory of this source tree.
* ========================================================================== */

import chalk from "chalk";
import merge from "lodash/merge";

import { sampleFromSchema } from "./createSchemaExample";
import { SchemaObject } from "./types";
import { mergeAllOf } from "../markdown/createSchema";

interface OASTypeToTypeMap {
string: string;
number: number;
integer: number;
boolean: boolean;
object: any;
array: any[];
null: string | null;
}

type Primitives = {
[OASType in keyof OASTypeToTypeMap]: {
[format: string]: (schema: SchemaObject) => OASTypeToTypeMap[OASType];
};
};

const primitives: Primitives = {
string: {
default: () => "string",
email: () => "[email protected]",
date: () => "2024-07-29",
"date-time": () => "2024-07-29T15:51:28.071Z",
uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
hostname: () => "example.com",
ipv4: () => "198.51.100.42",
ipv6: () => "2001:0db8:5b96:0000:0000:426f:8e17:642a",
},
number: {
default: () => 0,
float: () => 0.0,
},
integer: {
default: () => 0,
},
boolean: {
default: (schema) =>
typeof schema.default === "boolean" ? schema.default : true,
},
object: {},
array: {},
null: {
default: () => "null",
},
};

function sampleRequestFromProp(name: string, prop: any, obj: any): any {
// Handle resolved circular props
if (typeof prop === "object" && Object.keys(prop).length === 0) {
obj[name] = prop;
return obj;
}

// TODO: handle discriminators

if (prop.oneOf) {
obj[name] = sampleRequestFromSchema(prop.oneOf[0]);
} else if (prop.anyOf) {
obj[name] = sampleRequestFromSchema(prop.anyOf[0]);
} else if (prop.allOf) {
const mergedSchemas = mergeAllOf(prop) as SchemaObject;
sampleRequestFromProp(name, mergedSchemas, obj);
} else {
obj[name] = sampleRequestFromSchema(prop);
}
return obj;
}

export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
try {
// deep copy schema before processing
let schemaCopy = JSON.parse(JSON.stringify(schema));
let { type, example, allOf, properties, items, oneOf, anyOf } = schemaCopy;

if (example !== undefined) {
return example;
}

if (oneOf) {
if (properties) {
const combinedSchemas = merge(schemaCopy, oneOf[0]);
delete combinedSchemas.oneOf;
return sampleRequestFromSchema(combinedSchemas);
}
// Just go with first schema
return sampleRequestFromSchema(oneOf[0]);
}

if (anyOf) {
if (properties) {
const combinedSchemas = merge(schemaCopy, anyOf[0]);
delete combinedSchemas.anyOf;
return sampleRequestFromSchema(combinedSchemas);
}
// Just go with first schema
return sampleRequestFromSchema(anyOf[0]);
}

if (allOf) {
const mergedSchemas = mergeAllOf(schemaCopy) as SchemaObject;
if (mergedSchemas.properties) {
for (const [key, value] of Object.entries(mergedSchemas.properties)) {
if ((value.readOnly && value.readOnly === true) || value.deprecated) {
delete mergedSchemas.properties[key];
}
}
}
if (properties) {
const combinedSchemas = merge(schemaCopy, mergedSchemas);
delete combinedSchemas.allOf;
return sampleRequestFromSchema(combinedSchemas);
}
return sampleRequestFromSchema(mergedSchemas);
}

if (!type) {
if (properties) {
type = "object";
} else if (items) {
type = "array";
} else {
return;
}
}

if (type === "object") {
let obj: any = {};
for (let [name, prop] of Object.entries(properties ?? {}) as any) {
if (prop.properties) {
for (const [key, value] of Object.entries(prop.properties) as any) {
if (
(value.readOnly && value.readOnly === true) ||
value.deprecated
) {
delete prop.properties[key];
}
}
}

if (prop.items && prop.items.properties) {
for (const [key, value] of Object.entries(
prop.items.properties
) as any) {
if (
(value.readOnly && value.readOnly === true) ||
value.deprecated
) {
delete prop.items.properties[key];
}
}
}

if (prop.readOnly && prop.readOnly === true) {
continue;
}

if (prop.deprecated) {
continue;
}

// Resolve schema from prop recursively
obj = sampleRequestFromProp(name, prop, obj);
}
return obj;
}

if (type === "array") {
if (Array.isArray(items?.anyOf)) {
return processArrayItems(items, "anyOf");
}

if (Array.isArray(items?.oneOf)) {
return processArrayItems(items, "oneOf");
}

return normalizeArray(sampleRequestFromSchema(items));
}

if (schemaCopy.enum) {
if (schemaCopy.default) {
return schemaCopy.default;
}
return normalizeArray(schemaCopy.enum)[0];
}

if (
(schema.readOnly && schema.readOnly === true) ||
schemaCopy.deprecated
) {
return undefined;
}

return primitive(schemaCopy);
} catch (err) {
console.error(
chalk.yellow("WARNING: failed to create example from schema object:", err)
);
return;
}
return sampleFromSchema(schema, { type: "request" });
};

function primitive(schema: SchemaObject = {}) {
let { type, format } = schema;

if (type === undefined) {
return;
}

let fn = schema.default ? () => schema.default : primitives[type].default;

if (format !== undefined) {
fn = primitives[type][format] || fn;
}

if (fn) {
return fn(schema);
}

return "Unknown Type: " + schema.type;
}

function normalizeArray(arr: any) {
if (Array.isArray(arr)) {
return arr;
}
return [arr];
}

function processArrayItems(
items: SchemaObject,
schemaType: "anyOf" | "oneOf"
): any[] {
const itemsArray = items[schemaType] as SchemaObject[];
return itemsArray.map((item: SchemaObject) => {
// If items has properties, merge them with each item
if (items.properties) {
const combinedSchema = {
...item,
properties: {
...items.properties, // Common properties from parent
...item.properties, // Specific properties from this anyOf/oneOf item
},
};
// Remove anyOf/oneOf to prevent infinite recursion when calling sampleRequestFromSchema
delete combinedSchema[schemaType];
return sampleRequestFromSchema(combinedSchema);
}
return sampleRequestFromSchema(item);
});
}
Loading