Skip to content

Commit c748532

Browse files
committed
Add type for sampleResponses
1 parent 8eb8032 commit c748532

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

  • packages/docusaurus-plugin-openapi-docs/src

packages/docusaurus-plugin-openapi-docs/src/types.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ import {
1616

1717
export type {
1818
PropSidebarItemCategory,
19-
SidebarItemLink,
19+
// SidebarItemLink,
2020
PropSidebar,
2121
PropSidebarItem,
22-
} from "@docusaurus/plugin-content-docs-types";
22+
} from "@docusaurus/plugin-content-docs";
23+
24+
export type { SchemaObject } from "./openapi/types";
2325
export interface PluginOptions {
2426
id?: string;
2527
docsPluginId: string;
@@ -99,6 +101,10 @@ export interface ApiPageMetadata extends ApiMetadataBase {
99101
type: "api";
100102
api: ApiItem;
101103
markdown?: string;
104+
sampleResponses?: null | {
105+
statusCodes: string[];
106+
responseExamples: string; // compressed JSON
107+
};
102108
}
103109

104110
export interface ApiItem extends OperationObject {

0 commit comments

Comments
 (0)