@scalar/api-reference 1.5.0 → 1.7.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 (85) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/dist/browser/standalone.js +7 -7
  3. package/dist/components/Anchor/Anchor.vue.d.ts.map +1 -1
  4. package/dist/components/ApiClientModal.vue.d.ts +2 -0
  5. package/dist/components/ApiClientModal.vue.d.ts.map +1 -1
  6. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  7. package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
  8. package/dist/components/ApiReferenceLayout.vue.d.ts +2 -2
  9. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  10. package/dist/components/Badge/Badge.stories.d.ts +8 -0
  11. package/dist/components/Badge/Badge.stories.d.ts.map +1 -0
  12. package/dist/components/Badge/Badge.vue.d.ts +10 -0
  13. package/dist/components/Badge/Badge.vue.d.ts.map +1 -0
  14. package/dist/components/Badge/index.d.ts +2 -0
  15. package/dist/components/Badge/index.d.ts.map +1 -0
  16. package/dist/components/Content/Content.vue.d.ts +2 -2
  17. package/dist/components/Content/Content.vue.d.ts.map +1 -1
  18. package/dist/components/Content/Introduction/DownloadSpec.vue.d.ts.map +1 -1
  19. package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
  20. package/dist/components/Content/MarkdownRenderer.vue.d.ts.map +1 -1
  21. package/dist/components/Content/ReferenceEndpoint/{Copy.vue.d.ts → EndpointDetails.vue.d.ts} +1 -1
  22. package/dist/components/Content/ReferenceEndpoint/EndpointDetails.vue.d.ts.map +1 -0
  23. package/dist/components/Content/ReferenceEndpoint/EndpointDetailsCard.vue.d.ts +17 -0
  24. package/dist/components/Content/ReferenceEndpoint/EndpointDetailsCard.vue.d.ts.map +1 -0
  25. package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
  26. package/dist/components/Content/ReferenceEndpoint/Parameters.vue.d.ts +9 -4
  27. package/dist/components/Content/ReferenceEndpoint/Parameters.vue.d.ts.map +1 -1
  28. package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts.map +1 -1
  29. package/dist/components/Content/ReferenceEndpoint/ReferenceEndpointAccordion.vue.d.ts +19 -0
  30. package/dist/components/Content/ReferenceEndpoint/ReferenceEndpointAccordion.vue.d.ts.map +1 -0
  31. package/dist/components/Content/ReferenceEndpoint/RequestBody.vue.d.ts +9 -2
  32. package/dist/components/Content/ReferenceEndpoint/RequestBody.vue.d.ts.map +1 -1
  33. package/dist/components/Content/ReferenceTag.vue.d.ts +28 -0
  34. package/dist/components/Content/ReferenceTag.vue.d.ts.map +1 -0
  35. package/dist/components/Content/ReferenceTagAccordion.vue.d.ts +28 -0
  36. package/dist/components/Content/ReferenceTagAccordion.vue.d.ts.map +1 -0
  37. package/dist/components/Content/Schema.stories.d.ts.map +1 -1
  38. package/dist/components/Content/SchemaProperty.vue.d.ts.map +1 -1
  39. package/dist/components/Content/ShowMoreButton.vue.d.ts.map +1 -1
  40. package/dist/components/DarkModeIconToggle.vue.d.ts.map +1 -1
  41. package/dist/components/FlowButton.vue.d.ts.map +1 -1
  42. package/dist/components/GettingStarted.vue.d.ts.map +1 -1
  43. package/dist/components/Layouts/BaseLayout.vue.d.ts +18 -0
  44. package/dist/components/Layouts/BaseLayout.vue.d.ts.map +1 -0
  45. package/dist/components/Layouts/index.d.ts +4 -3
  46. package/dist/components/Layouts/index.d.ts.map +1 -1
  47. package/dist/components/ScreenReader.vue.d.ts +37 -0
  48. package/dist/components/ScreenReader.vue.d.ts.map +1 -0
  49. package/dist/components/Section/SectionAccordion.vue.d.ts +25 -0
  50. package/dist/components/{Content/ReferenceEndpoint/Copy.vue.d.ts.map → Section/SectionAccordion.vue.d.ts.map} +1 -1
  51. package/dist/components/Section/SectionContainer.vue.d.ts.map +1 -1
  52. package/dist/components/Section/SectionContainerAccordion.vue.d.ts +11 -0
  53. package/dist/components/Section/SectionContainerAccordion.vue.d.ts.map +1 -0
  54. package/dist/components/Section/index.d.ts +2 -0
  55. package/dist/components/Section/index.d.ts.map +1 -1
  56. package/dist/components/Sidebar.vue.d.ts.map +1 -1
  57. package/dist/components/SidebarElement.vue.d.ts +2 -0
  58. package/dist/components/SidebarElement.vue.d.ts.map +1 -1
  59. package/dist/helpers/getApiClientRequest.d.ts.map +1 -1
  60. package/dist/helpers/getExampleFromSchema.d.ts.map +1 -1
  61. package/dist/helpers/getParametersFromOperation.d.ts +13 -0
  62. package/dist/helpers/getParametersFromOperation.d.ts.map +1 -0
  63. package/dist/helpers/getRequestFromOperation.d.ts.map +1 -1
  64. package/dist/helpers/index.d.ts +2 -1
  65. package/dist/helpers/index.d.ts.map +1 -1
  66. package/dist/helpers/openClientFor.d.ts +3 -0
  67. package/dist/helpers/openClientFor.d.ts.map +1 -0
  68. package/dist/hooks/index.d.ts +1 -0
  69. package/dist/hooks/index.d.ts.map +1 -1
  70. package/dist/hooks/useNavigation.d.ts +1 -0
  71. package/dist/hooks/useNavigation.d.ts.map +1 -1
  72. package/dist/hooks/useParser.d.ts +24 -9
  73. package/dist/hooks/useParser.d.ts.map +1 -1
  74. package/dist/hooks/useResponses.d.ts +11 -0
  75. package/dist/hooks/useResponses.d.ts.map +1 -0
  76. package/dist/{index-1820592b.js → index-0548261f.js} +10909 -10548
  77. package/dist/{index-06c444c3.js → index-99107dc9.js} +173 -170
  78. package/dist/index.d.ts +1 -0
  79. package/dist/index.d.ts.map +1 -1
  80. package/dist/index.js +20 -14
  81. package/dist/types.d.ts +15 -7
  82. package/dist/types.d.ts.map +1 -1
  83. package/package.json +5 -5
  84. package/dist/helpers/showItemInClient.d.ts +0 -3
  85. package/dist/helpers/showItemInClient.d.ts.map +0 -1
@@ -8,6 +8,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
8
8
  src: string;
9
9
  } | undefined;
10
10
  httpVerb?: string | undefined;
11
+ deprecated?: boolean | undefined;
11
12
  };
12
13
  isActive?: boolean | undefined;
13
14
  hasChildren?: boolean | undefined;
@@ -27,6 +28,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
27
28
  src: string;
28
29
  } | undefined;
29
30
  httpVerb?: string | undefined;
31
+ deprecated?: boolean | undefined;
30
32
  };
31
33
  isActive?: boolean | undefined;
32
34
  hasChildren?: boolean | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"SidebarElement.vue.d.ts","sourceRoot":"","sources":["../../src/components/SidebarElement.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+VA,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"SidebarElement.vue.d.ts","sourceRoot":"","sources":["../../src/components/SidebarElement.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoWA,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"getApiClientRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/getApiClientRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE7D,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAQjB;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,mBAAmB,EACnB,SAAS,GACV,EAAE;IACD,WAAW,EAAE,WAAW,CAAA;IACxB,mBAAmB,EAAE,mBAAmB,CAAA;IACxC,SAAS,EAAE,oBAAoB,CAAA;CAChC,GAAG,mBAAmB,CAgCtB"}
1
+ {"version":3,"file":"getApiClientRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/getApiClientRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE7D,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACrB,MAAM,UAAU,CAAA;AASjB;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,mBAAmB,EACnB,SAAS,GACV,EAAE;IACD,WAAW,EAAE,WAAW,CAAA;IACxB,mBAAmB,EAAE,mBAAmB,CAAA;IACxC,SAAS,EAAE,oBAAoB,CAAA;CAChC,GAAG,mBAAmB,CAwBtB"}
@@ -1 +1 @@
1
- {"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleFromSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,UACM,MAAM,KACZ,GAyJF,CAAA"}
1
+ {"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleFromSchema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,OAAO,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,UACM,MAAM,KACZ,GAmHF,CAAA"}
@@ -0,0 +1,13 @@
1
+ import type { TransformedOperation } from '../types';
2
+ /**
3
+ * Get the query parameters from an operation.
4
+ *
5
+ * Example: [ { name: 'foobar', value: '' } ]
6
+ */
7
+ export declare function getParametersFromOperation(operation: TransformedOperation, where: 'query' | 'path' | 'header' | 'cookie'): {
8
+ name: string;
9
+ description: string | null;
10
+ value: any;
11
+ required: boolean;
12
+ }[];
13
+ //# sourceMappingURL=getParametersFromOperation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getParametersFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getParametersFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAGpD;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAC/B,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ;;;;;IAmB9C"}
@@ -1 +1 @@
1
- {"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAElB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,KACA,QAAQ,kBAAkB,CAuB5B,CAAA"}
1
+ {"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/helpers/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAElB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,KACA,QAAQ,kBAAkB,CA4B5B,CAAA"}
@@ -7,6 +7,7 @@ export * from './getHeadingsFromMarkdown';
7
7
  export * from './getLowestHeadingLevel';
8
8
  export * from './getModelSectionId';
9
9
  export * from './getOperationSectionId';
10
+ export * from './getParametersFromOperation';
10
11
  export * from './getRequestFromAuthentication';
11
12
  export * from './getRequestFromOperation';
12
13
  export * from './getTagSectionId';
@@ -22,7 +23,7 @@ export * from './objectMerge';
22
23
  export * from './prettyPrintJson';
23
24
  export * from './replaceVariables';
24
25
  export * from './scrollToId';
25
- export * from './showItemInClient';
26
+ export * from './openClientFor';
26
27
  export * from './splitMarkdownInSections';
27
28
  export * from './transformToJson';
28
29
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA"}
@@ -0,0 +1,3 @@
1
+ import type { TransformedOperation } from '../types';
2
+ export declare function openClientFor(operation: TransformedOperation): void;
3
+ //# sourceMappingURL=openClientFor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"openClientFor.d.ts","sourceRoot":"","sources":["../../src/helpers/openClientFor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AASpD,wBAAgB,aAAa,CAAC,SAAS,EAAE,oBAAoB,QAe5D"}
@@ -1,6 +1,7 @@
1
1
  export * from './useDarkModeState';
2
2
  export * from './useNavigation';
3
3
  export * from './useOperation';
4
+ export * from './useResponses';
4
5
  export * from './useParser';
5
6
  export * from './useRefOnMount';
6
7
  export * from './useSpec';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA"}
@@ -7,6 +7,7 @@ export type SidebarEntry = {
7
7
  select?: () => void;
8
8
  httpVerb?: string;
9
9
  show: boolean;
10
+ deprecated?: boolean;
10
11
  };
11
12
  type SidebarIdVisibility = Record<string, boolean>;
12
13
  declare function setItemIdVisibility(id: string, visible: boolean): void;
@@ -1 +1 @@
1
- {"version":3,"file":"useNavigation.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavigation.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,UAAU,CAAA;AAE/D,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAMD,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIlD,iBAAS,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,QAExD;AAKD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAqHD,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE;;;;;;;;EAiD3D"}
1
+ {"version":3,"file":"useNavigation.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavigation.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,UAAU,CAAA;AAE/D,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAMD,KAAK,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIlD,iBAAS,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,QAExD;AAKD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAuHD,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE;;;;;;;;EAiD3D"}
@@ -13,22 +13,29 @@ export declare function useParser({ input, }: {
13
13
  operations: {
14
14
  httpVerb: string;
15
15
  path: string;
16
- operationId: string;
17
- name: string;
18
- description: string;
19
- information: {
16
+ operationId?: string | undefined;
17
+ name?: string | undefined;
18
+ description?: string | undefined;
19
+ information?: {
20
20
  description?: string | undefined;
21
21
  operationId?: string | number | undefined;
22
22
  parameters?: {
23
- description?: string | undefined;
24
- in?: string | undefined;
25
23
  name: string;
24
+ in?: string | undefined;
25
+ description?: string | undefined;
26
26
  required?: boolean | undefined;
27
+ deprecated?: boolean | undefined;
28
+ allowEmptyValue?: boolean | undefined;
29
+ style?: "form" | "simple" | undefined;
30
+ explode?: boolean | undefined;
31
+ allowReserved?: boolean | undefined;
27
32
  schema?: {
28
33
  format: string;
29
34
  type: string;
30
35
  default?: any;
31
36
  } | undefined;
37
+ example?: any;
38
+ examples?: Map<string, any> | undefined;
32
39
  }[] | undefined;
33
40
  responses?: Record<string, import("../types").Response> | undefined;
34
41
  security?: import("openapi-types").OpenAPIV3.SecurityRequirementObject[] | undefined;
@@ -77,17 +84,25 @@ export declare function useParser({ input, }: {
77
84
  } | undefined;
78
85
  summary?: string | undefined;
79
86
  tags?: string[] | undefined;
80
- };
87
+ deprecated?: boolean | undefined;
88
+ } | undefined;
81
89
  pathParameters?: {
82
- description?: string | undefined;
83
- in?: string | undefined;
84
90
  name: string;
91
+ in?: string | undefined;
92
+ description?: string | undefined;
85
93
  required?: boolean | undefined;
94
+ deprecated?: boolean | undefined;
95
+ allowEmptyValue?: boolean | undefined;
96
+ style?: "form" | "simple" | undefined;
97
+ explode?: boolean | undefined;
98
+ allowReserved?: boolean | undefined;
86
99
  schema?: {
87
100
  format: string;
88
101
  type: string;
89
102
  default?: any;
90
103
  } | undefined;
104
+ example?: any;
105
+ examples?: Map<string, any> | undefined;
91
106
  }[] | undefined;
92
107
  }[];
93
108
  }[] | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"useParser.d.ts","sourceRoot":"","sources":["../../src/hooks/useParser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAA+B,MAAM,KAAK,CAAA;AAE7E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AA4BpC;;GAEG;AACH,wBAAgB,SAAS,CAAC,EACxB,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA6CwC,IAAI;;EAS5C"}
1
+ {"version":3,"file":"useParser.d.ts","sourceRoot":"","sources":["../../src/hooks/useParser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAA+B,MAAM,KAAK,CAAA;AAE7E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AA4BpC;;GAEG;AACH,wBAAgB,SAAS,CAAC,EACxB,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA6CwC,IAAI;;EAS5C"}
@@ -0,0 +1,11 @@
1
+ import type { TransformedOperation } from '../types';
2
+ /**
3
+ * This hook is used to generate the responses for the request from the parameters in the swagger file
4
+ */
5
+ export declare function useResponses(operation: TransformedOperation): {
6
+ responses: import("vue").ComputedRef<{
7
+ name: string;
8
+ description: string;
9
+ }[]>;
10
+ };
11
+ //# sourceMappingURL=useResponses.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useResponses.d.ts","sourceRoot":"","sources":["../../src/hooks/useResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAEpD;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;cAMrC,MAAM;qBAAe,MAAM;;EAejD"}