docusaurus-plugin-openapi-docs 1.1.3 → 1.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/lib/markdown/createRequestBodyDetails.d.ts +9 -2
  2. package/lib/markdown/createRequestBodyDetails.js +2 -2
  3. package/lib/markdown/createRequestSchema.d.ts +21 -0
  4. package/lib/markdown/createRequestSchema.js +680 -0
  5. package/lib/markdown/{createSchemaDetails.d.ts → createResponseSchema.d.ts} +2 -2
  6. package/lib/markdown/{createSchemaDetails.js → createResponseSchema.js} +110 -63
  7. package/lib/markdown/createStatusCodes.d.ts +2 -0
  8. package/lib/markdown/createStatusCodes.js +58 -56
  9. package/lib/markdown/index.js +5 -1
  10. package/lib/openapi/createExample.js +27 -14
  11. package/lib/openapi/openapi.d.ts +1 -1
  12. package/lib/openapi/openapi.js +21 -10
  13. package/lib/openapi/types.d.ts +1 -1
  14. package/lib/sidebars/index.d.ts +1 -1
  15. package/lib/sidebars/index.js +11 -3
  16. package/package.json +2 -2
  17. package/src/markdown/createRequestBodyDetails.ts +11 -4
  18. package/src/markdown/createRequestSchema.ts +848 -0
  19. package/src/markdown/{createSchemaDetails.ts → createResponseSchema.ts} +134 -72
  20. package/src/markdown/createStatusCodes.ts +53 -61
  21. package/src/markdown/index.ts +17 -1
  22. package/src/openapi/createExample.ts +31 -14
  23. package/src/openapi/openapi.ts +16 -8
  24. package/src/openapi/types.ts +1 -1
  25. package/src/sidebars/index.ts +13 -5
package/lib/markdown/createRequestBodyDetails.d.ts CHANGED
@@ -1,6 +1,13 @@
1
+ import { MediaTypeObject } from "../openapi/types";
1
2
  interface Props {
2
3
  title: string;
3
- body: any;
4
+ body: {
5
+ content?: {
6
+ [key: string]: MediaTypeObject;
7
+ };
8
+ description?: string;
9
+ required?: boolean;
10
+ };
4
11
  }
5
- export declare function createRequestBodyDetails({ title, body }: Props): string | undefined;
12
+ export declare function createRequestBodyDetails({ title, body }: Props): any;
6
13
  export {};
package/lib/markdown/createRequestBodyDetails.js CHANGED
@@ -7,8 +7,8 @@
7
7
  * ========================================================================== */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.createRequestBodyDetails = void 0;
10
- const createSchemaDetails_1 = require("./createSchemaDetails");
10
+ const createRequestSchema_1 = require("./createRequestSchema");
11
11
  function createRequestBodyDetails({ title, body }) {
12
- return (0, createSchemaDetails_1.createSchemaDetails)({ title, body });
12
+ return (0, createRequestSchema_1.createRequestSchema)({ title, body });
13
13
  }
14
14
  exports.createRequestBodyDetails = createRequestBodyDetails;
package/lib/markdown/createRequestSchema.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ import { MediaTypeObject, SchemaObject } from "../openapi/types";
2
+ /**
3
+ * Returns a merged representation of allOf array of schemas.
4
+ */
5
+ export declare function mergeAllOf(allOf: SchemaObject[]): {
6
+ mergedSchemas: any;
7
+ required: any;
8
+ };
9
+ interface Props {
10
+ style?: any;
11
+ title: string;
12
+ body: {
13
+ content?: {
14
+ [key: string]: MediaTypeObject;
15
+ };
16
+ description?: string;
17
+ required?: string[] | boolean;
18
+ };
19
+ }
20
+ export declare function createRequestSchema({ title, body, ...rest }: Props): string | undefined;
21
+ export {};