docusaurus-plugin-openapi-docs 4.0.1 → 4.2.0

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 (55) hide show
  1. package/README.md +11 -0
  2. package/lib/index.js +4 -0
  3. package/lib/markdown/createCallbackMethodEndpoint.d.ts +1 -0
  4. package/lib/markdown/createCallbackMethodEndpoint.js +21 -0
  5. package/lib/markdown/createCallbacks.js +2 -2
  6. package/lib/markdown/createContactInfo.js +1 -1
  7. package/lib/markdown/createDeprecationNotice.js +5 -6
  8. package/lib/markdown/createMethodEndpoint.js +8 -1
  9. package/lib/markdown/createParamsDetails.d.ts +1 -2
  10. package/lib/markdown/createParamsDetails.js +7 -36
  11. package/lib/markdown/createRequestBodyDetails.d.ts +1 -1
  12. package/lib/markdown/createRequestSchema.d.ts +1 -1
  13. package/lib/markdown/createRequestSchema.js +8 -132
  14. package/lib/markdown/createResponseSchema.d.ts +1 -1
  15. package/lib/markdown/createResponseSchema.js +8 -94
  16. package/lib/markdown/createSchema.d.ts +1 -4
  17. package/lib/markdown/createSchema.js +35 -50
  18. package/lib/markdown/createSchema.test.js +48 -0
  19. package/lib/markdown/createStatusCodes.d.ts +1 -4
  20. package/lib/markdown/createStatusCodes.js +10 -259
  21. package/lib/markdown/index.js +11 -22
  22. package/lib/markdown/utils.d.ts +4 -0
  23. package/lib/openapi/createRequestExample.js +2 -2
  24. package/lib/openapi/createResponseExample.js +2 -2
  25. package/lib/openapi/openapi.js +16 -14
  26. package/lib/openapi/types.d.ts +4 -0
  27. package/lib/openapi/utils/services/OpenAPIParser.js +1 -1
  28. package/lib/options.js +5 -0
  29. package/lib/sidebars/index.js +32 -26
  30. package/lib/types.d.ts +9 -0
  31. package/package.json +7 -7
  32. package/src/index.ts +4 -0
  33. package/src/markdown/__snapshots__/createSchema.test.ts.snap +142 -0
  34. package/src/markdown/createCallbackMethodEndpoint.ts +19 -0
  35. package/src/markdown/createCallbacks.ts +2 -2
  36. package/src/markdown/createContactInfo.ts +1 -1
  37. package/src/markdown/createDeprecationNotice.ts +3 -2
  38. package/src/markdown/createMethodEndpoint.ts +8 -1
  39. package/src/markdown/createParamsDetails.ts +7 -42
  40. package/src/markdown/createRequestSchema.ts +9 -143
  41. package/src/markdown/createResponseSchema.ts +9 -112
  42. package/src/markdown/createSchema.test.ts +64 -0
  43. package/src/markdown/createSchema.ts +30 -50
  44. package/src/markdown/createStatusCodes.ts +9 -268
  45. package/src/markdown/index.ts +11 -22
  46. package/src/markdown/utils.ts +4 -0
  47. package/src/openapi/createRequestExample.ts +2 -5
  48. package/src/openapi/createResponseExample.ts +2 -5
  49. package/src/openapi/openapi.ts +4 -2
  50. package/src/openapi/types.ts +4 -0
  51. package/src/openapi/utils/loadAndResolveSpec.ts +1 -1
  52. package/src/openapi/utils/services/OpenAPIParser.ts +1 -0
  53. package/src/options.ts +6 -0
  54. package/src/sidebars/index.ts +47 -40
  55. package/src/types.ts +11 -0
package/src/types.ts CHANGED
@@ -5,6 +5,7 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  * ========================================================================== */
7
7
 
8
+ import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
8
9
  import type Request from "postman-collection";
9
10
 
10
11
  import {
@@ -57,12 +58,22 @@ export interface MarkdownGenerator {
57
58
  createSchemaPageMD?: (pageData: SchemaPageMetadata) => string;
58
59
  }
59
60
 
61
+ export type ApiDocItemGenerator = (
62
+ item: ApiPageMetadata | SchemaPageMetadata,
63
+ context: { sidebarOptions: SidebarOptions; basePath: string }
64
+ ) => SidebarItemDoc;
65
+
66
+ export interface SidebarGenerators {
67
+ createDocItem?: ApiDocItemGenerator;
68
+ }
69
+
60
70
  export interface SidebarOptions {
61
71
  groupPathsBy?: string;
62
72
  categoryLinkSource?: "info" | "tag" | "auto";
63
73
  customProps?: { [key: string]: unknown };
64
74
  sidebarCollapsible?: boolean;
65
75
  sidebarCollapsed?: boolean;
76
+ sidebarGenerators?: SidebarGenerators;
66
77
  }
67
78
 
68
79
  export interface APIVersionOptions {