@scalar/api-reference 1.28.9 → 1.28.11

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.
Files changed (41) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/dist/browser/standalone.js +5570 -5486
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/components/ApiReferenceLayout.vue.js +2 -2
  5. package/dist/components/ApiReferenceLayout.vue2.js +13 -13
  6. package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
  7. package/dist/components/Content/Models/Models.vue.js +2 -2
  8. package/dist/components/Content/Schema/Schema.vue.d.ts +2 -0
  9. package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
  10. package/dist/components/Content/Schema/Schema.vue.js +4 -4
  11. package/dist/components/Content/Schema/Schema.vue2.js +78 -54
  12. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  13. package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
  14. package/dist/components/Content/Schema/SchemaProperty.vue2.js +96 -114
  15. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts +8 -0
  16. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts.map +1 -0
  17. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.js +7 -0
  18. package/dist/components/Content/Schema/SchemaPropertyExamples.vue2.js +71 -0
  19. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts +2 -0
  20. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
  21. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +1 -1
  22. package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +139 -130
  23. package/dist/features/ApiClientModal/useApiClient.d.ts +76 -334
  24. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  25. package/dist/features/ExampleResponses/ExampleResponses.vue.d.ts.map +1 -1
  26. package/dist/features/ExampleResponses/ExampleResponses.vue.js +2 -2
  27. package/dist/features/ExampleResponses/ExampleResponses.vue2.js +86 -85
  28. package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
  29. package/dist/features/Operation/components/RequestBody.vue.js +2 -2
  30. package/dist/features/Operation/components/RequestBody.vue2.js +65 -28
  31. package/dist/features/Search/useSearchIndex.js +72 -72
  32. package/dist/helpers/get-request.d.ts.map +1 -1
  33. package/dist/hooks/useMultipleDocuments.d.ts +5 -1
  34. package/dist/hooks/useMultipleDocuments.d.ts.map +1 -1
  35. package/dist/hooks/useMultipleDocuments.js +49 -48
  36. package/dist/hooks/useNavState.d.ts +6 -4
  37. package/dist/hooks/useNavState.d.ts.map +1 -1
  38. package/dist/hooks/useNavState.js +34 -37
  39. package/dist/index.js +1 -1
  40. package/dist/style.css +1 -1
  41. package/package.json +12 -12
@@ -1,228 +1,237 @@
1
- import { defineComponent as M, openBlock as r, createElementBlock as n, normalizeClass as V, renderSlot as w, Fragment as m, createTextVNode as u, createCommentVNode as t, toDisplayString as i, createVNode as s, unref as A, withCtx as a, createBlock as d } from "vue";
2
- import p from "../../ScreenReader.vue.js";
1
+ import { defineComponent as F, openBlock as r, createElementBlock as i, normalizeClass as O, renderSlot as V, Fragment as d, createTextVNode as a, createCommentVNode as u, toDisplayString as n, createVNode as s, unref as y, withCtx as t, createBlock as m } from "vue";
2
+ import { discriminators as z } from "./helpers/optimizeValueForDisplay.js";
3
+ import H from "./SchemaPropertyExamples.vue.js";
4
+ import v from "../../ScreenReader.vue.js";
3
5
  import o from "./SchemaPropertyDetail.vue.js";
4
- import C from "../../Badge/Badge.vue.js";
5
- const $ = { class: "property-heading" }, D = {
6
+ import $ from "../../Badge/Badge.vue.js";
7
+ const R = { class: "property-heading" }, G = {
6
8
  key: 1,
7
9
  class: "property-additional"
8
- }, F = {
10
+ }, J = {
9
11
  key: 2,
10
12
  class: "property-pattern"
11
- }, O = {
13
+ }, K = {
12
14
  key: 3,
13
15
  class: "property-deprecated"
14
- }, T = {
16
+ }, Q = {
15
17
  key: 4,
16
18
  class: "property-const"
17
- }, j = {
19
+ }, U = {
18
20
  key: 7,
19
21
  class: "property-write-only"
20
- }, z = {
22
+ }, W = {
21
23
  key: 8,
22
24
  class: "property-read-only"
23
- }, E = {
25
+ }, X = {
24
26
  key: 9,
25
27
  class: "property-required"
26
- }, Q = /* @__PURE__ */ M({
28
+ }, ee = /* @__PURE__ */ F({
27
29
  __name: "SchemaPropertyHeading",
28
30
  props: {
29
31
  value: {},
30
32
  enum: { type: Boolean },
31
33
  required: { type: Boolean, default: !1 },
32
34
  additional: { type: Boolean },
33
- pattern: { type: Boolean }
35
+ pattern: { type: Boolean },
36
+ withExamples: { type: Boolean, default: !0 }
34
37
  },
35
- setup(H) {
36
- const L = (e) => Array.isArray(e == null ? void 0 : e.default) && e.default.length === 1 ? e.default[0] : e == null ? void 0 : e.default;
38
+ setup(j) {
39
+ const p = j, D = z.find((e) => !p.value || typeof p.value != "object" ? !1 : e in p.value || p.value.items && typeof p.value.items == "object" && e in p.value.items), T = (e) => Array.isArray(e == null ? void 0 : e.default) && e.default.length === 1 ? e.default[0] : e == null ? void 0 : e.default;
37
40
  return (e, l) => {
38
- var y, v, f, k, g, B, q, I, N;
39
- return r(), n("div", $, [
40
- e.$slots.name ? (r(), n("div", {
41
+ var f, k, g, B, b, q, w, P, S, I, N, A, C;
42
+ return r(), i("div", R, [
43
+ e.$slots.name ? (r(), i("div", {
41
44
  key: 0,
42
- class: V(["property-name", { deprecated: (y = e.value) == null ? void 0 : y.deprecated }])
45
+ class: O(["property-name", { deprecated: (f = e.value) == null ? void 0 : f.deprecated }])
43
46
  }, [
44
- e.pattern ? (r(), n(m, { key: 1 }, [
45
- l[0] || (l[0] = u("/")),
46
- w(e.$slots, "name", {}, void 0, !0),
47
- l[1] || (l[1] = u("/"))
48
- ], 64)) : w(e.$slots, "name", { key: 0 }, void 0, !0)
49
- ], 2)) : t("", !0),
50
- e.additional ? (r(), n("div", D, [
51
- (v = e.value) != null && v["x-additionalPropertiesName"] ? (r(), n(m, { key: 0 }, [
52
- u(i(e.value["x-additionalPropertiesName"]), 1)
53
- ], 64)) : (r(), n(m, { key: 1 }, [
54
- u("additional properties")
47
+ e.pattern ? (r(), i(d, { key: 1 }, [
48
+ l[0] || (l[0] = a("/")),
49
+ V(e.$slots, "name", {}, void 0, !0),
50
+ l[1] || (l[1] = a("/"))
51
+ ], 64)) : V(e.$slots, "name", { key: 0 }, void 0, !0)
52
+ ], 2)) : u("", !0),
53
+ e.additional ? (r(), i("div", G, [
54
+ (k = e.value) != null && k["x-additionalPropertiesName"] ? (r(), i(d, { key: 0 }, [
55
+ a(n(e.value["x-additionalPropertiesName"]), 1)
56
+ ], 64)) : (r(), i(d, { key: 1 }, [
57
+ a("additional properties")
55
58
  ], 64))
56
- ])) : t("", !0),
57
- e.pattern ? (r(), n("div", F, [
58
- s(A(C), null, {
59
- default: a(() => l[2] || (l[2] = [
60
- u("pattern")
59
+ ])) : u("", !0),
60
+ e.pattern ? (r(), i("div", J, [
61
+ s(y($), null, {
62
+ default: t(() => l[2] || (l[2] = [
63
+ a("pattern")
61
64
  ])),
62
65
  _: 1
63
66
  })
64
- ])) : t("", !0),
65
- (f = e.value) != null && f.deprecated ? (r(), n("div", O, [
66
- s(A(C), null, {
67
- default: a(() => l[3] || (l[3] = [
68
- u("deprecated")
67
+ ])) : u("", !0),
68
+ (g = e.value) != null && g.deprecated ? (r(), i("div", K, [
69
+ s(y($), null, {
70
+ default: t(() => l[3] || (l[3] = [
71
+ a("deprecated")
69
72
  ])),
70
73
  _: 1
71
74
  })
72
- ])) : t("", !0),
73
- (k = e.value) != null && k.const || (g = e.value) != null && g.enum && e.value.enum.length === 1 ? (r(), n("div", T, [
75
+ ])) : u("", !0),
76
+ (B = e.value) != null && B.const || (b = e.value) != null && b.enum && e.value.enum.length === 1 ? (r(), i("div", Q, [
74
77
  s(o, { truncate: "" }, {
75
- prefix: a(() => l[4] || (l[4] = [
76
- u("const:")
78
+ prefix: t(() => l[4] || (l[4] = [
79
+ a("const:")
77
80
  ])),
78
- default: a(() => [
79
- u(" " + i(e.value.const ?? e.value.enum[0]), 1)
81
+ default: t(() => [
82
+ a(" " + n(e.value.const ?? e.value.enum[0]), 1)
80
83
  ]),
81
84
  _: 1
82
85
  })
83
- ])) : (B = e.value) != null && B.type ? (r(), n(m, { key: 5 }, [
86
+ ])) : (q = e.value) != null && q.type ? (r(), i(d, { key: 5 }, [
84
87
  s(o, null, {
85
- default: a(() => {
86
- var P, S, b;
88
+ default: t(() => {
89
+ var E, L, M;
87
90
  return [
88
- s(p, null, {
89
- default: a(() => l[5] || (l[5] = [
90
- u("Type:")
91
+ s(v, null, {
92
+ default: t(() => l[5] || (l[5] = [
93
+ a("Type:")
91
94
  ])),
92
95
  _: 1
93
96
  }),
94
- (S = (P = e.value) == null ? void 0 : P.items) != null && S.type ? (r(), n(m, { key: 0 }, [
95
- u(i(e.value.type) + " " + i(e.value.items.type) + "[] ", 1)
96
- ], 64)) : (r(), n(m, { key: 1 }, [
97
- u(i(Array.isArray(e.value.type) ? e.value.type.join(" | ") : e.value.type) + " " + i((b = e.value) != null && b.nullable ? " | nullable" : ""), 1)
97
+ (L = (E = e.value) == null ? void 0 : E.items) != null && L.type ? (r(), i(d, { key: 0 }, [
98
+ a(n(e.value.type) + " " + n(e.value.items.type) + "[] ", 1)
99
+ ], 64)) : (r(), i(d, { key: 1 }, [
100
+ a(n(Array.isArray(e.value.type) ? e.value.type.join(" | ") : e.value.type) + " " + n((M = e.value) != null && M.nullable ? " | nullable" : ""), 1)
98
101
  ], 64)),
99
- e.value.minItems || e.value.maxItems ? (r(), n(m, { key: 2 }, [
100
- u(i(e.value.minItems) + "…" + i(e.value.maxItems), 1)
101
- ], 64)) : t("", !0)
102
+ e.value.minItems || e.value.maxItems ? (r(), i(d, { key: 2 }, [
103
+ a(n(e.value.minItems) + "…" + n(e.value.maxItems), 1)
104
+ ], 64)) : u("", !0)
102
105
  ];
103
106
  }),
104
107
  _: 1
105
108
  }),
106
- e.value.minLength ? (r(), d(o, { key: 0 }, {
107
- prefix: a(() => l[6] || (l[6] = [
108
- u("min:")
109
+ e.value.minLength ? (r(), m(o, { key: 0 }, {
110
+ prefix: t(() => l[6] || (l[6] = [
111
+ a("min:")
109
112
  ])),
110
- default: a(() => [
111
- u(" " + i(e.value.minLength), 1)
113
+ default: t(() => [
114
+ a(" " + n(e.value.minLength), 1)
112
115
  ]),
113
116
  _: 1
114
- })) : t("", !0),
115
- e.value.maxLength ? (r(), d(o, { key: 1 }, {
116
- prefix: a(() => l[7] || (l[7] = [
117
- u("max:")
117
+ })) : u("", !0),
118
+ e.value.maxLength ? (r(), m(o, { key: 1 }, {
119
+ prefix: t(() => l[7] || (l[7] = [
120
+ a("max:")
118
121
  ])),
119
- default: a(() => [
120
- u(" " + i(e.value.maxLength), 1)
122
+ default: t(() => [
123
+ a(" " + n(e.value.maxLength), 1)
121
124
  ]),
122
125
  _: 1
123
- })) : t("", !0),
124
- e.value.uniqueItems ? (r(), d(o, { key: 2 }, {
125
- default: a(() => l[8] || (l[8] = [
126
- u(" unique! ")
126
+ })) : u("", !0),
127
+ e.value.uniqueItems ? (r(), m(o, { key: 2 }, {
128
+ default: t(() => l[8] || (l[8] = [
129
+ a(" unique! ")
127
130
  ])),
128
131
  _: 1
129
- })) : t("", !0),
130
- e.value.format ? (r(), d(o, { key: 3 }, {
131
- default: a(() => [
132
- s(p, null, {
133
- default: a(() => l[9] || (l[9] = [
134
- u("Format:")
132
+ })) : u("", !0),
133
+ e.value.format ? (r(), m(o, { key: 3 }, {
134
+ default: t(() => [
135
+ s(v, null, {
136
+ default: t(() => l[9] || (l[9] = [
137
+ a("Format:")
135
138
  ])),
136
139
  _: 1
137
140
  }),
138
- u(" " + i(e.value.format), 1)
141
+ a(" " + n(e.value.format), 1)
139
142
  ]),
140
143
  _: 1
141
- })) : t("", !0),
142
- e.value.minimum !== void 0 && e.value.exclusiveMinimum ? (r(), d(o, { key: 4 }, {
143
- prefix: a(() => l[10] || (l[10] = [
144
- u("greater than:")
144
+ })) : u("", !0),
145
+ e.value.minimum !== void 0 && e.value.exclusiveMinimum ? (r(), m(o, { key: 4 }, {
146
+ prefix: t(() => l[10] || (l[10] = [
147
+ a("greater than:")
145
148
  ])),
146
- default: a(() => [
147
- u(" " + i(e.value.minimum), 1)
149
+ default: t(() => [
150
+ a(" " + n(e.value.minimum), 1)
148
151
  ]),
149
152
  _: 1
150
- })) : t("", !0),
151
- e.value.minimum !== void 0 && !e.value.exclusiveMinimum ? (r(), d(o, { key: 5 }, {
152
- prefix: a(() => l[11] || (l[11] = [
153
- u("min:")
153
+ })) : u("", !0),
154
+ e.value.minimum !== void 0 && !e.value.exclusiveMinimum ? (r(), m(o, { key: 5 }, {
155
+ prefix: t(() => l[11] || (l[11] = [
156
+ a("min:")
154
157
  ])),
155
- default: a(() => [
156
- u(" " + i(e.value.minimum), 1)
158
+ default: t(() => [
159
+ a(" " + n(e.value.minimum), 1)
157
160
  ]),
158
161
  _: 1
159
- })) : t("", !0),
160
- e.value.maximum !== void 0 && e.value.exclusiveMaximum ? (r(), d(o, { key: 6 }, {
161
- prefix: a(() => l[12] || (l[12] = [
162
- u("less than:")
162
+ })) : u("", !0),
163
+ e.value.maximum !== void 0 && e.value.exclusiveMaximum ? (r(), m(o, { key: 6 }, {
164
+ prefix: t(() => l[12] || (l[12] = [
165
+ a("less than:")
163
166
  ])),
164
- default: a(() => [
165
- u(" " + i(e.value.maximum), 1)
167
+ default: t(() => [
168
+ a(" " + n(e.value.maximum), 1)
166
169
  ]),
167
170
  _: 1
168
- })) : t("", !0),
169
- e.value.maximum !== void 0 && !e.value.exclusiveMaximum ? (r(), d(o, { key: 7 }, {
170
- prefix: a(() => l[13] || (l[13] = [
171
- u("max:")
171
+ })) : u("", !0),
172
+ e.value.maximum !== void 0 && !e.value.exclusiveMaximum ? (r(), m(o, { key: 7 }, {
173
+ prefix: t(() => l[13] || (l[13] = [
174
+ a("max:")
172
175
  ])),
173
- default: a(() => [
174
- u(" " + i(e.value.maximum), 1)
176
+ default: t(() => [
177
+ a(" " + n(e.value.maximum), 1)
175
178
  ]),
176
179
  _: 1
177
- })) : t("", !0),
178
- e.value.pattern ? (r(), d(o, {
180
+ })) : u("", !0),
181
+ e.value.pattern ? (r(), m(o, {
179
182
  key: 8,
180
183
  code: "",
181
184
  truncate: ""
182
185
  }, {
183
- default: a(() => [
184
- s(p, null, {
185
- default: a(() => l[14] || (l[14] = [
186
- u("Pattern:")
186
+ default: t(() => [
187
+ s(v, null, {
188
+ default: t(() => l[14] || (l[14] = [
189
+ a("Pattern:")
187
190
  ])),
188
191
  _: 1
189
192
  }),
190
- u(" " + i(e.value.pattern), 1)
193
+ a(" " + n(e.value.pattern), 1)
191
194
  ]),
192
195
  _: 1
193
- })) : t("", !0),
194
- e.$props.enum ? (r(), d(o, { key: 9 }, {
195
- default: a(() => l[15] || (l[15] = [
196
- u("enum")
196
+ })) : u("", !0),
197
+ e.$props.enum ? (r(), m(o, { key: 9 }, {
198
+ default: t(() => l[15] || (l[15] = [
199
+ a("enum")
197
200
  ])),
198
201
  _: 1
199
- })) : t("", !0),
200
- e.value.default !== void 0 ? (r(), d(o, {
202
+ })) : u("", !0),
203
+ e.value.default !== void 0 ? (r(), m(o, {
201
204
  key: 10,
202
205
  truncate: ""
203
206
  }, {
204
- prefix: a(() => l[16] || (l[16] = [
205
- u("default:")
207
+ prefix: t(() => l[16] || (l[16] = [
208
+ a("default:")
206
209
  ])),
207
- default: a(() => [
208
- u(" " + i(L(e.value)), 1)
210
+ default: t(() => [
211
+ a(" " + n(T(e.value)), 1)
209
212
  ]),
210
213
  _: 1
211
- })) : t("", !0)
212
- ], 64)) : (r(), n(m, { key: 6 }, [
213
- ((q = e.value) == null ? void 0 : q.nullable) === !0 ? (r(), d(o, { key: 0 }, {
214
- default: a(() => l[17] || (l[17] = [
215
- u(" nullable ")
214
+ })) : u("", !0)
215
+ ], 64)) : (r(), i(d, { key: 6 }, [
216
+ ((w = e.value) == null ? void 0 : w.nullable) === !0 ? (r(), m(o, { key: 0 }, {
217
+ default: t(() => l[17] || (l[17] = [
218
+ a(" nullable ")
216
219
  ])),
217
220
  _: 1
218
- })) : t("", !0)
221
+ })) : u("", !0)
219
222
  ], 64)),
220
- (I = e.value) != null && I.writeOnly ? (r(), n("div", j, " write-only ")) : (N = e.value) != null && N.readOnly ? (r(), n("div", z, " read-only ")) : t("", !0),
221
- e.required ? (r(), n("div", E, " required ")) : t("", !0)
223
+ (P = e.value) != null && P.writeOnly ? (r(), i("div", U, " write-only ")) : (S = e.value) != null && S.readOnly ? (r(), i("div", W, " read-only ")) : u("", !0),
224
+ e.required ? (r(), i("div", X, " required ")) : u("", !0),
225
+ e.withExamples ? (r(), m(H, {
226
+ key: 10,
227
+ examples: (I = e.value) == null ? void 0 : I.examples,
228
+ example: ((N = e.value) == null ? void 0 : N.example) || ((C = (A = e.value) == null ? void 0 : A.items) == null ? void 0 : C.example),
229
+ "discriminator-type": y(D)
230
+ }, null, 8, ["examples", "example", "discriminator-type"])) : u("", !0)
222
231
  ]);
223
232
  };
224
233
  }
225
234
  });
226
235
  export {
227
- Q as default
236
+ ee as default
228
237
  };