@scalar/api-client 2.3.12 → 2.3.14
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/components/CommandPalette/TheCommandPalette.vue.d.ts +6 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerDropdownItem.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerDropdownItem.vue.js +1 -1
- package/dist/components/Server/ServerDropdownItem.vue2.js +25 -22
- package/dist/components/SideNav/SideNav.vue.d.ts.map +1 -1
- package/dist/components/SideNav/SideNav.vue.js +39 -39
- package/dist/layouts/App/create-api-client-app.d.ts +154 -4
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +308 -8
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +154 -4
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +154 -4
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/find-request.d.ts +15 -0
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/send-request/create-request-operation.test.d.ts +15 -0
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/store/active-entities.d.ts +15 -0
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/requests.d.ts +169 -4
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/store.d.ts +154 -4
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/views/Request/RequestSection/RequestCodeExample.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestCodeExample.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestCodeExample.vue2.js +122 -78
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @scalar/api-client
|
|
2
2
|
|
|
3
|
+
## 2.3.14
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- abff210: fix: updates sidenav active state logic
|
|
8
|
+
- Updated dependencies [18b1be9]
|
|
9
|
+
- Updated dependencies [799845f]
|
|
10
|
+
- Updated dependencies [73f5553]
|
|
11
|
+
- @scalar/oas-utils@0.2.128
|
|
12
|
+
- @scalar/components@0.13.45
|
|
13
|
+
- @scalar/import@0.3.11
|
|
14
|
+
- @scalar/postman-to-openapi@0.2.1
|
|
15
|
+
- @scalar/use-codemirror@0.11.90
|
|
16
|
+
|
|
17
|
+
## 2.3.13
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- bf961b1: feat: show custom code examples in the API client
|
|
22
|
+
- a176b7e: fix: updates server dropdown item selected server logic
|
|
23
|
+
- Updated dependencies [018e8b2]
|
|
24
|
+
- Updated dependencies [bf961b1]
|
|
25
|
+
- Updated dependencies [018e8b2]
|
|
26
|
+
- Updated dependencies [018e8b2]
|
|
27
|
+
- Updated dependencies [a176b7e]
|
|
28
|
+
- @scalar/postman-to-openapi@0.2.0
|
|
29
|
+
- @scalar/oas-utils@0.2.127
|
|
30
|
+
- @scalar/import@0.3.10
|
|
31
|
+
- @scalar/components@0.13.44
|
|
32
|
+
- @scalar/use-codemirror@0.11.89
|
|
33
|
+
|
|
3
34
|
## 2.3.12
|
|
4
35
|
|
|
5
36
|
### Patch Changes
|
|
@@ -106,6 +106,9 @@ export declare const PaletteComponents: {
|
|
|
106
106
|
}[] | undefined;
|
|
107
107
|
requestBody?: any;
|
|
108
108
|
responses?: Record<string, any> | undefined;
|
|
109
|
+
'x-codeSamples'?: unknown;
|
|
110
|
+
'x-code-samples'?: unknown;
|
|
111
|
+
'x-custom-examples'?: unknown;
|
|
109
112
|
'x-scalar-stability'?: unknown;
|
|
110
113
|
method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
|
|
111
114
|
} & {
|
|
@@ -155,6 +158,9 @@ export declare const PaletteComponents: {
|
|
|
155
158
|
}[] | undefined;
|
|
156
159
|
requestBody?: any;
|
|
157
160
|
responses?: Record<string, any> | undefined;
|
|
161
|
+
'x-codeSamples'?: unknown;
|
|
162
|
+
'x-code-samples'?: unknown;
|
|
163
|
+
'x-custom-examples'?: unknown;
|
|
158
164
|
'x-scalar-stability'?: unknown;
|
|
159
165
|
method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
|
|
160
166
|
} & {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TheCommandPalette.vue.d.ts","sourceRoot":"","sources":["../../../src/components/CommandPalette/TheCommandPalette.vue"],"names":[],"mappings":"AAqcA;;;;GAIG;;AACH,wBA8gBI;AAEJ,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;mBA9iB9B,CAlRqC;qBAkRrC,CAjRY;;;;;;;mBAiRZ,CAlRqC;qBAkRrC,CAjRY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+
|
|
1
|
+
{"version":3,"file":"TheCommandPalette.vue.d.ts","sourceRoot":"","sources":["../../../src/components/CommandPalette/TheCommandPalette.vue"],"names":[],"mappings":"AAqcA;;;;GAIG;;AACH,wBA8gBI;AAEJ,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;mBA9iB9B,CAlRqC;qBAkRrC,CAjRY;;;;;;;mBAiRZ,CAlRqC;qBAkRrC,CAjRY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BA6pB0B,CAAC;;;;;;;;;;;;;;;+BAMf,CAAA;4BACnB,CAAC;2BACoB,CAAC;8BAC3B,CAAA;0BAEG,CAAC;2BAA0B,CAAC;yBAG7B,CAAC;4BAKQ,CAAC;6BACI,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BApBV,CAAC;;;;;;;;;;;;;;;+BAMf,CAAA;4BACnB,CAAC;2BACoB,CAAC;8BAC3B,CAAA;0BAEG,CAAC;2BAA0B,CAAC;yBAG7B,CAAC;4BAKQ,CAAC;6BACI,CAAC;+BAA8B,CAAC;;;;;;;;;;;;;;;;;;;CAuJtC,CAAA;AAEV,yCAAyC;AACzC,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,iBAAiB,CAAA;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B,CACA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServerDropdownItem.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Server/ServerDropdownItem.vue"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ServerDropdownItem.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Server/ServerDropdownItem.vue"],"names":[],"mappings":"AA4JA,OAAO,KAAK,EACV,UAAU,EACV,OAAO,IAAI,SAAS,EACpB,MAAM,EACP,MAAM,iCAAiC,CAAA;AASxC,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IAChC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,YAAY,EAAE;QACZ,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;QACjB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE,YAAY,GAAG,SAAS,CAAA;CAC/B,CAAC;;;;;;AAgOF,wBAQG"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import o from "./ServerDropdownItem.vue2.js";
|
|
2
2
|
/* empty css */
|
|
3
3
|
import r from "../../_virtual/_plugin-vue_export-helper.js";
|
|
4
|
-
const p = /* @__PURE__ */ r(o, [["__scopeId", "data-v-
|
|
4
|
+
const p = /* @__PURE__ */ r(o, [["__scopeId", "data-v-e86ebacd"]]);
|
|
5
5
|
export {
|
|
6
6
|
p as default
|
|
7
7
|
};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { defineComponent as
|
|
1
|
+
import { defineComponent as C, useId as O, computed as y, openBlock as c, createElementBlock as p, normalizeClass as V, createElementVNode as u, mergeProps as q, unref as a, createVNode as v, toDisplayString as M, withModifiers as E, createCommentVNode as h } from "vue";
|
|
2
2
|
import { ScalarListboxCheckbox as I, ScalarMarkdown as N } from "@scalar/components";
|
|
3
3
|
import B from "./ServerVariablesForm.vue.js";
|
|
4
4
|
import { useWorkspace as D } from "../../store/store.js";
|
|
5
|
-
const P = ["aria-expanded"], j = { class: "overflow-hidden text-ellipsis whitespace-nowrap" }, z = ["id"], L = { key: 0 }, W = { class: "description text-c-3 px-3 py-1.5" }, H = /* @__PURE__ */
|
|
5
|
+
const P = ["aria-expanded"], j = { class: "overflow-hidden text-ellipsis whitespace-nowrap" }, z = ["id"], L = { key: 0 }, W = { class: "description text-c-3 px-3 py-1.5" }, H = /* @__PURE__ */ C({
|
|
6
6
|
__name: "ServerDropdownItem",
|
|
7
7
|
props: {
|
|
8
8
|
collection: {},
|
|
@@ -13,9 +13,9 @@ const P = ["aria-expanded"], j = { class: "overflow-hidden text-ellipsis whitesp
|
|
|
13
13
|
},
|
|
14
14
|
emits: ["update:variable"],
|
|
15
15
|
setup(g, { emit: k }) {
|
|
16
|
-
const e = g, x = k, f =
|
|
16
|
+
const e = g, x = k, f = O(), { collectionMutators: m, requestMutators: l, servers: _ } = D(), U = (r, t) => {
|
|
17
17
|
var i, s, n, S;
|
|
18
|
-
if (b(
|
|
18
|
+
if (b(r) && (t == null || t.stopPropagation()), o.value) {
|
|
19
19
|
(s = (i = e.operation) == null ? void 0 : i.servers) != null && s.length && l.edit(e.operation.uid, "selectedServerUid", null), e.type === "collection" ? m.edit(
|
|
20
20
|
e.collection.uid,
|
|
21
21
|
"selectedServerUid",
|
|
@@ -26,22 +26,25 @@ const P = ["aria-expanded"], j = { class: "overflow-hidden text-ellipsis whitesp
|
|
|
26
26
|
e.type === "collection" && e.collection ? ((S = (n = e.operation) == null ? void 0 : n.servers) != null && S.length && l.edit(e.operation.uid, "selectedServerUid", null), m.edit(
|
|
27
27
|
e.collection.uid,
|
|
28
28
|
"selectedServerUid",
|
|
29
|
-
|
|
30
|
-
)) : e.type === "request" && e.operation && l.edit(e.operation.uid, "selectedServerUid",
|
|
31
|
-
}, o = y(() =>
|
|
32
|
-
|
|
29
|
+
r
|
|
30
|
+
)) : e.type === "request" && e.operation && l.edit(e.operation.uid, "selectedServerUid", r);
|
|
31
|
+
}, o = y(() => {
|
|
32
|
+
var r;
|
|
33
|
+
return e.type === "collection" ? e.collection.selectedServerUid === e.serverOption.id && !((r = e.operation) != null && r.selectedServerUid) : e.type === "request" && e.operation ? e.operation.selectedServerUid === e.serverOption.id : !1;
|
|
34
|
+
}), b = (r) => {
|
|
35
|
+
if (!r)
|
|
33
36
|
return !1;
|
|
34
|
-
const
|
|
35
|
-
return Object.keys((
|
|
37
|
+
const t = _[r];
|
|
38
|
+
return Object.keys((t == null ? void 0 : t.variables) ?? {}).length > 0;
|
|
36
39
|
}, d = y(
|
|
37
40
|
() => {
|
|
38
|
-
var
|
|
39
|
-
return o.value && b(((
|
|
41
|
+
var r;
|
|
42
|
+
return o.value && b(((r = e.server) == null ? void 0 : r.uid) ?? "");
|
|
40
43
|
}
|
|
41
|
-
),
|
|
42
|
-
x("update:variable",
|
|
44
|
+
), w = (r, t) => {
|
|
45
|
+
x("update:variable", r, t);
|
|
43
46
|
};
|
|
44
|
-
return (
|
|
47
|
+
return (r, t) => {
|
|
45
48
|
var i, s;
|
|
46
49
|
return c(), p("div", {
|
|
47
50
|
class: V(["group/item flex min-h-fit flex-col rounded border", { "border-transparent": !o.value }])
|
|
@@ -50,26 +53,26 @@ const P = ["aria-expanded"], j = { class: "overflow-hidden text-ellipsis whitesp
|
|
|
50
53
|
"aria-expanded": d.value,
|
|
51
54
|
class: ["flex min-h-8 cursor-pointer items-center gap-1.5 rounded px-1.5", o.value ? "text-c-1 bg-b-2" : "hover:bg-b-2"],
|
|
52
55
|
type: "button",
|
|
53
|
-
onClick:
|
|
56
|
+
onClick: t[0] || (t[0] = (n) => U(r.serverOption.id, n))
|
|
54
57
|
}), [
|
|
55
58
|
v(a(I), { selected: o.value }, null, 8, ["selected"]),
|
|
56
|
-
u("span", j, M(
|
|
59
|
+
u("span", j, M(r.serverOption.label), 1)
|
|
57
60
|
], 16, P),
|
|
58
61
|
d.value ? (c(), p("div", {
|
|
59
62
|
key: 0,
|
|
60
63
|
id: a(f),
|
|
61
64
|
class: "bg-b-2 divide divide-y rounded-b border-t *:pl-4",
|
|
62
|
-
onClick:
|
|
65
|
+
onClick: t[1] || (t[1] = E(() => {
|
|
63
66
|
}, ["stop"]))
|
|
64
67
|
}, [
|
|
65
68
|
v(B, {
|
|
66
|
-
variables: (i =
|
|
67
|
-
"onUpdate:variable":
|
|
69
|
+
variables: (i = r.server) == null ? void 0 : i.variables,
|
|
70
|
+
"onUpdate:variable": w
|
|
68
71
|
}, null, 8, ["variables"]),
|
|
69
|
-
(s =
|
|
72
|
+
(s = r.server) != null && s.description ? (c(), p("div", L, [
|
|
70
73
|
u("div", W, [
|
|
71
74
|
v(a(N), {
|
|
72
|
-
value:
|
|
75
|
+
value: r.server.description
|
|
73
76
|
}, null, 8, ["value"])
|
|
74
77
|
])
|
|
75
78
|
])) : h("", !0)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SideNav.vue.d.ts","sourceRoot":"","sources":["../../../src/components/SideNav/SideNav.vue"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"SideNav.vue.d.ts","sourceRoot":"","sources":["../../../src/components/SideNav/SideNav.vue"],"names":[],"mappings":";AAgRA,wBAMG"}
|
|
@@ -1,60 +1,60 @@
|
|
|
1
|
-
import { defineComponent as
|
|
2
|
-
import { ScalarIcon as
|
|
3
|
-
import { useRouter as
|
|
4
|
-
import { ROUTES as
|
|
5
|
-
import { PathId as
|
|
6
|
-
import
|
|
7
|
-
import
|
|
8
|
-
import
|
|
9
|
-
import
|
|
10
|
-
import { useActiveEntities as
|
|
11
|
-
import { useLayout as
|
|
12
|
-
const
|
|
1
|
+
import { defineComponent as k, openBlock as r, createElementBlock as a, normalizeClass as d, unref as e, createVNode as t, withCtx as s, createElementVNode as n, Fragment as w, renderList as b, createTextVNode as u, toDisplayString as y, createCommentVNode as S } from "vue";
|
|
2
|
+
import { ScalarIcon as C } from "@scalar/components";
|
|
3
|
+
import { useRouter as N } from "vue-router";
|
|
4
|
+
import { ROUTES as B } from "../../constants.js";
|
|
5
|
+
import { PathId as _ } from "../../routes.js";
|
|
6
|
+
import E from "./DownloadAppButton.vue.js";
|
|
7
|
+
import L from "./SideHelp.vue.js";
|
|
8
|
+
import g from "./SideNavGroup.vue.js";
|
|
9
|
+
import x from "./SideNavRouterLink.vue.js";
|
|
10
|
+
import { useActiveEntities as V } from "../../store/active-entities.js";
|
|
11
|
+
import { useLayout as j } from "../../hooks/useLayout.js";
|
|
12
|
+
const A = { class: "flex items-center" }, R = { class: "flex items-center" }, W = {
|
|
13
13
|
key: 0,
|
|
14
14
|
class: "hidden items-center justify-center sm:ml-1.5 sm:flex"
|
|
15
|
-
},
|
|
15
|
+
}, K = /* @__PURE__ */ k({
|
|
16
16
|
__name: "SideNav",
|
|
17
|
-
setup(
|
|
18
|
-
const { currentRoute: m } =
|
|
19
|
-
return (
|
|
17
|
+
setup($) {
|
|
18
|
+
const { currentRoute: m } = N(), { layout: i } = j(), { activeWorkspace: c } = V();
|
|
19
|
+
return (z, l) => (r(), a("nav", {
|
|
20
20
|
"aria-label": "App Navigation",
|
|
21
|
-
class:
|
|
21
|
+
class: d([
|
|
22
22
|
"app-drag-region flex items-center justify-center gap-1.5 pt-2 sm:justify-between",
|
|
23
23
|
e(i) === "web" ? "h-header border !pt-0" : "px-2 pb-2 sm:flex-col"
|
|
24
24
|
]),
|
|
25
25
|
role: "navigation"
|
|
26
26
|
}, [
|
|
27
|
-
t(
|
|
27
|
+
t(g, { class: "app-no-drag-region" }, {
|
|
28
28
|
default: s(() => [
|
|
29
29
|
n("a", {
|
|
30
|
-
class:
|
|
30
|
+
class: d(["ml-1 mr-3 hidden items-center", {
|
|
31
31
|
"sm:flex": e(i) === "web"
|
|
32
32
|
}]),
|
|
33
33
|
href: "https://www.scalar.com",
|
|
34
34
|
target: "_blank"
|
|
35
35
|
}, [
|
|
36
|
-
t(e(
|
|
36
|
+
t(e(C), {
|
|
37
37
|
icon: "Logo",
|
|
38
38
|
size: "xl"
|
|
39
39
|
})
|
|
40
40
|
], 2),
|
|
41
|
-
(
|
|
41
|
+
(r(!0), a(w, null, b(e(B).filter(
|
|
42
42
|
(o) => o.to.name !== "settings.default"
|
|
43
|
-
), ({ icon: o, to:
|
|
44
|
-
var f
|
|
45
|
-
return
|
|
46
|
-
t(
|
|
47
|
-
active:
|
|
43
|
+
), ({ icon: o, to: h, displayName: p }, v) => {
|
|
44
|
+
var f;
|
|
45
|
+
return r(), a("li", { key: v }, [
|
|
46
|
+
t(x, {
|
|
47
|
+
active: e(m).name === p.toLowerCase(),
|
|
48
48
|
icon: o,
|
|
49
49
|
to: {
|
|
50
|
-
...
|
|
50
|
+
...h,
|
|
51
51
|
params: {
|
|
52
|
-
[e(
|
|
52
|
+
[e(_).Workspace]: ((f = e(c)) == null ? void 0 : f.uid) ?? "default"
|
|
53
53
|
}
|
|
54
54
|
}
|
|
55
55
|
}, {
|
|
56
56
|
default: s(() => [
|
|
57
|
-
|
|
57
|
+
u(y(p), 1)
|
|
58
58
|
]),
|
|
59
59
|
_: 2
|
|
60
60
|
}, 1032, ["active", "icon", "to"])
|
|
@@ -63,32 +63,32 @@ const L = { class: "flex items-center" }, R = { class: "flex items-center" }, $
|
|
|
63
63
|
]),
|
|
64
64
|
_: 1
|
|
65
65
|
}),
|
|
66
|
-
t(
|
|
66
|
+
t(g, { class: "app-no-drag-region" }, {
|
|
67
67
|
default: s(() => {
|
|
68
68
|
var o;
|
|
69
69
|
return [
|
|
70
|
-
n("li",
|
|
71
|
-
t(
|
|
72
|
-
active: e(m).name === "settings
|
|
70
|
+
n("li", A, [
|
|
71
|
+
t(x, {
|
|
72
|
+
active: e(m).name === "settings",
|
|
73
73
|
icon: "Settings",
|
|
74
74
|
to: {
|
|
75
75
|
name: "settings.default",
|
|
76
76
|
params: {
|
|
77
|
-
[e(
|
|
77
|
+
[e(_).Workspace]: (o = e(c)) == null ? void 0 : o.uid
|
|
78
78
|
}
|
|
79
79
|
}
|
|
80
80
|
}, {
|
|
81
81
|
default: s(() => l[0] || (l[0] = [
|
|
82
|
-
|
|
82
|
+
u(" Settings ")
|
|
83
83
|
])),
|
|
84
84
|
_: 1
|
|
85
85
|
}, 8, ["active", "to"])
|
|
86
86
|
]),
|
|
87
87
|
n("li", R, [
|
|
88
|
-
t(
|
|
88
|
+
t(L)
|
|
89
89
|
]),
|
|
90
|
-
e(i) !== "desktop" ? (
|
|
91
|
-
t(
|
|
90
|
+
e(i) !== "desktop" ? (r(), a("li", W, [
|
|
91
|
+
t(E)
|
|
92
92
|
])) : S("", !0)
|
|
93
93
|
];
|
|
94
94
|
}),
|
|
@@ -98,5 +98,5 @@ const L = { class: "flex items-center" }, R = { class: "flex items-center" }, $
|
|
|
98
98
|
}
|
|
99
99
|
});
|
|
100
100
|
export {
|
|
101
|
-
|
|
101
|
+
K as default
|
|
102
102
|
};
|
|
@@ -268,6 +268,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
268
268
|
}[] | undefined;
|
|
269
269
|
requestBody?: any;
|
|
270
270
|
responses?: Record<string, any> | undefined;
|
|
271
|
+
'x-codeSamples'?: {
|
|
272
|
+
source: string;
|
|
273
|
+
label?: string | undefined;
|
|
274
|
+
lang?: string | undefined;
|
|
275
|
+
}[] | undefined;
|
|
276
|
+
'x-code-samples'?: {
|
|
277
|
+
source: string;
|
|
278
|
+
label?: string | undefined;
|
|
279
|
+
lang?: string | undefined;
|
|
280
|
+
}[] | undefined;
|
|
281
|
+
'x-custom-examples'?: {
|
|
282
|
+
source: string;
|
|
283
|
+
label?: string | undefined;
|
|
284
|
+
lang?: string | undefined;
|
|
285
|
+
}[] | undefined;
|
|
271
286
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
272
287
|
}>;
|
|
273
288
|
servers: Record<string, {
|
|
@@ -1189,6 +1204,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1189
1204
|
}[] | undefined;
|
|
1190
1205
|
requestBody?: any;
|
|
1191
1206
|
responses?: Record<string, any> | undefined;
|
|
1207
|
+
'x-codeSamples'?: {
|
|
1208
|
+
source: string;
|
|
1209
|
+
label?: string | undefined;
|
|
1210
|
+
lang?: string | undefined;
|
|
1211
|
+
}[] | undefined;
|
|
1212
|
+
'x-code-samples'?: {
|
|
1213
|
+
source: string;
|
|
1214
|
+
label?: string | undefined;
|
|
1215
|
+
lang?: string | undefined;
|
|
1216
|
+
}[] | undefined;
|
|
1217
|
+
'x-custom-examples'?: {
|
|
1218
|
+
source: string;
|
|
1219
|
+
label?: string | undefined;
|
|
1220
|
+
lang?: string | undefined;
|
|
1221
|
+
}[] | undefined;
|
|
1192
1222
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1193
1223
|
}) => void;
|
|
1194
1224
|
add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
|
|
@@ -1229,6 +1259,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1229
1259
|
}[] | undefined;
|
|
1230
1260
|
requestBody?: any;
|
|
1231
1261
|
responses?: Record<string, any> | undefined;
|
|
1262
|
+
'x-codeSamples'?: {
|
|
1263
|
+
source: string;
|
|
1264
|
+
label?: string | undefined;
|
|
1265
|
+
lang?: string | undefined;
|
|
1266
|
+
}[] | undefined;
|
|
1267
|
+
'x-code-samples'?: {
|
|
1268
|
+
source: string;
|
|
1269
|
+
label?: string | undefined;
|
|
1270
|
+
lang?: string | undefined;
|
|
1271
|
+
}[] | undefined;
|
|
1272
|
+
'x-custom-examples'?: {
|
|
1273
|
+
source: string;
|
|
1274
|
+
label?: string | undefined;
|
|
1275
|
+
lang?: string | undefined;
|
|
1276
|
+
}[] | undefined;
|
|
1232
1277
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1233
1278
|
};
|
|
1234
1279
|
delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
|
|
@@ -1270,9 +1315,24 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1270
1315
|
}[] | undefined;
|
|
1271
1316
|
requestBody?: any;
|
|
1272
1317
|
responses?: Record<string, any> | undefined;
|
|
1318
|
+
'x-codeSamples'?: {
|
|
1319
|
+
source: string;
|
|
1320
|
+
label?: string | undefined;
|
|
1321
|
+
lang?: string | undefined;
|
|
1322
|
+
}[] | undefined;
|
|
1323
|
+
'x-code-samples'?: {
|
|
1324
|
+
source: string;
|
|
1325
|
+
label?: string | undefined;
|
|
1326
|
+
lang?: string | undefined;
|
|
1327
|
+
}[] | undefined;
|
|
1328
|
+
'x-custom-examples'?: {
|
|
1329
|
+
source: string;
|
|
1330
|
+
label?: string | undefined;
|
|
1331
|
+
lang?: string | undefined;
|
|
1332
|
+
}[] | undefined;
|
|
1273
1333
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1274
1334
|
}) => void;
|
|
1275
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
|
|
1335
|
+
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
|
|
1276
1336
|
uid: string & import("zod").BRAND<"operation">;
|
|
1277
1337
|
path: string;
|
|
1278
1338
|
type: "request";
|
|
@@ -1310,8 +1370,23 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1310
1370
|
}[] | undefined;
|
|
1311
1371
|
requestBody?: any;
|
|
1312
1372
|
responses?: Record<string, any> | undefined;
|
|
1373
|
+
'x-codeSamples'?: {
|
|
1374
|
+
source: string;
|
|
1375
|
+
label?: string | undefined;
|
|
1376
|
+
lang?: string | undefined;
|
|
1377
|
+
}[] | undefined;
|
|
1378
|
+
'x-code-samples'?: {
|
|
1379
|
+
source: string;
|
|
1380
|
+
label?: string | undefined;
|
|
1381
|
+
lang?: string | undefined;
|
|
1382
|
+
}[] | undefined;
|
|
1383
|
+
'x-custom-examples'?: {
|
|
1384
|
+
source: string;
|
|
1385
|
+
label?: string | undefined;
|
|
1386
|
+
lang?: string | undefined;
|
|
1387
|
+
}[] | undefined;
|
|
1313
1388
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1314
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1389
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1315
1390
|
uid: string & import("zod").BRAND<"operation">;
|
|
1316
1391
|
path: string;
|
|
1317
1392
|
type: "request";
|
|
@@ -1349,6 +1424,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1349
1424
|
}[] | undefined;
|
|
1350
1425
|
requestBody?: any;
|
|
1351
1426
|
responses?: Record<string, any> | undefined;
|
|
1427
|
+
'x-codeSamples'?: {
|
|
1428
|
+
source: string;
|
|
1429
|
+
label?: string | undefined;
|
|
1430
|
+
lang?: string | undefined;
|
|
1431
|
+
}[] | undefined;
|
|
1432
|
+
'x-code-samples'?: {
|
|
1433
|
+
source: string;
|
|
1434
|
+
label?: string | undefined;
|
|
1435
|
+
lang?: string | undefined;
|
|
1436
|
+
}[] | undefined;
|
|
1437
|
+
'x-custom-examples'?: {
|
|
1438
|
+
source: string;
|
|
1439
|
+
label?: string | undefined;
|
|
1440
|
+
lang?: string | undefined;
|
|
1441
|
+
}[] | undefined;
|
|
1352
1442
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1353
1443
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1354
1444
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1388,9 +1478,24 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1388
1478
|
}[] | undefined;
|
|
1389
1479
|
requestBody?: any;
|
|
1390
1480
|
responses?: Record<string, any> | undefined;
|
|
1481
|
+
'x-codeSamples'?: {
|
|
1482
|
+
source: string;
|
|
1483
|
+
label?: string | undefined;
|
|
1484
|
+
lang?: string | undefined;
|
|
1485
|
+
}[] | undefined;
|
|
1486
|
+
'x-code-samples'?: {
|
|
1487
|
+
source: string;
|
|
1488
|
+
label?: string | undefined;
|
|
1489
|
+
lang?: string | undefined;
|
|
1490
|
+
}[] | undefined;
|
|
1491
|
+
'x-custom-examples'?: {
|
|
1492
|
+
source: string;
|
|
1493
|
+
label?: string | undefined;
|
|
1494
|
+
lang?: string | undefined;
|
|
1495
|
+
}[] | undefined;
|
|
1391
1496
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1392
1497
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1393
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
|
|
1498
|
+
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
|
|
1394
1499
|
uid: string & import("zod").BRAND<"operation">;
|
|
1395
1500
|
path: string;
|
|
1396
1501
|
type: "request";
|
|
@@ -1428,8 +1533,23 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1428
1533
|
}[] | undefined;
|
|
1429
1534
|
requestBody?: any;
|
|
1430
1535
|
responses?: Record<string, any> | undefined;
|
|
1536
|
+
'x-codeSamples'?: {
|
|
1537
|
+
source: string;
|
|
1538
|
+
label?: string | undefined;
|
|
1539
|
+
lang?: string | undefined;
|
|
1540
|
+
}[] | undefined;
|
|
1541
|
+
'x-code-samples'?: {
|
|
1542
|
+
source: string;
|
|
1543
|
+
label?: string | undefined;
|
|
1544
|
+
lang?: string | undefined;
|
|
1545
|
+
}[] | undefined;
|
|
1546
|
+
'x-custom-examples'?: {
|
|
1547
|
+
source: string;
|
|
1548
|
+
label?: string | undefined;
|
|
1549
|
+
lang?: string | undefined;
|
|
1550
|
+
}[] | undefined;
|
|
1431
1551
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1432
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1552
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1433
1553
|
uid: string & import("zod").BRAND<"operation">;
|
|
1434
1554
|
path: string;
|
|
1435
1555
|
type: "request";
|
|
@@ -1467,6 +1587,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1467
1587
|
}[] | undefined;
|
|
1468
1588
|
requestBody?: any;
|
|
1469
1589
|
responses?: Record<string, any> | undefined;
|
|
1590
|
+
'x-codeSamples'?: {
|
|
1591
|
+
source: string;
|
|
1592
|
+
label?: string | undefined;
|
|
1593
|
+
lang?: string | undefined;
|
|
1594
|
+
}[] | undefined;
|
|
1595
|
+
'x-code-samples'?: {
|
|
1596
|
+
source: string;
|
|
1597
|
+
label?: string | undefined;
|
|
1598
|
+
lang?: string | undefined;
|
|
1599
|
+
}[] | undefined;
|
|
1600
|
+
'x-custom-examples'?: {
|
|
1601
|
+
source: string;
|
|
1602
|
+
label?: string | undefined;
|
|
1603
|
+
lang?: string | undefined;
|
|
1604
|
+
}[] | undefined;
|
|
1470
1605
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1471
1606
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1472
1607
|
uid: string & import("zod").BRAND<"operation">;
|
|
@@ -1506,6 +1641,21 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
|
|
|
1506
1641
|
}[] | undefined;
|
|
1507
1642
|
requestBody?: any;
|
|
1508
1643
|
responses?: Record<string, any> | undefined;
|
|
1644
|
+
'x-codeSamples'?: {
|
|
1645
|
+
source: string;
|
|
1646
|
+
label?: string | undefined;
|
|
1647
|
+
lang?: string | undefined;
|
|
1648
|
+
}[] | undefined;
|
|
1649
|
+
'x-code-samples'?: {
|
|
1650
|
+
source: string;
|
|
1651
|
+
label?: string | undefined;
|
|
1652
|
+
lang?: string | undefined;
|
|
1653
|
+
}[] | undefined;
|
|
1654
|
+
'x-custom-examples'?: {
|
|
1655
|
+
source: string;
|
|
1656
|
+
label?: string | undefined;
|
|
1657
|
+
lang?: string | undefined;
|
|
1658
|
+
}[] | undefined;
|
|
1509
1659
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
1510
1660
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1511
1661
|
undo: (uid: string & import("zod").BRAND<"operation">) => void;
|