Skip to content

Support empty object schemas #849

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

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Support empty object schemas #849

Show file tree
Hide file tree
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
6 changes: 0 additions & 6 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 @@ -108,12 +108,6 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
return undefined;
}

// we don't show the table if there is no properties to show
if (firstBody.properties !== undefined) {
if (Object.keys(firstBody.properties).length === 0) {
return undefined;
}
}
return create("MimeTabs", {
className: "openapi-tabs__mime",
children: [
Expand Down
6 changes: 0 additions & 6 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 @@ -60,12 +60,6 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
return undefined;
}

if (firstBody?.properties !== undefined) {
if (Object.keys(firstBody?.properties).length === 0) {
return undefined;
}
}

return create("TabItem", {
label: `${mimeType}`,
value: `${mimeType}`,
Expand Down
10 changes: 10 additions & 0 deletions packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ function createAnyOneOf(schema: SchemaObject): any {
*/
function createProperties(schema: SchemaObject) {
const discriminator = schema.discriminator;
if (Object.keys(schema.properties!).length === 0) {
return create("SchemaItem", {
collapsible: false,
name: "",
required: false,
schemaName: "object",
qualifierMessage: undefined,
schema: {},
});
}
return Object.entries(schema.properties!).map(([key, val]) => {
return createEdges({
name: key,
Expand Down