@scalar/api-reference 1.13.3 → 1.13.5
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 +30 -0
- package/dist/browser/standalone.js +7 -7
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.d.ts.map +1 -1
- package/dist/components/Content/EndpointsOverview.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Description.vue.d.ts.map +1 -1
- package/dist/components/Content/Models.vue.d.ts.map +1 -1
- package/dist/components/Content/ModelsAccordion.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/EndpointDetails.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ParameterItem.vue.d.ts +19 -3
- package/dist/components/Content/ReferenceEndpoint/ParameterItem.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/Parameters.vue.d.ts +19 -3
- package/dist/components/Content/ReferenceEndpoint/Parameters.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/PathResponses/PathResponses.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpointAccordion.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceTag.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceTagAccordion.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/IntersectionObserver.vue.d.ts.map +1 -1
- package/dist/components/MobileHeader.vue.d.ts.map +1 -1
- package/dist/components/SearchModal.vue.d.ts.map +1 -1
- package/dist/components/Section/Section.vue.d.ts.map +1 -1
- package/dist/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/components/SidebarElement.vue.d.ts +4 -6
- package/dist/components/SidebarElement.vue.d.ts.map +1 -1
- package/dist/helpers/getParametersFromOperation.d.ts +4 -1
- package/dist/helpers/getParametersFromOperation.d.ts.map +1 -1
- package/dist/helpers/getRequestBodyFromOperation.d.ts +86 -0
- package/dist/helpers/getRequestBodyFromOperation.d.ts.map +1 -0
- package/dist/helpers/getRequestFromOperation.d.ts.map +1 -1
- package/dist/helpers/index.d.ts +3 -4
- package/dist/helpers/index.d.ts.map +1 -1
- package/dist/helpers/mergeAllObjects.d.ts +2 -0
- package/dist/helpers/mergeAllObjects.d.ts.map +1 -0
- package/dist/helpers/sleep.d.ts +8 -0
- package/dist/helpers/sleep.d.ts.map +1 -0
- package/dist/helpers/specHelpers.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +2 -1
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/useNavState.d.ts +22 -0
- package/dist/hooks/useNavState.d.ts.map +1 -0
- package/dist/hooks/useOperation.d.ts +2 -0
- package/dist/hooks/useOperation.d.ts.map +1 -1
- package/dist/hooks/useParser.d.ts +33 -30
- package/dist/hooks/useParser.d.ts.map +1 -1
- package/dist/hooks/{useNavigation.d.ts → useSidebar.d.ts} +7 -9
- package/dist/hooks/useSidebar.d.ts.map +1 -0
- package/dist/{index-ccd80c0a.js → index-2d76d450.js} +10906 -10841
- package/dist/{index-227da5ef.js → index-cc881514.js} +3 -3
- package/dist/index.js +41 -42
- package/dist/types.d.ts +19 -20
- package/dist/types.d.ts.map +1 -1
- package/package.json +8 -8
- package/dist/helpers/getHeadingId.d.ts +0 -3
- package/dist/helpers/getHeadingId.d.ts.map +0 -1
- package/dist/helpers/getModelSectionId.d.ts +0 -2
- package/dist/helpers/getModelSectionId.d.ts.map +0 -1
- package/dist/helpers/getOperationSectionId.d.ts +0 -3
- package/dist/helpers/getOperationSectionId.d.ts.map +0 -1
- package/dist/helpers/getTagSectionId.d.ts +0 -3
- package/dist/helpers/getTagSectionId.d.ts.map +0 -1
- package/dist/hooks/useNavigation.d.ts.map +0 -1
|
@@ -30,10 +30,13 @@ export declare function useParser({ input, }: {
|
|
|
30
30
|
explode?: boolean | undefined;
|
|
31
31
|
allowReserved?: boolean | undefined;
|
|
32
32
|
schema?: {
|
|
33
|
-
format: string;
|
|
34
33
|
type: string;
|
|
34
|
+
name?: string | undefined;
|
|
35
|
+
example?: any;
|
|
35
36
|
default?: any;
|
|
37
|
+
format?: string | undefined;
|
|
36
38
|
description?: string | undefined;
|
|
39
|
+
properties?: Record<string, import("../types").Schema> | undefined;
|
|
37
40
|
} | undefined;
|
|
38
41
|
example?: any;
|
|
39
42
|
examples?: Map<string, any> | undefined;
|
|
@@ -41,47 +44,43 @@ export declare function useParser({ input, }: {
|
|
|
41
44
|
responses?: Record<string, import("../types").Response> | undefined;
|
|
42
45
|
security?: import("openapi-types").OpenAPIV3.SecurityRequirementObject[] | undefined;
|
|
43
46
|
requestBody?: {
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
schema: any;
|
|
47
|
+
content?: {
|
|
48
|
+
"application/json"?: {
|
|
49
|
+
schema?: any;
|
|
48
50
|
example?: any;
|
|
49
51
|
examples?: any;
|
|
50
|
-
};
|
|
51
|
-
"application/
|
|
52
|
-
schema
|
|
52
|
+
} | undefined;
|
|
53
|
+
"application/xml"?: {
|
|
54
|
+
schema?: any;
|
|
55
|
+
example?: any;
|
|
56
|
+
examples?: any;
|
|
57
|
+
} | undefined;
|
|
58
|
+
"text/plain"?: {
|
|
59
|
+
schema?: any;
|
|
53
60
|
example?: any;
|
|
54
61
|
examples?: any;
|
|
55
|
-
};
|
|
56
|
-
"
|
|
57
|
-
schema
|
|
62
|
+
} | undefined;
|
|
63
|
+
"text/html"?: {
|
|
64
|
+
schema?: any;
|
|
58
65
|
example?: any;
|
|
59
66
|
examples?: any;
|
|
60
|
-
};
|
|
61
|
-
"
|
|
62
|
-
schema
|
|
67
|
+
} | undefined;
|
|
68
|
+
"application/octet-stream"?: {
|
|
69
|
+
schema?: any;
|
|
63
70
|
example?: any;
|
|
64
71
|
examples?: any;
|
|
65
|
-
};
|
|
66
|
-
"
|
|
67
|
-
schema
|
|
72
|
+
} | undefined;
|
|
73
|
+
"application/x-www-form-urlencoded"?: {
|
|
74
|
+
schema?: any;
|
|
68
75
|
example?: any;
|
|
69
76
|
examples?: any;
|
|
70
|
-
};
|
|
71
|
-
"
|
|
72
|
-
schema: {
|
|
73
|
-
type: string;
|
|
74
|
-
required: string[];
|
|
75
|
-
properties: import("../types").ContentProperties;
|
|
76
|
-
};
|
|
77
|
-
};
|
|
78
|
-
"application/octet-stream": {
|
|
77
|
+
} | undefined;
|
|
78
|
+
"multipart/form-data"?: {
|
|
79
79
|
schema?: any;
|
|
80
80
|
example?: any;
|
|
81
81
|
examples?: any;
|
|
82
|
-
};
|
|
83
|
-
};
|
|
84
|
-
required: boolean;
|
|
82
|
+
} | undefined;
|
|
83
|
+
} | undefined;
|
|
85
84
|
} | undefined;
|
|
86
85
|
summary?: string | undefined;
|
|
87
86
|
tags?: string[] | undefined;
|
|
@@ -98,10 +97,13 @@ export declare function useParser({ input, }: {
|
|
|
98
97
|
explode?: boolean | undefined;
|
|
99
98
|
allowReserved?: boolean | undefined;
|
|
100
99
|
schema?: {
|
|
101
|
-
format: string;
|
|
102
100
|
type: string;
|
|
101
|
+
name?: string | undefined;
|
|
102
|
+
example?: any;
|
|
103
103
|
default?: any;
|
|
104
|
+
format?: string | undefined;
|
|
104
105
|
description?: string | undefined;
|
|
106
|
+
properties?: Record<string, import("../types").Schema> | undefined;
|
|
105
107
|
} | undefined;
|
|
106
108
|
example?: any;
|
|
107
109
|
examples?: Map<string, any> | undefined;
|
|
@@ -122,6 +124,7 @@ export declare function useParser({ input, }: {
|
|
|
122
124
|
version?: string | undefined;
|
|
123
125
|
};
|
|
124
126
|
host?: string | undefined;
|
|
127
|
+
basePath?: string | undefined;
|
|
125
128
|
schemes?: string[] | undefined;
|
|
126
129
|
externalDocs?: {
|
|
127
130
|
description: string;
|
|
@@ -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
|
|
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"}
|
|
@@ -2,28 +2,26 @@ import type { Spec } from '../types';
|
|
|
2
2
|
export type SidebarEntry = {
|
|
3
3
|
id: string;
|
|
4
4
|
title: string;
|
|
5
|
-
type: 'Page' | 'Folder';
|
|
6
5
|
children?: SidebarEntry[];
|
|
7
6
|
select?: () => void;
|
|
8
7
|
httpVerb?: string;
|
|
9
8
|
show: boolean;
|
|
10
9
|
deprecated?: boolean;
|
|
11
10
|
};
|
|
12
|
-
type SidebarIdVisibility = Record<string, boolean>;
|
|
13
|
-
declare function setItemIdVisibility(id: string, visible: boolean): void;
|
|
14
11
|
type CollapsedSidebarItems = Record<string, boolean>;
|
|
15
12
|
declare function toggleCollapsedSidebarItem(key: string): void;
|
|
16
13
|
declare function setCollapsedSidebarItem(key: string, value: boolean): void;
|
|
17
|
-
export declare function
|
|
14
|
+
export declare function useSidebar(options?: {
|
|
18
15
|
parsedSpec: Spec;
|
|
19
16
|
}): {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
17
|
+
breadcrumb: import("vue").ComputedRef<string>;
|
|
18
|
+
items: import("vue").ComputedRef<{
|
|
19
|
+
entries: SidebarEntry[];
|
|
20
|
+
titles: Record<string, string>;
|
|
21
|
+
}>;
|
|
24
22
|
collapsedSidebarItems: CollapsedSidebarItems;
|
|
25
23
|
toggleCollapsedSidebarItem: typeof toggleCollapsedSidebarItem;
|
|
26
24
|
setCollapsedSidebarItem: typeof setCollapsedSidebarItem;
|
|
27
25
|
};
|
|
28
26
|
export {};
|
|
29
|
-
//# sourceMappingURL=
|
|
27
|
+
//# sourceMappingURL=useSidebar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,UAAU,CAAA;AAG/D,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,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;AASD,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;AAmHD,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE;;;;;;;;;EAuCxD"}
|