@scalar/api-reference 1.32.9 → 1.32.10
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 +29 -0
- package/dist/browser/standalone.js +15115 -14878
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.js +2 -2
- package/dist/components/ApiReferenceLayout.vue2.js +164 -176
- package/dist/components/Badge/Badge.vue.d.ts.map +1 -1
- package/dist/components/Badge/Badge.vue.js +3 -3
- package/dist/components/Content/Content.vue.js +2 -2
- package/dist/components/Content/Content.vue2.js +21 -21
- package/dist/components/Content/Introduction/Description.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Description.vue.js +2 -2
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.js +2 -2
- package/dist/components/Content/Introduction/Introduction.vue2.js +104 -72
- package/dist/components/Content/Tag/Tag.vue.d.ts.map +1 -1
- package/dist/components/LinkList/LinkList.vue.d.ts +18 -0
- package/dist/components/LinkList/LinkList.vue.d.ts.map +1 -0
- package/dist/components/LinkList/LinkList.vue.js +12 -0
- package/dist/components/LinkList/index.d.ts +2 -0
- package/dist/components/LinkList/index.d.ts.map +1 -0
- package/dist/components/Section/SectionHeader.vue.d.ts +1 -0
- package/dist/components/Section/SectionHeader.vue.d.ts.map +1 -1
- package/dist/components/Section/SectionHeader.vue.js +2 -2
- package/dist/components/Section/SectionHeader.vue2.js +11 -10
- package/dist/features/Operation/Operation.vue.d.ts +6 -6
- package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
- package/dist/features/Operation/Operation.vue.js +50 -49
- package/dist/features/Operation/components/callbacks/Callback.vue.d.ts +8 -6
- 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 +21 -28
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts +5 -3
- package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts.map +1 -1
- package/dist/features/Operation/components/callbacks/Callbacks.vue.js +33 -18
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +11 -12
- package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue.js +1 -1
- package/dist/features/Operation/layouts/ClassicLayout.vue2.js +164 -163
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +12 -13
- package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue.js +1 -1
- package/dist/features/Operation/layouts/ModernLayout.vue2.js +111 -118
- package/dist/features/api-client-modal/useApiClient.d.ts +5299 -5299
- package/dist/features/api-client-modal/useApiClient.d.ts.map +1 -1
- package/dist/features/base-url/BaseUrl.vue.d.ts.map +1 -1
- package/dist/features/base-url/BaseUrl.vue.js +26 -26
- package/dist/features/download-link/DownloadLink.vue.js +1 -1
- package/dist/features/example-responses/ExampleResponseTab.vue.js +2 -2
- package/dist/features/example-responses/ExampleResponseTabList.vue.js +1 -1
- package/dist/features/example-responses/ExampleResponses.vue.d.ts.map +1 -1
- package/dist/features/example-responses/ExampleResponses.vue.js +2 -2
- package/dist/features/example-responses/ExampleResponses.vue2.js +60 -57
- package/dist/features/external-docs/ExternalDocs.vue.d.ts +7 -0
- package/dist/features/external-docs/ExternalDocs.vue.d.ts.map +1 -0
- package/dist/features/external-docs/ExternalDocs.vue.js +36 -0
- package/dist/features/external-docs/ExternalDocs.vue2.js +4 -0
- package/dist/features/external-docs/index.d.ts +2 -0
- package/dist/features/external-docs/index.d.ts.map +1 -0
- package/dist/features/info-object/Contact.vue.d.ts +7 -0
- package/dist/features/info-object/Contact.vue.d.ts.map +1 -0
- package/dist/features/info-object/Contact.vue.js +44 -0
- package/dist/features/info-object/Contact.vue2.js +4 -0
- package/dist/features/info-object/License.vue.d.ts +7 -0
- package/dist/features/info-object/License.vue.d.ts.map +1 -0
- package/dist/features/info-object/License.vue.js +34 -0
- package/dist/features/info-object/License.vue2.js +4 -0
- package/dist/features/info-object/TermsOfService.vue.d.ts +7 -0
- package/dist/features/info-object/TermsOfService.vue.d.ts.map +1 -0
- package/dist/features/info-object/TermsOfService.vue.js +30 -0
- package/dist/features/info-object/TermsOfService.vue2.js +4 -0
- package/dist/features/info-object/index.d.ts +4 -0
- package/dist/features/info-object/index.d.ts.map +1 -0
- package/dist/features/test-request-button/TestRequestButton.vue.d.ts +3 -2
- package/dist/features/test-request-button/TestRequestButton.vue.d.ts.map +1 -1
- package/dist/features/test-request-button/TestRequestButton.vue.js +2 -2
- package/dist/features/test-request-button/TestRequestButton.vue2.js +21 -19
- package/dist/helpers/convert-security-scheme.js +23 -0
- package/dist/index.d.ts +0 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +13 -15
- package/dist/style.css +1 -1
- package/dist/v2/ApiReferenceWorkspace.vue.d.ts +3 -1
- package/dist/v2/ApiReferenceWorkspace.vue.d.ts.map +1 -1
- package/dist/v2/ApiReferenceWorkspace.vue.js +113 -86
- package/dist/v2/blocks/scalar-request-example-block/components/ExamplePicker.vue.d.ts +0 -2
- package/dist/v2/blocks/scalar-request-example-block/components/ExamplePicker.vue.d.ts.map +1 -1
- package/dist/v2/blocks/scalar-request-example-block/components/ExamplePicker.vue.js +4 -0
- package/dist/v2/blocks/scalar-request-example-block/components/ExamplePicker.vue2.js +69 -0
- package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.d.ts.map +1 -1
- package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.js +7 -0
- package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue2.js +227 -0
- package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.js +20 -3
- package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.js +35 -0
- package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.js +29 -0
- package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.js +10 -0
- package/dist/v2/blocks/scalar-request-example-block/index.d.ts +2 -2
- package/dist/v2/events/definitions.js +7 -0
- package/dist/v2/events/index.d.ts +1 -1
- package/dist/v2/events/listeners.d.ts +1 -1
- package/dist/v2/hooks/useStore.js +14 -0
- package/package.json +11 -11
- package/LICENSE +0 -21
- package/dist/blocks/constants.js +0 -6
- package/dist/blocks/helpers/getPointer.js +0 -12
- package/dist/blocks/hooks/useBlockProps.d.ts +0 -31
- package/dist/blocks/hooks/useBlockProps.d.ts.map +0 -1
- package/dist/blocks/hooks/useBlockProps.js +0 -24
- package/dist/features/example-request/ExamplePicker.vue.d.ts +0 -13
- package/dist/features/example-request/ExamplePicker.vue.d.ts.map +0 -1
- package/dist/features/example-request/ExamplePicker.vue.js +0 -7
- package/dist/features/example-request/ExamplePicker.vue2.js +0 -57
- package/dist/features/example-request/ExampleRequest.vue.d.ts +0 -85
- package/dist/features/example-request/ExampleRequest.vue.d.ts.map +0 -1
- package/dist/features/example-request/ExampleRequest.vue.js +0 -7
- package/dist/features/example-request/ExampleRequest.vue2.js +0 -348
- package/dist/features/example-request/TextSelect.vue.d.ts +0 -34
- package/dist/features/example-request/TextSelect.vue.d.ts.map +0 -1
- package/dist/features/example-request/TextSelect.vue.js +0 -48
- package/dist/features/example-request/TextSelect.vue3.js +0 -5
- package/dist/features/example-request/index.d.ts +0 -3
- package/dist/features/example-request/index.d.ts.map +0 -1
|
@@ -1,88 +1,86 @@
|
|
|
1
|
-
import { defineComponent as
|
|
2
|
-
import { ScalarMarkdown as
|
|
3
|
-
import { ScalarIconWebhooksLogo as
|
|
4
|
-
import { getOperationStability as
|
|
5
|
-
import
|
|
6
|
-
import
|
|
7
|
-
import
|
|
8
|
-
import
|
|
9
|
-
import
|
|
10
|
-
import
|
|
11
|
-
import
|
|
12
|
-
import
|
|
13
|
-
import
|
|
14
|
-
import
|
|
15
|
-
import
|
|
16
|
-
import
|
|
17
|
-
import
|
|
18
|
-
import
|
|
19
|
-
import
|
|
20
|
-
import
|
|
21
|
-
|
|
1
|
+
import { defineComponent as V, computed as w, useId as q, createBlock as r, openBlock as s, unref as o, withCtx as t, createVNode as a, createCommentVNode as l, createElementVNode as i, normalizeClass as y, createTextVNode as n, toDisplayString as b, createSlots as T } from "vue";
|
|
2
|
+
import { ScalarMarkdown as W, ScalarErrorBoundary as m } from "@scalar/components";
|
|
3
|
+
import { ScalarIconWebhooksLogo as E } from "@scalar/icons";
|
|
4
|
+
import { getOperationStability as S, getOperationStabilityColor as I, isOperationDeprecated as N } from "@scalar/oas-utils/helpers";
|
|
5
|
+
import D from "../../../components/OperationPath.vue.js";
|
|
6
|
+
import L from "../components/callbacks/Callbacks.vue.js";
|
|
7
|
+
import P from "../components/OperationParameters.vue.js";
|
|
8
|
+
import R from "../components/OperationResponses.vue.js";
|
|
9
|
+
import { useConfig as $ } from "../../../hooks/useConfig.js";
|
|
10
|
+
import { useStore as z } from "../../../v2/hooks/useStore.js";
|
|
11
|
+
import A from "../../../components/Section/Section.vue.js";
|
|
12
|
+
import H from "../../../components/Section/SectionContent.vue.js";
|
|
13
|
+
import g from "../../../components/Badge/Badge.vue.js";
|
|
14
|
+
import M from "../../../components/Section/SectionHeader.vue.js";
|
|
15
|
+
import U from "../../../components/Anchor/Anchor.vue.js";
|
|
16
|
+
import j from "../../../components/Section/SectionHeaderTag.vue.js";
|
|
17
|
+
import F from "../../../components/Section/SectionColumns.vue.js";
|
|
18
|
+
import k from "../../../components/Section/SectionColumn.vue.js";
|
|
19
|
+
import G from "../../../v2/blocks/scalar-request-example-block/components/RequestExample.vue.js";
|
|
20
|
+
import J from "../../test-request-button/TestRequestButton.vue.js";
|
|
21
|
+
import K from "../../example-responses/ExampleResponses.vue.js";
|
|
22
|
+
const Q = { class: "operation-details" }, X = { class: "examples" }, be = /* @__PURE__ */ V({
|
|
22
23
|
__name: "ModernLayout",
|
|
23
24
|
props: {
|
|
24
25
|
id: {},
|
|
25
26
|
path: {},
|
|
26
27
|
method: {},
|
|
27
28
|
operation: {},
|
|
29
|
+
oldOperation: {},
|
|
28
30
|
isWebhook: { type: Boolean },
|
|
29
|
-
|
|
31
|
+
securitySchemes: {},
|
|
30
32
|
server: {},
|
|
31
|
-
request: {},
|
|
32
33
|
schemas: {}
|
|
33
34
|
},
|
|
34
35
|
emits: ["update:modelValue"],
|
|
35
|
-
setup(d, { emit:
|
|
36
|
-
const u =
|
|
37
|
-
|
|
38
|
-
return ((e = d.operation) == null ? void 0 : e.summary) || d.path || "";
|
|
39
|
-
}), T = w, c = O(), E = z(), f = (e) => {
|
|
40
|
-
T("update:modelValue", e);
|
|
36
|
+
setup(d, { emit: v }) {
|
|
37
|
+
const p = w(() => d.operation.summary || d.path || ""), C = v, u = q(), { workspace: B } = z(), O = $(), c = (e) => {
|
|
38
|
+
C("update:modelValue", e);
|
|
41
39
|
};
|
|
42
|
-
return (e, h) => (s(),
|
|
40
|
+
return (e, h) => (s(), r(o(A), {
|
|
43
41
|
id: e.id,
|
|
44
|
-
"aria-labelledby": o(
|
|
45
|
-
label:
|
|
42
|
+
"aria-labelledby": o(u),
|
|
43
|
+
label: p.value,
|
|
46
44
|
tabindex: "-1"
|
|
47
45
|
}, {
|
|
48
46
|
default: t(() => [
|
|
49
|
-
a(o(
|
|
50
|
-
loading: o(
|
|
47
|
+
a(o(H), {
|
|
48
|
+
loading: o(O).isLoading
|
|
51
49
|
}, {
|
|
52
50
|
default: t(() => [
|
|
53
|
-
o(
|
|
51
|
+
o(S)(e.operation) ? (s(), r(o(g), {
|
|
54
52
|
key: 0,
|
|
55
|
-
class:
|
|
53
|
+
class: y(["capitalize", o(I)(e.operation)])
|
|
56
54
|
}, {
|
|
57
55
|
default: t(() => [
|
|
58
|
-
|
|
56
|
+
n(b(o(S)(e.operation)), 1)
|
|
59
57
|
]),
|
|
60
58
|
_: 1
|
|
61
|
-
}, 8, ["class"])) :
|
|
62
|
-
e.isWebhook ? (s(),
|
|
59
|
+
}, 8, ["class"])) : l("", !0),
|
|
60
|
+
e.isWebhook ? (s(), r(o(g), {
|
|
63
61
|
key: 1,
|
|
64
62
|
class: "font-code text-green flex w-fit items-center justify-center gap-1"
|
|
65
63
|
}, {
|
|
66
64
|
default: t(() => [
|
|
67
|
-
a(o(
|
|
68
|
-
h[0] || (h[0] =
|
|
65
|
+
a(o(E), { weight: "bold" }),
|
|
66
|
+
h[0] || (h[0] = n("Webhook "))
|
|
69
67
|
]),
|
|
70
68
|
_: 1,
|
|
71
69
|
__: [0]
|
|
72
|
-
})) :
|
|
73
|
-
|
|
74
|
-
class:
|
|
70
|
+
})) : l("", !0),
|
|
71
|
+
i("div", {
|
|
72
|
+
class: y(o(N)(e.operation) ? "deprecated" : "")
|
|
75
73
|
}, [
|
|
76
|
-
a(o(
|
|
74
|
+
a(o(M), null, {
|
|
77
75
|
default: t(() => [
|
|
78
|
-
a(o(
|
|
76
|
+
a(o(U), { id: e.id }, {
|
|
79
77
|
default: t(() => [
|
|
80
|
-
a(o(
|
|
81
|
-
id: o(
|
|
78
|
+
a(o(j), {
|
|
79
|
+
id: o(u),
|
|
82
80
|
level: 3
|
|
83
81
|
}, {
|
|
84
82
|
default: t(() => [
|
|
85
|
-
|
|
83
|
+
n(b(p.value), 1)
|
|
86
84
|
]),
|
|
87
85
|
_: 1
|
|
88
86
|
}, 8, ["id"])
|
|
@@ -93,98 +91,93 @@ const Y = { class: "operation-details" }, Z = { class: "examples" }, ke = /* @__
|
|
|
93
91
|
_: 1
|
|
94
92
|
})
|
|
95
93
|
], 2),
|
|
96
|
-
a(o(
|
|
94
|
+
a(o(F), null, {
|
|
97
95
|
default: t(() => [
|
|
98
|
-
a(o(
|
|
99
|
-
default: t(() =>
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
_: 1
|
|
134
|
-
})
|
|
135
|
-
])
|
|
136
|
-
];
|
|
137
|
-
}),
|
|
96
|
+
a(o(k), null, {
|
|
97
|
+
default: t(() => [
|
|
98
|
+
i("div", Q, [
|
|
99
|
+
a(o(W), {
|
|
100
|
+
value: e.operation.description,
|
|
101
|
+
withImages: "",
|
|
102
|
+
withAnchors: "",
|
|
103
|
+
transformType: "heading",
|
|
104
|
+
anchorPrefix: e.id
|
|
105
|
+
}, null, 8, ["value", "anchorPrefix"]),
|
|
106
|
+
a(P, {
|
|
107
|
+
parameters: e.oldOperation.parameters,
|
|
108
|
+
requestBody: e.oldOperation.requestBody,
|
|
109
|
+
schemas: e.schemas,
|
|
110
|
+
"onUpdate:modelValue": c
|
|
111
|
+
}, null, 8, ["parameters", "requestBody", "schemas"]),
|
|
112
|
+
a(R, {
|
|
113
|
+
responses: e.oldOperation.responses,
|
|
114
|
+
schemas: e.schemas
|
|
115
|
+
}, null, 8, ["responses", "schemas"]),
|
|
116
|
+
a(o(m), null, {
|
|
117
|
+
default: t(() => [
|
|
118
|
+
e.operation.callbacks ? (s(), r(L, {
|
|
119
|
+
key: 0,
|
|
120
|
+
class: "mt-6",
|
|
121
|
+
path: e.path,
|
|
122
|
+
callbacks: e.operation.callbacks,
|
|
123
|
+
method: e.method,
|
|
124
|
+
schemas: e.schemas
|
|
125
|
+
}, null, 8, ["path", "callbacks", "method", "schemas"])) : l("", !0)
|
|
126
|
+
]),
|
|
127
|
+
_: 1
|
|
128
|
+
})
|
|
129
|
+
])
|
|
130
|
+
]),
|
|
138
131
|
_: 1
|
|
139
132
|
}),
|
|
140
|
-
a(o(
|
|
133
|
+
a(o(k), null, {
|
|
141
134
|
default: t(() => [
|
|
142
|
-
|
|
143
|
-
a(o(
|
|
135
|
+
i("div", X, [
|
|
136
|
+
a(o(m), null, {
|
|
144
137
|
default: t(() => [
|
|
145
|
-
a(o(
|
|
146
|
-
request: e.request,
|
|
138
|
+
a(o(G), {
|
|
147
139
|
method: e.method,
|
|
148
|
-
|
|
140
|
+
selectedServer: e.server,
|
|
141
|
+
securitySchemes: e.securitySchemes,
|
|
142
|
+
selectedClient: o(B)["x-scalar-default-client"],
|
|
143
|
+
path: e.path,
|
|
149
144
|
fallback: "",
|
|
150
145
|
operation: e.operation,
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
"onUpdate:modelValue": f
|
|
154
|
-
}, W({
|
|
146
|
+
"onUpdate:modelValue": c
|
|
147
|
+
}, T({
|
|
155
148
|
header: t(() => {
|
|
156
|
-
var
|
|
149
|
+
var f;
|
|
157
150
|
return [
|
|
158
|
-
a(
|
|
151
|
+
a(D, {
|
|
159
152
|
class: "font-code text-c-2 [&_em]:text-c-1 [&_em]:not-italic",
|
|
160
|
-
deprecated: (
|
|
153
|
+
deprecated: (f = e.operation) == null ? void 0 : f.deprecated,
|
|
161
154
|
path: e.path
|
|
162
155
|
}, null, 8, ["deprecated", "path"])
|
|
163
156
|
];
|
|
164
157
|
}),
|
|
165
158
|
_: 2
|
|
166
159
|
}, [
|
|
167
|
-
e.
|
|
160
|
+
e.isWebhook ? void 0 : {
|
|
168
161
|
name: "footer",
|
|
169
162
|
fn: t(() => [
|
|
170
|
-
a(o(
|
|
163
|
+
a(o(J), {
|
|
164
|
+
method: e.method,
|
|
165
|
+
path: e.path
|
|
166
|
+
}, null, 8, ["method", "path"])
|
|
171
167
|
]),
|
|
172
168
|
key: "0"
|
|
173
|
-
}
|
|
174
|
-
]), 1032, ["
|
|
169
|
+
}
|
|
170
|
+
]), 1032, ["method", "selectedServer", "securitySchemes", "selectedClient", "path", "operation"])
|
|
175
171
|
]),
|
|
176
172
|
_: 1
|
|
177
173
|
}),
|
|
178
|
-
a(o(
|
|
179
|
-
default: t(() =>
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
}, null, 8, ["responses"])
|
|
186
|
-
];
|
|
187
|
-
}),
|
|
174
|
+
a(o(m), null, {
|
|
175
|
+
default: t(() => [
|
|
176
|
+
a(o(K), {
|
|
177
|
+
responses: e.operation.responses,
|
|
178
|
+
style: { "margin-top": "12px" }
|
|
179
|
+
}, null, 8, ["responses"])
|
|
180
|
+
]),
|
|
188
181
|
_: 1
|
|
189
182
|
})
|
|
190
183
|
])
|
|
@@ -203,5 +196,5 @@ const Y = { class: "operation-details" }, Z = { class: "examples" }, ke = /* @__
|
|
|
203
196
|
}
|
|
204
197
|
});
|
|
205
198
|
export {
|
|
206
|
-
|
|
199
|
+
be as default
|
|
207
200
|
};
|