Skip to content
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

Expand support for nullable objects and default to any for empty/unknown schemas #452

Merged
merged 2 commits into from
Feb 22, 2023
Merged

Expand support for nullable objects and default to any for empty/unknown schemas #452

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
3eb29a4
Expand support for nullable objects and default to any for empty/unkn…
sserrata Feb 22, 2023
316035b
Remove unused var
sserrata Feb 22, 2023
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
102 changes: 81 additions & 21 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,8 @@ function createDetailsNode(
name: string,
schemaName: string,
schema: SchemaObject,
required: string[] | boolean
required: string[] | boolean,
nullable: boolean | unknown
): any {
return create("SchemaItem", {
collapsible: true,
Expand All @@ -451,15 +452,19 @@ function createDetailsNode(
style: { opacity: "0.6" },
children: ` ${schemaName}`,
}),
guard(schema.nullable && schema.nullable === true, () => [
create("strong", {
style: {
fontSize: "var(--ifm-code-font-size)",
color: "var(--openapi-nullable)",
},
children: " nullable",
}),
]),
guard(
(schema.nullable && schema.nullable === true) ||
(nullable && nullable === true),
() => [
create("strong", {
style: {
fontSize: "var(--ifm-code-font-size)",
color: "var(--openapi-nullable)",
},
children: " nullable",
}),
]
),
guard(
Array.isArray(required)
? required.includes(name)
Expand Down Expand Up @@ -604,7 +609,13 @@ function createEdges({
}

if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.allOf !== undefined) {
Expand All @@ -619,20 +630,44 @@ function createEdges({
mergedSchemas.oneOf !== undefined ||
mergedSchemas.anyOf !== undefined
) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.properties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.additionalProperties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

// array of objects
if (mergedSchemas.items?.properties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
Expand All @@ -650,20 +685,44 @@ function createEdges({
}

if (schema.properties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.additionalProperties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

// array of objects
if (schema.items?.properties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.readOnly && schema.readOnly === true) {
Expand Down Expand Up @@ -751,7 +810,7 @@ function createNodes(schema: SchemaObject): any {

// Unknown node/schema type should return undefined
// So far, haven't seen this hit in testing
return undefined;
return "any";
}

interface Props {
Expand Down Expand Up @@ -840,7 +899,8 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
}

const randomFirstKey = Object.keys(body.content)[0];
const firstBody = body.content[randomFirstKey].schema;
const firstBody: any =
body.content[randomFirstKey].schema ?? body.content![randomFirstKey];

if (firstBody === undefined) {
return undefined;
Expand Down
103 changes: 81 additions & 22 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/createResponseSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,8 @@ function createDetailsNode(
name: string,
schemaName: string,
schema: SchemaObject,
required: string[] | boolean
required: string[] | boolean,
nullable: boolean | unknown
): any {
return create("SchemaItem", {
collapsible: true,
Expand All @@ -457,15 +458,19 @@ function createDetailsNode(
style: { opacity: "0.6" },
children: ` ${schemaName}`,
}),
guard(schema.nullable && schema.nullable === true, () => [
create("strong", {
style: {
fontSize: "var(--ifm-code-font-size)",
color: "var(--openapi-nullable)",
},
children: " nullable",
}),
]),
guard(
(schema.nullable && schema.nullable === true) ||
(nullable && nullable === true),
() => [
create("strong", {
style: {
fontSize: "var(--ifm-code-font-size)",
color: "var(--openapi-nullable)",
},
children: " nullable",
}),
]
),
guard(
Array.isArray(required)
? required.includes(name)
Expand Down Expand Up @@ -610,7 +615,13 @@ function createEdges({
}

if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.allOf !== undefined) {
Expand All @@ -625,20 +636,44 @@ function createEdges({
mergedSchemas.oneOf !== undefined ||
mergedSchemas.anyOf !== undefined
) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.properties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.additionalProperties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

// array of objects
if (mergedSchemas.items?.properties !== undefined) {
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
return createDetailsNode(
name,
mergedSchemaName,
mergedSchemas,
required,
schema.nullable
);
}

if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
Expand All @@ -656,20 +691,44 @@ function createEdges({
}

if (schema.properties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.additionalProperties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

// array of objects
if (schema.items?.properties !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.items?.anyOf !== undefined || schema.items?.oneOf !== undefined) {
return createDetailsNode(name, schemaName, schema, required);
return createDetailsNode(
name,
schemaName,
schema,
required,
schema.nullable
);
}

if (schema.writeOnly && schema.writeOnly === true) {
Expand Down Expand Up @@ -702,7 +761,6 @@ function createNodes(schema: SchemaObject): any {

if (schema.allOf !== undefined) {
const { mergedSchemas } = mergeAllOf(schema.allOf);

if (mergedSchemas.properties !== undefined) {
nodes.push(createProperties(mergedSchemas));
}
Expand Down Expand Up @@ -760,7 +818,7 @@ function createNodes(schema: SchemaObject): any {

// Unknown node/schema type should return undefined
// So far, haven't seen this hit in testing
return undefined;
return "any";
}

interface Props {
Expand Down Expand Up @@ -794,7 +852,8 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
children: mimeTypes.map((mimeType: any) => {
const responseExamples = body.content![mimeType].examples;
const responseExample = body.content![mimeType].example;
const firstBody = body.content![mimeType].schema;
const firstBody: any =
body.content![mimeType].schema ?? body.content![mimeType];

if (
firstBody === undefined &&
Expand Down