@scalar/api-reference 1.25.17 → 1.25.18
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 +21 -0
- package/dist/browser/standalone.js +15096 -14632
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts +236 -236
- package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts.map +1 -1
- package/dist/features/Search/SearchModal.vue.d.ts.map +1 -1
- package/dist/features/Search/SearchModal.vue.js +2 -2
- package/dist/features/Search/SearchModal.vue2.js +78 -68
- package/dist/hooks/useReactiveSpec.d.ts +117 -117
- package/dist/index.js +1 -1
- package/dist/legacy/helpers/prepareClientRequestConfig.d.ts +4 -4
- package/dist/legacy/stores/useAuthenticationStore.d.ts +2 -2
- package/dist/legacy/stores/useOpenApiStore.d.ts +41 -41
- package/dist/legacy/stores/useOpenApiStore.d.ts.map +1 -1
- package/dist/legacy/stores/useRequestStore.d.ts +14 -14
- package/dist/legacy/stores/useServerStore.d.ts +7 -7
- package/dist/style.css +1 -1
- package/package.json +8 -8
|
@@ -15,10 +15,10 @@ export declare const prepareClientRequestConfig: (configuration: {
|
|
|
15
15
|
type: string;
|
|
16
16
|
path: string;
|
|
17
17
|
variables?: import("@scalar/types/legacy").BaseParameter[];
|
|
18
|
-
query?: import("
|
|
19
|
-
cookies?: import("
|
|
20
|
-
headers?: import("
|
|
18
|
+
query?: import("..").Query[];
|
|
19
|
+
cookies?: import("..").Cookie[];
|
|
20
|
+
headers?: import("..").Header[];
|
|
21
21
|
body?: string;
|
|
22
|
-
formData?: import("
|
|
22
|
+
formData?: import("..").FormDataItem[];
|
|
23
23
|
};
|
|
24
24
|
//# sourceMappingURL=prepareClientRequestConfig.d.ts.map
|
|
@@ -4,7 +4,7 @@ export declare const useAuthenticationStore: () => {
|
|
|
4
4
|
authentication: {
|
|
5
5
|
customSecurity: boolean;
|
|
6
6
|
preferredSecurityScheme: string | null;
|
|
7
|
-
securitySchemes?: import("@scalar/types
|
|
7
|
+
securitySchemes?: import("@scalar/openapi-types").OpenAPIV2.SecurityDefinitionsObject | import("@scalar/openapi-types").OpenAPIV3.ComponentsObject["securitySchemes"] | import("@scalar/openapi-types").OpenAPIV3_1.ComponentsObject["securitySchemes"];
|
|
8
8
|
http: {
|
|
9
9
|
basic: {
|
|
10
10
|
username: string;
|
|
@@ -29,7 +29,7 @@ export declare const useAuthenticationStore: () => {
|
|
|
29
29
|
setAuthentication: (newState: Partial<AuthenticationState>) => {
|
|
30
30
|
customSecurity: boolean;
|
|
31
31
|
preferredSecurityScheme: string | null;
|
|
32
|
-
securitySchemes?: import("@scalar/types
|
|
32
|
+
securitySchemes?: import("@scalar/openapi-types").OpenAPIV2.SecurityDefinitionsObject | import("@scalar/openapi-types").OpenAPIV3.ComponentsObject["securitySchemes"] | import("@scalar/openapi-types").OpenAPIV3_1.ComponentsObject["securitySchemes"];
|
|
33
33
|
http: {
|
|
34
34
|
basic: {
|
|
35
35
|
username: string;
|
|
@@ -10,48 +10,48 @@ export declare const useOpenApiStore: () => {
|
|
|
10
10
|
operation: {
|
|
11
11
|
httpVerb?: "GET" | "POST" | "PUT" | "HEAD" | "DELETE" | "PATCH" | "OPTIONS" | "CONNECT" | "TRACE" | undefined;
|
|
12
12
|
path?: string | undefined;
|
|
13
|
-
operationId?: string;
|
|
14
|
-
name?: string;
|
|
15
|
-
description?: string;
|
|
13
|
+
operationId?: string | undefined;
|
|
14
|
+
name?: string | undefined;
|
|
15
|
+
description?: string | undefined;
|
|
16
16
|
information?: {
|
|
17
|
-
description?: string;
|
|
18
|
-
operationId?: string | number;
|
|
17
|
+
description?: string | undefined;
|
|
18
|
+
operationId?: (string | number) | undefined;
|
|
19
19
|
parameters?: {
|
|
20
20
|
name: string;
|
|
21
|
-
in?: string;
|
|
22
|
-
description?: string;
|
|
23
|
-
required?: boolean;
|
|
24
|
-
deprecated?: boolean;
|
|
25
|
-
allowEmptyValue?: boolean;
|
|
26
|
-
style?: "form" | "simple";
|
|
27
|
-
explode?: boolean;
|
|
28
|
-
allowReserved?: boolean;
|
|
21
|
+
in?: string | undefined;
|
|
22
|
+
description?: string | undefined;
|
|
23
|
+
required?: boolean | undefined;
|
|
24
|
+
deprecated?: boolean | undefined;
|
|
25
|
+
allowEmptyValue?: boolean | undefined;
|
|
26
|
+
style?: ("form" | "simple") | undefined;
|
|
27
|
+
explode?: boolean | undefined;
|
|
28
|
+
allowReserved?: boolean | undefined;
|
|
29
29
|
schema?: {
|
|
30
30
|
type: string;
|
|
31
|
-
name?: string;
|
|
31
|
+
name?: string | undefined;
|
|
32
32
|
example?: any;
|
|
33
33
|
default?: any;
|
|
34
|
-
format?: string;
|
|
35
|
-
description?: string;
|
|
36
|
-
properties?: Record<string, import("@scalar/types/legacy").Schema
|
|
34
|
+
format?: string | undefined;
|
|
35
|
+
description?: string | undefined;
|
|
36
|
+
properties?: Record<string, import("@scalar/types/legacy").Schema> | undefined;
|
|
37
37
|
} | undefined;
|
|
38
38
|
example?: any;
|
|
39
39
|
examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
|
|
40
|
-
content?: import("@scalar/types/legacy").RequestBodyMimeTypes;
|
|
40
|
+
content?: import("@scalar/types/legacy").RequestBodyMimeTypes | undefined;
|
|
41
41
|
headers?: {
|
|
42
42
|
[key: string]: import("@scalar/openapi-types").OpenAPI.HeaderObject;
|
|
43
|
-
};
|
|
43
|
+
} | undefined;
|
|
44
44
|
}[] | undefined;
|
|
45
|
-
responses?: Record<string, import("@scalar/openapi-types").OpenAPI.ResponseObject
|
|
46
|
-
security?: OpenAPIV3.SecurityRequirementObject[];
|
|
45
|
+
responses?: Record<string, import("@scalar/openapi-types").OpenAPI.ResponseObject> | undefined;
|
|
46
|
+
security?: OpenAPIV3.SecurityRequirementObject[] | undefined;
|
|
47
47
|
requestBody?: {
|
|
48
|
-
description?: string;
|
|
49
|
-
required?: boolean;
|
|
50
|
-
content?: import("@scalar/types/legacy").RequestBodyMimeTypes;
|
|
48
|
+
description?: string | undefined;
|
|
49
|
+
required?: boolean | undefined;
|
|
50
|
+
content?: import("@scalar/types/legacy").RequestBodyMimeTypes | undefined;
|
|
51
51
|
} | undefined;
|
|
52
|
-
summary?: string;
|
|
53
|
-
tags?: string[];
|
|
54
|
-
deprecated?: boolean;
|
|
52
|
+
summary?: string | undefined;
|
|
53
|
+
tags?: string[] | undefined;
|
|
54
|
+
deprecated?: boolean | undefined;
|
|
55
55
|
'x-custom-examples'?: {
|
|
56
56
|
lang: string;
|
|
57
57
|
label: string;
|
|
@@ -70,29 +70,29 @@ export declare const useOpenApiStore: () => {
|
|
|
70
70
|
} | undefined;
|
|
71
71
|
pathParameters?: {
|
|
72
72
|
name: string;
|
|
73
|
-
in?: string;
|
|
74
|
-
description?: string;
|
|
75
|
-
required?: boolean;
|
|
76
|
-
deprecated?: boolean;
|
|
77
|
-
allowEmptyValue?: boolean;
|
|
78
|
-
style?: "form" | "simple";
|
|
79
|
-
explode?: boolean;
|
|
80
|
-
allowReserved?: boolean;
|
|
73
|
+
in?: string | undefined;
|
|
74
|
+
description?: string | undefined;
|
|
75
|
+
required?: boolean | undefined;
|
|
76
|
+
deprecated?: boolean | undefined;
|
|
77
|
+
allowEmptyValue?: boolean | undefined;
|
|
78
|
+
style?: ("form" | "simple") | undefined;
|
|
79
|
+
explode?: boolean | undefined;
|
|
80
|
+
allowReserved?: boolean | undefined;
|
|
81
81
|
schema?: {
|
|
82
82
|
type: string;
|
|
83
|
-
name?: string;
|
|
83
|
+
name?: string | undefined;
|
|
84
84
|
example?: any;
|
|
85
85
|
default?: any;
|
|
86
|
-
format?: string;
|
|
87
|
-
description?: string;
|
|
88
|
-
properties?: Record<string, import("@scalar/types/legacy").Schema
|
|
86
|
+
format?: string | undefined;
|
|
87
|
+
description?: string | undefined;
|
|
88
|
+
properties?: Record<string, import("@scalar/types/legacy").Schema> | undefined;
|
|
89
89
|
} | undefined;
|
|
90
90
|
example?: any;
|
|
91
91
|
examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
|
|
92
|
-
content?: import("@scalar/types/legacy").RequestBodyMimeTypes;
|
|
92
|
+
content?: import("@scalar/types/legacy").RequestBodyMimeTypes | undefined;
|
|
93
93
|
headers?: {
|
|
94
94
|
[key: string]: import("@scalar/openapi-types").OpenAPI.HeaderObject;
|
|
95
|
-
};
|
|
95
|
+
} | undefined;
|
|
96
96
|
}[] | undefined;
|
|
97
97
|
};
|
|
98
98
|
globalSecurity: OpenAPIV3.SecurityRequirementObject[] | OpenAPIV3_1.SecurityRequirementObject[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useOpenApiStore.d.ts","sourceRoot":"","sources":["../../../src/legacy/stores/useOpenApiStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAGhE,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACxC,cAAc,EACV,SAAS,CAAC,yBAAyB,EAAE,GACrC,WAAW,CAAC,yBAAyB,EAAE,CAAA;CAC5C,CAAA;AAED,eAAO,MAAM,uBAAuB,QAAO,YAGzC,CAAA;AAoBF,eAAO,MAAM,eAAe
|
|
1
|
+
{"version":3,"file":"useOpenApiStore.d.ts","sourceRoot":"","sources":["../../../src/legacy/stores/useOpenApiStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAGhE,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACxC,cAAc,EACV,SAAS,CAAC,yBAAyB,EAAE,GACrC,WAAW,CAAC,yBAAyB,EAAE,CAAA;CAC5C,CAAA;AAED,eAAO,MAAM,uBAAuB,QAAO,YAGzC,CAAA;AAoBF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAKqyJ,UAAW,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAhC/1J,SAAS,CAAC,yBAAyB,EAAE,GACrC,WAAW,CAAC,yBAAyB,EAAE;;iCAUT,oBAAoB,GAAG,SAAS;2CAQ/C,WAAW,CAAC,yBAAyB,EAAE,GAAG,SAAS;CAYtE,CAAA"}
|
|
@@ -3,49 +3,49 @@ type RequestHistoryEntry = RequestResult;
|
|
|
3
3
|
export declare const useRequestStore: () => {
|
|
4
4
|
readOnly: import("vue").Ref<boolean>;
|
|
5
5
|
activeRequest: {
|
|
6
|
-
id?: string;
|
|
7
|
-
name?: string;
|
|
6
|
+
id?: string | undefined;
|
|
7
|
+
name?: string | undefined;
|
|
8
8
|
url: string;
|
|
9
9
|
type: string;
|
|
10
10
|
path: string;
|
|
11
11
|
variables?: {
|
|
12
12
|
name: string;
|
|
13
|
-
description?: string | null;
|
|
13
|
+
description?: (string | null) | undefined;
|
|
14
14
|
value: string | number | Record<string, any>;
|
|
15
|
-
required?: boolean;
|
|
15
|
+
required?: boolean | undefined;
|
|
16
16
|
enabled: boolean;
|
|
17
17
|
}[] | undefined;
|
|
18
18
|
query?: {
|
|
19
19
|
name: string;
|
|
20
|
-
description?: string | null;
|
|
20
|
+
description?: (string | null) | undefined;
|
|
21
21
|
value: string | number | Record<string, any>;
|
|
22
|
-
required?: boolean;
|
|
22
|
+
required?: boolean | undefined;
|
|
23
23
|
enabled: boolean;
|
|
24
24
|
}[] | undefined;
|
|
25
25
|
cookies?: {
|
|
26
26
|
name: string;
|
|
27
|
-
description?: string | null;
|
|
27
|
+
description?: (string | null) | undefined;
|
|
28
28
|
value: string | number | Record<string, any>;
|
|
29
|
-
required?: boolean;
|
|
29
|
+
required?: boolean | undefined;
|
|
30
30
|
enabled: boolean;
|
|
31
31
|
}[] | undefined;
|
|
32
32
|
headers?: {
|
|
33
33
|
name: string;
|
|
34
|
-
description?: string | null;
|
|
34
|
+
description?: (string | null) | undefined;
|
|
35
35
|
value: string | number | Record<string, any>;
|
|
36
|
-
required?: boolean;
|
|
36
|
+
required?: boolean | undefined;
|
|
37
37
|
enabled: boolean;
|
|
38
38
|
}[] | undefined;
|
|
39
|
-
body?: string;
|
|
39
|
+
body?: string | undefined;
|
|
40
40
|
formData?: {
|
|
41
41
|
name: string;
|
|
42
|
-
description?: string | null;
|
|
42
|
+
description?: (string | null) | undefined;
|
|
43
43
|
value: string | number | Record<string, any>;
|
|
44
|
-
required?: boolean;
|
|
44
|
+
required?: boolean | undefined;
|
|
45
45
|
enabled: boolean;
|
|
46
46
|
}[] | undefined;
|
|
47
47
|
};
|
|
48
|
-
activeResponse: import("vue").ComputedRef<import("
|
|
48
|
+
activeResponse: import("vue").ComputedRef<import("..").ClientResponse | null>;
|
|
49
49
|
requestHistory: Record<string, RequestResult>;
|
|
50
50
|
requestHistoryOrder: import("vue").Ref<string[]>;
|
|
51
51
|
activeRequestId: import("vue").Ref<string>;
|
|
@@ -23,17 +23,17 @@ export declare const useServerStore: ({ specification, defaultServerUrl, servers
|
|
|
23
23
|
}) => {
|
|
24
24
|
server: {
|
|
25
25
|
selectedServer: null | number;
|
|
26
|
-
description?: string;
|
|
26
|
+
description?: string | undefined;
|
|
27
27
|
servers?: ({
|
|
28
|
-
url?: string;
|
|
29
|
-
description?: string;
|
|
28
|
+
url?: string | undefined;
|
|
29
|
+
description?: string | undefined;
|
|
30
30
|
variables?: {
|
|
31
31
|
[variable: string]: OpenAPIV3.ServerVariableObject;
|
|
32
|
-
};
|
|
32
|
+
} | undefined;
|
|
33
33
|
} | {
|
|
34
|
-
url?: string;
|
|
35
|
-
description?: string;
|
|
36
|
-
variables?: Record<string, OpenAPIV3_1.ServerVariableObject
|
|
34
|
+
url?: string | undefined;
|
|
35
|
+
description?: string | undefined;
|
|
36
|
+
variables?: Record<string, OpenAPIV3_1.ServerVariableObject> | undefined;
|
|
37
37
|
})[] | undefined;
|
|
38
38
|
variables: {
|
|
39
39
|
[key: string]: string;
|