@scalar/api-reference 1.35.2 → 1.35.4
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 +31 -0
- package/dist/browser/standalone.js +9636 -9786
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReference.vue.d.ts +2 -1
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/ApiReference.vue.js +14 -11
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.js +2 -2
- package/dist/components/ApiReferenceLayout.vue2.js +70 -72
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts +3 -1
- package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.d.ts +0 -2
- package/dist/components/Content/Content.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.js +80 -80
- package/dist/components/Content/Models/ClassicLayout.vue.d.ts +5 -2
- package/dist/components/Content/Models/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/components/Content/Models/ClassicLayout.vue.js +2 -2
- package/dist/components/Content/Models/ClassicLayout.vue2.js +43 -45
- package/dist/components/Content/Models/ClassicLayout.vue3.js +2 -2
- package/dist/components/Content/Models/Models.vue.d.ts +2 -2
- package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
- package/dist/components/Content/Models/Models.vue.js +27 -20
- package/dist/components/Content/Models/ModernLayout.vue.d.ts +5 -2
- package/dist/components/Content/Models/ModernLayout.vue.d.ts.map +1 -1
- package/dist/components/Content/Models/ModernLayout.vue.js +2 -2
- package/dist/components/Content/Models/ModernLayout.vue2.js +48 -52
- package/dist/components/Content/Operations/TraversedEntry.vue.d.ts +3 -2
- package/dist/components/Content/Operations/TraversedEntry.vue.d.ts.map +1 -1
- package/dist/components/Content/Operations/TraversedEntry.vue.js +33 -32
- package/dist/components/Content/Operations/TraversedEntryContainer.vue.d.ts +2 -2
- package/dist/components/Content/Operations/TraversedEntryContainer.vue.d.ts.map +1 -1
- package/dist/components/Content/Operations/TraversedEntryContainer.vue.js +1 -1
- package/dist/components/Content/Schema/Schema.vue.d.ts +10 -22
- package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/Schema.vue.js +2 -2
- package/dist/components/Content/Schema/Schema.vue2.js +93 -141
- package/dist/components/Content/Schema/SchemaComposition.vue.d.ts +19 -4
- package/dist/components/Content/Schema/SchemaComposition.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaComposition.vue.js +83 -138
- package/dist/components/Content/Schema/SchemaEnumValues.vue.d.ts +2 -13
- package/dist/components/Content/Schema/SchemaEnumValues.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaEnumValues.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaEnumValues.vue2.js +66 -92
- package/dist/components/Content/Schema/SchemaHeading.vue.d.ts +2 -2
- package/dist/components/Content/Schema/SchemaHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaHeading.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaHeading.vue2.js +19 -17
- package/dist/components/Content/Schema/SchemaObjectProperties.vue.d.ts +9 -14
- package/dist/components/Content/Schema/SchemaObjectProperties.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaObjectProperties.vue.js +62 -75
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +8 -13
- package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
- package/dist/components/Content/Schema/SchemaProperty.vue2.js +120 -140
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts +1 -1
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaPropertyExamples.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts +9 -4
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +2 -2
- package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +173 -204
- package/dist/components/Content/Schema/helpers/get-ref-name.d.ts +11 -0
- package/dist/components/Content/Schema/helpers/get-ref-name.d.ts.map +1 -0
- package/dist/components/Content/Schema/helpers/get-ref-name.js +11 -0
- package/dist/components/Content/Schema/helpers/get-schema-type.d.ts +13 -3
- package/dist/components/Content/Schema/helpers/get-schema-type.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/get-schema-type.js +34 -13
- package/dist/components/Content/Schema/helpers/is-type-object.d.ts +4 -2
- package/dist/components/Content/Schema/helpers/is-type-object.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts +2 -4
- package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/merge-all-of-schemas.js +130 -84
- package/dist/components/Content/Schema/helpers/optimize-value-for-display.d.ts +5 -5
- package/dist/components/Content/Schema/helpers/optimize-value-for-display.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/optimize-value-for-display.js +40 -31
- package/dist/components/Content/Schema/helpers/schema-composition.d.ts +0 -8
- package/dist/components/Content/Schema/helpers/schema-composition.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/schema-composition.js +2 -6
- package/dist/components/Content/Schema/helpers/schema-name.d.ts +8 -17
- package/dist/components/Content/Schema/helpers/schema-name.d.ts.map +1 -1
- package/dist/components/Content/Schema/helpers/schema-name.js +24 -33
- package/dist/features/Operation/Operation.vue.d.ts +3 -4
- package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
- package/dist/features/Operation/Operation.vue.js +54 -73
- package/dist/features/Operation/components/ContentTypeSelect.vue.d.ts +10 -11
- package/dist/features/Operation/components/ContentTypeSelect.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ContentTypeSelect.vue.js +35 -43
- package/dist/features/Operation/components/{ParameterHeaders.vue.d.ts → Header.vue.d.ts} +4 -5
- package/dist/features/Operation/components/Header.vue.d.ts.map +1 -0
- package/dist/features/Operation/components/Header.vue.js +23 -0
- package/dist/features/Operation/components/Header.vue2.js +4 -0
- package/dist/features/Operation/components/Headers.vue.d.ts +8 -0
- package/dist/features/Operation/components/Headers.vue.d.ts.map +1 -0
- package/dist/features/Operation/components/Headers.vue.js +7 -0
- package/dist/features/Operation/components/Headers.vue2.js +61 -0
- package/dist/features/Operation/components/OperationParameters.vue.d.ts +4 -10
- package/dist/features/Operation/components/OperationParameters.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/OperationParameters.vue.js +23 -33
- package/dist/features/Operation/components/OperationResponses.vue.d.ts +3 -6
- package/dist/features/Operation/components/OperationResponses.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/OperationResponses.vue.js +22 -19
- package/dist/features/Operation/components/ParameterList.vue.d.ts +3 -10
- package/dist/features/Operation/components/ParameterList.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterList.vue.js +35 -5
- package/dist/features/Operation/components/ParameterList.vue2.js +2 -38
- package/dist/features/Operation/components/ParameterListItem.vue.d.ts +4 -10
- package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/ParameterListItem.vue.js +1 -1
- package/dist/features/Operation/components/ParameterListItem.vue2.js +78 -74
- package/dist/features/Operation/components/RequestBody.vue.d.ts +3 -8
- package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/RequestBody.vue.js +2 -2
- package/dist/features/Operation/components/RequestBody.vue2.js +78 -82
- package/dist/features/Operation/components/callbacks/Callback.vue.d.ts +0 -4
- package/dist/features/Operation/components/callbacks/Callback.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/callbacks/Callback.vue.js +3 -3
- package/dist/features/Operation/components/callbacks/Callback.vue2.js +35 -36
- package/dist/features/Operation/components/callbacks/Callback.vue3.js +2 -2
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts +0 -2
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/callbacks/Callbacks.vue.js +13 -15
- package/dist/features/Operation/helpers/combine-params.d.ts +1 -1
- package/dist/features/Operation/helpers/combine-params.d.ts.map +1 -1
- package/dist/features/Operation/helpers/combine-params.js +2 -2
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +1 -9
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
- package/dist/features/Operation/layouts/ClassicLayout.vue2.js +75 -82
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +2 -10
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue.js +2 -2
- package/dist/features/Operation/layouts/ModernLayout.vue2.js +96 -103
- package/dist/features/api-client-modal/useApiClient.d.ts +90 -90
- package/dist/index.js +1 -1
- package/dist/libs/openapi.d.ts +1 -13
- package/dist/libs/openapi.d.ts.map +1 -1
- package/dist/libs/openapi.js +39 -56
- package/dist/style.css +1 -1
- package/dist/v2/ApiReferenceWorkspace.vue.d.ts +10 -4
- package/dist/v2/ApiReferenceWorkspace.vue.d.ts.map +1 -1
- package/dist/v2/ApiReferenceWorkspace.vue.js +22 -18
- package/dist/v2/blocks/scalar-auth-selector-block/components/RequestAuthDataTableInput.vue.d.ts +1 -1
- package/dist/v2/blocks/scalar-auth-selector-block/components/RequestAuthDataTableInput.vue.d.ts.map +1 -1
- package/package.json +13 -13
- package/dist/components/Content/Schema/Schema.preview.d.ts +0 -1078
- package/dist/components/Content/Schema/Schema.preview.d.ts.map +0 -1
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts +0 -12
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts.map +0 -1
- package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +0 -49
- package/dist/components/Content/Schema/SchemaDiscriminator.vue2.js +0 -4
- package/dist/components/Content/Schema/SchemaPropertyDescription.vue.d.ts +0 -13
- package/dist/components/Content/Schema/SchemaPropertyDescription.vue.d.ts.map +0 -1
- package/dist/features/Operation/components/ParameterHeaders.vue.d.ts.map +0 -1
- package/dist/features/Operation/components/ParameterHeaders.vue.js +0 -7
- package/dist/features/Operation/components/ParameterHeaders.vue2.js +0 -64
- package/dist/features/Operation/components/ParameterList.vue3.js +0 -4
- package/dist/features/Operation/hooks/useResponses.d.ts +0 -17
- package/dist/features/Operation/hooks/useResponses.d.ts.map +0 -1
- package/dist/features/Operation/hooks/useResponses.js +0 -19
- package/dist/hooks/useDiscriminator.d.ts +0 -53
- package/dist/hooks/useDiscriminator.d.ts.map +0 -1
- package/dist/hooks/useDiscriminator.js +0 -149
- package/dist/hooks/useOperationDiscriminator.d.ts +0 -8
- package/dist/hooks/useOperationDiscriminator.d.ts.map +0 -1
- package/dist/hooks/useOperationDiscriminator.js +0 -57
- /package/dist/features/Operation/components/{ParameterHeaders.vue3.js → Headers.vue3.js} +0 -0
package/dist/libs/openapi.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { OpenAPI, OpenAPIV3_1 } from '@scalar/openapi-types';
|
|
2
|
-
import type {
|
|
2
|
+
import type { OperationObject, ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
|
|
3
3
|
/**
|
|
4
4
|
* Formats a property object into a string.
|
|
5
5
|
*/
|
|
@@ -8,18 +8,6 @@ export declare function formatProperty(key: string, obj: OpenAPIV3_1.SchemaObjec
|
|
|
8
8
|
* Extracts the request body from an operation.
|
|
9
9
|
*/
|
|
10
10
|
export declare function extractRequestBody(operation: OperationObject): string[] | boolean;
|
|
11
|
-
/**
|
|
12
|
-
* Returns all models from the specification, no matter if it's OpenAPI 3.x.
|
|
13
|
-
*/
|
|
14
|
-
export declare function getModels(document?: OpenAPIV3_1.Document): Record<string, OpenAPIV3_1.SchemaObject>;
|
|
15
|
-
/**
|
|
16
|
-
* Checks if the OpenAPI document has schemas.
|
|
17
|
-
*/
|
|
18
|
-
export declare const hasModels: (content?: OpenAPIV3_1.Document) => boolean;
|
|
19
|
-
/**
|
|
20
|
-
* Checks if the OpenAPI document has webhooks.
|
|
21
|
-
*/
|
|
22
|
-
export declare const hasWebhooks: (document?: OpenAPIV3_1.Document) => boolean;
|
|
23
11
|
/**
|
|
24
12
|
* Deep merge for objects
|
|
25
13
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/libs/openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGjE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;
|
|
1
|
+
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/libs/openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGjE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAEpH;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,YAAY,GAAG,MAAM,CAejF;AA+BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAYjF;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,oBAW3E;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAiBjF,OAAO,CAAC,QAAQ,CACvB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,KAAK,EAAE,eAAe,EAAE,CAAA;IACxB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,eAAe,gBA2D5D"}
|
package/dist/libs/openapi.js
CHANGED
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
import { isDereferenced as
|
|
2
|
-
import { getResolvedRef as
|
|
3
|
-
function
|
|
4
|
-
var
|
|
5
|
-
let
|
|
6
|
-
const e = (
|
|
7
|
-
|
|
8
|
-
const
|
|
9
|
-
return
|
|
1
|
+
import { isDereferenced as l } from "@scalar/openapi-types/helpers";
|
|
2
|
+
import { getResolvedRef as r } from "@scalar/workspace-store/helpers/get-resolved-ref";
|
|
3
|
+
function h(t, o) {
|
|
4
|
+
var n, c;
|
|
5
|
+
let i = t;
|
|
6
|
+
const e = (n = o.required) == null ? void 0 : n.includes(t);
|
|
7
|
+
i += e ? " REQUIRED " : " optional ";
|
|
8
|
+
const s = r((c = o.properties) == null ? void 0 : c[t]);
|
|
9
|
+
return s && (i += s.type, s.description && (i += " " + s.description)), i;
|
|
10
10
|
}
|
|
11
|
-
function y(
|
|
12
|
-
const
|
|
13
|
-
return e && Object.keys(e).forEach((
|
|
14
|
-
if (!
|
|
11
|
+
function y(t) {
|
|
12
|
+
const o = ["Body"], i = r(t == null ? void 0 : t.schema), e = i == null ? void 0 : i.properties;
|
|
13
|
+
return e && Object.keys(e).forEach((s) => {
|
|
14
|
+
if (!t.schema)
|
|
15
15
|
return;
|
|
16
|
-
|
|
17
|
-
const
|
|
18
|
-
|
|
19
|
-
var
|
|
20
|
-
|
|
16
|
+
o.push(h(s, i));
|
|
17
|
+
const n = r(e[s]);
|
|
18
|
+
n.type === "object" && !!n.properties && n.properties && Object.keys(n.properties).forEach((f) => {
|
|
19
|
+
var u, p;
|
|
20
|
+
o.push(`${f} ${(p = r((u = n.properties) == null ? void 0 : u[f])) == null ? void 0 : p.type}`);
|
|
21
21
|
});
|
|
22
|
-
}),
|
|
22
|
+
}), o;
|
|
23
23
|
}
|
|
24
|
-
function
|
|
25
|
-
var
|
|
24
|
+
function v(t) {
|
|
25
|
+
var o, i;
|
|
26
26
|
try {
|
|
27
|
-
const e = (
|
|
27
|
+
const e = (i = (o = r(t == null ? void 0 : t.requestBody)) == null ? void 0 : o.content) == null ? void 0 : i["application/json"];
|
|
28
28
|
if (!e)
|
|
29
29
|
throw new Error("Body not found");
|
|
30
30
|
return y(e);
|
|
@@ -32,29 +32,13 @@ function q(i) {
|
|
|
32
32
|
return !1;
|
|
33
33
|
}
|
|
34
34
|
}
|
|
35
|
-
function
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
const s = (
|
|
40
|
-
// OpenAPI 3.x
|
|
41
|
-
Object.keys(((o = i == null ? void 0 : i.components) == null ? void 0 : o.schemas) ?? {}).length ? (e = i == null ? void 0 : i.components) == null ? void 0 : e.schemas : (
|
|
42
|
-
// Fallback
|
|
43
|
-
{}
|
|
44
|
-
)
|
|
45
|
-
);
|
|
46
|
-
return Object.keys(s ?? {}).forEach((t) => {
|
|
47
|
-
var r, n;
|
|
48
|
-
(((r = s[t]) == null ? void 0 : r["x-internal"]) === !0 || ((n = s[t]) == null ? void 0 : n["x-scalar-ignore"]) === !0) && delete s[t];
|
|
49
|
-
}), s;
|
|
35
|
+
function d(t, o) {
|
|
36
|
+
for (const [i, e] of Object.entries(t))
|
|
37
|
+
e !== null && typeof e == "object" ? (o[i] ?? (o[i] = new e.__proto__.constructor()), d(e, o[i])) : typeof e < "u" && (o[i] = e);
|
|
38
|
+
return o;
|
|
50
39
|
}
|
|
51
|
-
function
|
|
52
|
-
|
|
53
|
-
e !== null && typeof e == "object" ? (s[o] ?? (s[o] = new e.__proto__.constructor()), l(e, s[o])) : typeof e < "u" && (s[o] = e);
|
|
54
|
-
return s;
|
|
55
|
-
}
|
|
56
|
-
function b(i) {
|
|
57
|
-
return l(i ?? {}, {
|
|
40
|
+
function O(t) {
|
|
41
|
+
return d(t ?? {}, {
|
|
58
42
|
info: {
|
|
59
43
|
title: "",
|
|
60
44
|
description: "",
|
|
@@ -72,24 +56,23 @@ function b(i) {
|
|
|
72
56
|
tags: []
|
|
73
57
|
});
|
|
74
58
|
}
|
|
75
|
-
function
|
|
76
|
-
const
|
|
59
|
+
function R(t) {
|
|
60
|
+
const o = {
|
|
77
61
|
path: [],
|
|
78
62
|
query: [],
|
|
79
63
|
header: [],
|
|
80
64
|
cookie: [],
|
|
81
65
|
body: [],
|
|
82
66
|
formData: []
|
|
83
|
-
},
|
|
84
|
-
return
|
|
85
|
-
|
|
86
|
-
}),
|
|
67
|
+
}, i = t.parameters ?? [];
|
|
68
|
+
return i && i.forEach((e) => {
|
|
69
|
+
l(e) && (typeof e == "object" && e !== null && "$ref" in e || (e.in === "path" ? o.path.push(e) : e.in === "query" ? o.query.push(e) : e.in === "header" ? o.header.push(e) : e.in === "cookie" ? o.cookie.push(e) : e.in === "body" ? o.body.push(e) : e.in === "formData" && o.formData.push(e)));
|
|
70
|
+
}), o;
|
|
87
71
|
}
|
|
88
72
|
export {
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
a as getModels
|
|
73
|
+
O as createEmptySpecification,
|
|
74
|
+
R as createParameterMap,
|
|
75
|
+
d as deepMerge,
|
|
76
|
+
v as extractRequestBody,
|
|
77
|
+
h as formatProperty
|
|
95
78
|
};
|