@scalar/api-reference 0.7.7 → 0.7.9
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.
- package/CHANGELOG.md +22 -0
- package/dist/browser/standalone.js +293 -342
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/Copy.vue.d.ts +1 -1
- package/dist/components/Content/ReferenceEndpoint/Copy.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/RequestBodyProperties.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema.vue.d.ts.map +1 -1
- package/dist/components/Content/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/LoadingSkeleton.vue.d.ts.map +1 -1
- package/dist/components/MobileHeader.vue.d.ts.map +1 -1
- package/dist/components/Section/Section.vue.d.ts.map +1 -1
- package/dist/components/Section/SectionColumn.vue.d.ts.map +1 -1
- package/dist/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/helpers/generateParameters.d.ts +7 -0
- package/dist/helpers/generateParameters.d.ts.map +1 -0
- package/dist/helpers/generateRequest.d.ts +8 -0
- package/dist/helpers/generateRequest.d.ts.map +1 -0
- package/dist/helpers/index.d.ts +1 -0
- package/dist/helpers/index.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +1 -0
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/useOperation.d.ts +16 -0
- package/dist/hooks/useOperation.d.ts.map +1 -0
- package/dist/index.js +3615 -3660
- package/package.json +4 -4
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Introduction.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/Introduction.vue.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"Introduction.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/Introduction.vue.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAiVlD,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Copy.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/Copy.vue.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Copy.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/Copy.vue.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AA+J/C,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleRequest.vue.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleRequest.vue.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AA+dvD,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RequestBodyProperties.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/RequestBodyProperties.vue.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"RequestBodyProperties.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/RequestBodyProperties.vue.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAwMvD,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Schema.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/Schema.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"Schema.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/Schema.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AA0LA,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SchemaProperty.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/SchemaProperty.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"SchemaProperty.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/SchemaProperty.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkeA,0BAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"LoadingSkeleton.vue.d.ts","sourceRoot":"","sources":["../../src/components/LoadingSkeleton.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"LoadingSkeleton.vue.d.ts","sourceRoot":"","sources":["../../src/components/LoadingSkeleton.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAuEA,wBAAkD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MobileHeader.vue.d.ts","sourceRoot":"","sources":["../../src/components/MobileHeader.vue.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"MobileHeader.vue.d.ts","sourceRoot":"","sources":["../../src/components/MobileHeader.vue.ts"],"names":[],"mappings":";;;AAiJA,wBAA8G;AAE9G,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":"Section.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/Section.vue.ts"],"names":[],"mappings":";;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"Section.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/Section.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AAkFA,wBAA8G;AAI9G,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":"SectionColumn.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/SectionColumn.vue.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"SectionColumn.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Section/SectionColumn.vue.ts"],"names":[],"mappings":";;;AAiEA,wBAA8G;AAE9G,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":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAa,IAAI,EAAO,MAAM,UAAU,CAAA;;;;;;;;;;;;AA0XpD,wBAAkD"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { BaseParameter } from '@scalar/api-client';
|
|
2
|
+
import type { Parameters } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* Generate parameters for the request from the parameters in the swagger file
|
|
5
|
+
*/
|
|
6
|
+
export declare function generateParameters(parameters: Parameters[]): BaseParameter[];
|
|
7
|
+
//# sourceMappingURL=generateParameters.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateParameters.d.ts","sourceRoot":"","sources":["../../src/helpers/generateParameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,mBAa1D"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { ClientRequestConfig } from '@scalar/api-client';
|
|
2
|
+
import { type ParamMap } from '../hooks';
|
|
3
|
+
import type { Operation, Server } from '../types';
|
|
4
|
+
/**
|
|
5
|
+
* Generate parameters for the request
|
|
6
|
+
*/
|
|
7
|
+
export declare function generateRequest(operation: Operation, parameterMap: ParamMap, server: Server): ClientRequestConfig;
|
|
8
|
+
//# sourceMappingURL=generateRequest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/generateRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE7D,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAIjD;;GAEG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,QAAQ,EACtB,MAAM,EAAE,MAAM,GACb,mBAAmB,CAiCrB"}
|
package/dist/helpers/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,mBAAmB,CAAA;AACjC,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,2BAA2B,CAAA;AACzC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,mBAAmB,CAAA;AACjC,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA"}
|
package/dist/hooks/index.d.ts
CHANGED
|
@@ -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"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Operation, Parameters } from '../types';
|
|
2
|
+
export type ParamMap = {
|
|
3
|
+
path: Parameters[];
|
|
4
|
+
query: Parameters[];
|
|
5
|
+
header: Parameters[];
|
|
6
|
+
};
|
|
7
|
+
export type OperationProps = {
|
|
8
|
+
operation: Operation;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* This hook is used to generate the parameters for the request from the parameters in the swagger file
|
|
12
|
+
*/
|
|
13
|
+
export declare function useOperation(props: OperationProps): {
|
|
14
|
+
parameterMap: import("vue").ComputedRef<ParamMap>;
|
|
15
|
+
};
|
|
16
|
+
//# sourceMappingURL=useOperation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useOperation.d.ts","sourceRoot":"","sources":["../../src/hooks/useOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErD,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,UAAU,EAAE,CAAA;IAClB,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,cAAc;;EAyBjD"}
|