@scalar/api-reference 1.25.102 → 1.25.104

package/dist/features/Operation/layouts/ClassicLayout.vue2.js

@@ -1,120 +1,127 @@
-import { defineComponent as m, inject as u, openBlock as r, createBlock as s, unref as o, createSlots as f, withCtx as n, createElementVNode as t, createVNode as i, toDisplayString as h, createCommentVNode as _, withModifiers as v } from "vue";
+import { defineComponent as u, inject as f, openBlock as a, createBlock as s, unref as o, createSlots as h, withCtx as r, createElementVNode as t, createVNode as i, toDisplayString as _, createCommentVNode as y, withModifiers as v } from "vue";
 import C from "../../../components/OperationPath.vue.js";
-import { ScalarIcon as y, ScalarIconButton as b, ScalarMarkdown as S } from "@scalar/components";
-import { useClipboard as k } from "@scalar/use-hooks/useClipboard";
-import T from "../components/OperationParameters.vue.js";
-import q from "../components/OperationResponses.vue.js";
+import { ScalarIcon as q, ScalarIconButton as E, ScalarMarkdown as b } from "@scalar/components";
+import { useClipboard as S } from "@scalar/use-hooks/useClipboard";
+import k from "../components/OperationParameters.vue.js";
+import T from "../components/OperationResponses.vue.js";
 import B from "../../../components/Section/SectionAccordion.vue.js";
-import E from "../../../components/HttpMethod/HttpMethod.vue.js";
-import R from "../../../components/Anchor/Anchor.vue.js";
-import I from "../../TestRequestButton/TestRequestButton.vue.js";
-import g from "../../ExampleResponses/ExampleResponses.vue.js";
-import w from "../../ExampleRequest/ExampleRequest.vue.js";
-import { HIDE_TEST_REQUEST_BUTTON_SYMBOL as N } from "../../../helpers/provideSymbols.js";
-const V = { class: "operation-title" }, $ = { class: "operation-details" }, L = { class: "endpoint-label" }, M = { class: "endpoint-label-path" }, O = { class: "endpoint-label-name" }, U = { class: "endpoint-content" }, A = { class: "operation-details-card" }, D = { class: "operation-details-card-item" }, H = { class: "operation-details-card-item" }, te = /* @__PURE__ */ m({
+import R from "../../../components/HttpMethod/HttpMethod.vue.js";
+import I from "../../../components/Anchor/Anchor.vue.js";
+import g from "../../TestRequestButton/TestRequestButton.vue.js";
+import w from "../../ExampleResponses/ExampleResponses.vue.js";
+import N from "../../ExampleRequest/ExampleRequest.vue.js";
+import { HIDE_TEST_REQUEST_BUTTON_SYMBOL as V } from "../../../helpers/provideSymbols.js";
+const $ = { class: "operation-title" }, L = { class: "operation-details" }, M = { class: "endpoint-label" }, O = { class: "endpoint-label-path" }, U = { class: "endpoint-label-name" }, A = { class: "endpoint-content" }, D = { class: "operation-details-card" }, H = { class: "operation-details-card-item" }, P = { class: "operation-details-card-item" }, ie = /* @__PURE__ */ u({
   __name: "ClassicLayout",
   props: {
     id: {},
+    requestEntity: {},
     operation: {},
     request: {},
     secretCredentials: {}
   },
-  setup(P) {
-    const { copyToClipboard: d } = k(), c = u(N);
-    return (e, p) => (r(), s(o(B), {
-      id: e.id,
-      class: "reference-endpoint",
-      transparent: ""
-    }, f({
-      title: n(() => [
-        t("h3", V, [
-          t("div", $, [
-            i(o(E), {
-              class: "endpoint-type",
-              method: e.operation.httpVerb,
-              short: ""
-            }, null, 8, ["method"]),
-            i(o(R), {
-              id: e.id ?? "",
-              class: "endpoint-anchor"
-            }, {
-              default: n(() => {
-                var a;
-                return [
-                  t("div", L, [
+  setup(j) {
+    const { copyToClipboard: c } = S(), m = f(V);
+    return (e, p) => {
+      var l;
+      return a(), s(o(B), {
+        id: e.id,
+        class: "reference-endpoint",
+        transparent: ""
+      }, h({
+        title: r(() => [
+          t("h3", $, [
+            t("div", L, [
+              i(o(R), {
+                class: "endpoint-type",
+                method: e.operation.httpVerb,
+                short: ""
+              }, null, 8, ["method"]),
+              i(o(I), {
+                id: e.id ?? "",
+                class: "endpoint-anchor"
+              }, {
+                default: r(() => {
+                  var n;
+                  return [
                     t("div", M, [
-                      i(C, {
-                        deprecated: (a = e.operation.information) == null ? void 0 : a.deprecated,
-                        path: e.operation.path
-                      }, null, 8, ["deprecated", "path"])
-                    ]),
-                    t("div", O, h(e.operation.name), 1)
-                  ])
-                ];
-              }),
-              _: 1
-            }, 8, ["id"])
+                      t("div", O, [
+                        i(C, {
+                          deprecated: (n = e.operation.information) == null ? void 0 : n.deprecated,
+                          path: e.operation.path
+                        }, null, 8, ["deprecated", "path"])
+                      ]),
+                      t("div", U, _(e.operation.name), 1)
+                    ])
+                  ];
+                }),
+                _: 1
+              }, 8, ["id"])
+            ])
           ])
-        ])
-      ]),
-      actions: n(({ active: a }) => {
-        var l;
-        return [
-          a ? (r(), s(o(I), {
-            key: 0,
-            operation: e.operation
-          }, null, 8, ["operation"])) : (l = o(c)) != null && l() ? _("", !0) : (r(), s(o(y), {
-            key: 1,
-            class: "endpoint-try-hint",
-            icon: "Play",
-            thickness: "1.75px"
-          })),
-          i(o(b), {
-            class: "endpoint-copy",
-            icon: "Clipboard",
-            label: "Copy endpoint URL",
-            size: "xs",
-            variant: "ghost",
-            onClick: p[0] || (p[0] = v((j) => o(d)(e.operation.path), ["stop"]))
-          })
-        ];
-      }),
-      default: n(() => [
-        t("div", U, [
+        ]),
+        actions: r(({ active: n }) => {
+          var d;
+          return [
+            n ? (a(), s(o(g), {
+              key: 0,
+              operation: e.operation
+            }, null, 8, ["operation"])) : (d = o(m)) != null && d() ? y("", !0) : (a(), s(o(q), {
+              key: 1,
+              class: "endpoint-try-hint",
+              icon: "Play",
+              thickness: "1.75px"
+            })),
+            i(o(E), {
+              class: "endpoint-copy",
+              icon: "Clipboard",
+              label: "Copy endpoint URL",
+              size: "xs",
+              variant: "ghost",
+              onClick: p[0] || (p[0] = v((z) => o(c)(e.operation.path), ["stop"]))
+            })
+          ];
+        }),
+        default: r(() => [
           t("div", A, [
             t("div", D, [
-              i(T, { operation: e.operation }, null, 8, ["operation"])
+              t("div", H, [
+                i(k, { operation: e.operation }, null, 8, ["operation"])
+              ]),
+              t("div", P, [
+                i(T, {
+                  collapsableItems: !1,
+                  operation: e.operation
+                }, null, 8, ["operation"])
+              ])
             ]),
-            t("div", H, [
-              i(q, {
-                collapsableItems: !1,
-                operation: e.operation
-              }, null, 8, ["operation"])
-            ])
-          ]),
-          i(o(g), { operation: e.operation }, null, 8, ["operation"]),
-          i(o(w), {
-            operation: e.operation,
-            request: e.request,
-            secretCredentials: e.secretCredentials
-          }, null, 8, ["operation", "request", "secretCredentials"])
-        ])
-      ]),
-      _: 2
-    }, [
-      e.operation.description ? {
-        name: "description",
-        fn: n(() => [
-          i(o(S), {
-            value: e.operation.description,
-            withImages: ""
-          }, null, 8, ["value"])
+            i(o(w), { operation: e.operation }, null, 8, ["operation"]),
+            i(o(N), {
+              operation: e.operation,
+              request: e.request,
+              secretCredentials: e.secretCredentials
+            }, null, 8, ["operation", "request", "secretCredentials"])
+          ])
         ]),
-        key: "0"
-      } : void 0
-    ]), 1032, ["id"]));
+        _: 2
+      }, [
+        (l = e.requestEntity) != null && l.description ? {
+          name: "description",
+          fn: r(() => {
+            var n;
+            return [
+              i(o(b), {
+                value: (n = e.requestEntity) == null ? void 0 : n.description,
+                withImages: ""
+              }, null, 8, ["value"])
+            ];
+          }),
+          key: "0"
+        } : void 0
+      ]), 1032, ["id"]);
+    };
   }
 });
 export {
-  te as default
+  ie as default
 };

package/dist/features/Operation/layouts/ModernLayout.vue.d.ts

@@ -1,7 +1,10 @@
+import type { Request as RequestEntity } from '@scalar/oas-utils/entities/spec';
 import type { TransformedOperation } from '@scalar/types/legacy';
 type __VLS_Props = {
     id?: string;
+    /** @deprecated Use `requestEntity` instead */
     operation: TransformedOperation;
+    requestEntity?: RequestEntity;
     request: Request | null;
     secretCredentials: string[];
 };

package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AAkHA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAOhE,KAAK,WAAW,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,oBAAoB,CAAA;IAC/B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAA;CAC5B,CAAC;;AAqNF,wBAOG"}
+{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AAqHA,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAC/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAOhE,KAAK,WAAW,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,8CAA8C;IAC9C,SAAS,EAAE,oBAAoB,CAAA;IAC/B,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAA;CAC5B,CAAC;;AAoNF,wBAOG"}

package/dist/features/Operation/layouts/ModernLayout.vue.js

@@ -1,7 +1,7 @@
 import o from "./ModernLayout.vue2.js";
 /* empty css                  */
 import t from "../../../_virtual/_plugin-vue_export-helper.js";
-const p = /* @__PURE__ */ t(o, [["__scopeId", "data-v-231d90aa"]]);
+const m = /* @__PURE__ */ t(o, [["__scopeId", "data-v-b2b61fd3"]]);
 export {
-  p as default
+  m as default
 };

package/dist/features/Operation/layouts/ModernLayout.vue2.js

@@ -1,12 +1,12 @@
-import { defineComponent as c, openBlock as d, createBlock as m, unref as r, withCtx as t, createVNode as o, createTextVNode as s, createCommentVNode as C, createElementVNode as a, normalizeClass as h, toDisplayString as _ } from "vue";
-import S from "../../../components/OperationPath.vue.js";
-import { ScalarMarkdown as q, ScalarErrorBoundary as u } from "@scalar/components";
-import v from "../components/OperationParameters.vue.js";
-import k from "../components/OperationResponses.vue.js";
-import y from "../../../components/Section/Section.vue.js";
-import B from "../../../components/Section/SectionContent.vue.js";
-import g from "../../../components/Badge/Badge.vue.js";
-import E from "../../../components/Section/SectionHeader.vue.js";
+import { defineComponent as c, openBlock as d, createBlock as m, unref as t, withCtx as r, createVNode as o, createTextVNode as s, createCommentVNode as C, createElementVNode as n, normalizeClass as h, toDisplayString as _ } from "vue";
+import q from "../../../components/OperationPath.vue.js";
+import { ScalarMarkdown as S, ScalarErrorBoundary as u } from "@scalar/components";
+import y from "../components/OperationParameters.vue.js";
+import v from "../components/OperationResponses.vue.js";
+import E from "../../../components/Section/Section.vue.js";
+import k from "../../../components/Section/SectionContent.vue.js";
+import B from "../../../components/Badge/Badge.vue.js";
+import g from "../../../components/Section/SectionHeader.vue.js";
 import N from "../../../components/Anchor/Anchor.vue.js";
 import V from "../../../components/Section/SectionColumns.vue.js";
 import f from "../../../components/Section/SectionColumn.vue.js";
@@ -18,34 +18,35 @@ const D = { class: "operation-details" }, M = { class: "examples" }, W = /* @__P
   props: {
     id: {},
     operation: {},
+    requestEntity: {},
     request: {},
     secretCredentials: {}
   },
   setup(T) {
-    return (e, n) => (d(), m(r(y), {
+    return (e, i) => (d(), m(t(E), {
       id: e.id,
       label: e.operation.name
     }, {
-      default: t(() => [
-        o(r(B), null, {
-          default: t(() => {
-            var i, l;
+      default: r(() => [
+        o(t(k), null, {
+          default: r(() => {
+            var l, p;
             return [
-              (i = e.operation.information) != null && i.deprecated ? (d(), m(r(g), { key: 0 }, {
-                default: t(() => n[0] || (n[0] = [
+              (l = e.operation.information) != null && l.deprecated ? (d(), m(t(B), { key: 0 }, {
+                default: r(() => i[0] || (i[0] = [
                   s(" Deprecated ")
                 ])),
                 _: 1
               })) : C("", !0),
-              a("div", {
-                class: h((l = e.operation.information) != null && l.deprecated ? "deprecated" : "")
+              n("div", {
+                class: h((p = e.operation.information) != null && p.deprecated ? "deprecated" : "")
               }, [
-                o(r(E), { level: 3 }, {
-                  default: t(() => [
-                    o(r(N), {
+                o(t(g), { level: 3 }, {
+                  default: r(() => [
+                    o(t(N), {
                       id: e.id ?? ""
                     }, {
-                      default: t(() => [
+                      default: r(() => [
                         s(_(e.operation.name), 1)
                       ]),
                       _: 1
@@ -54,53 +55,56 @@ const D = { class: "operation-details" }, M = { class: "examples" }, W = /* @__P
                   _: 1
                 })
               ], 2),
-              o(r(V), null, {
-                default: t(() => [
-                  o(r(f), null, {
-                    default: t(() => [
-                      a("div", D, [
-                        o(r(q), {
-                          value: e.operation.description,
-                          withImages: ""
-                        }, null, 8, ["value"]),
-                        o(v, { operation: e.operation }, null, 8, ["operation"]),
-                        o(k, { operation: e.operation }, null, 8, ["operation"])
-                      ])
-                    ]),
+              o(t(V), null, {
+                default: r(() => [
+                  o(t(f), null, {
+                    default: r(() => {
+                      var a;
+                      return [
+                        n("div", D, [
+                          o(t(S), {
+                            value: (a = e.requestEntity) == null ? void 0 : a.description,
+                            withImages: ""
+                          }, null, 8, ["value"]),
+                          o(y, { operation: e.operation }, null, 8, ["operation"]),
+                          o(v, { operation: e.operation }, null, 8, ["operation"])
+                        ])
+                      ];
+                    }),
                     _: 1
                   }),
-                  o(r(f), null, {
-                    default: t(() => [
-                      a("div", M, [
-                        o(r(u), null, {
-                          default: t(() => [
-                            o(r(b), {
+                  o(t(f), null, {
+                    default: r(() => [
+                      n("div", M, [
+                        o(t(u), null, {
+                          default: r(() => [
+                            o(t(b), {
                               fallback: "",
                               operation: e.operation,
                               request: e.request,
                               secretCredentials: e.secretCredentials
                             }, {
-                              header: t(() => {
-                                var p;
+                              header: r(() => {
+                                var a;
                                 return [
-                                  o(S, {
+                                  o(q, {
                                     class: "example-path",
-                                    deprecated: (p = e.operation.information) == null ? void 0 : p.deprecated,
+                                    deprecated: (a = e.operation.information) == null ? void 0 : a.deprecated,
                                     path: e.operation.path
                                   }, null, 8, ["deprecated", "path"])
                                 ];
                               }),
-                              footer: t(() => [
-                                o(r(w), { operation: e.operation }, null, 8, ["operation"])
+                              footer: r(() => [
+                                o(t(w), { operation: e.operation }, null, 8, ["operation"])
                               ]),
                               _: 1
                             }, 8, ["operation", "request", "secretCredentials"])
                           ]),
                           _: 1
                         }),
-                        o(r(u), null, {
-                          default: t(() => [
-                            o(r(R), {
+                        o(t(u), null, {
+                          default: r(() => [
+                            o(t(R), {
                               operation: e.operation,
                               style: { "margin-top": "12px" }
                             }, null, 8, ["operation"])

package/dist/helpers/get-request.d.ts

@@ -15,6 +15,8 @@ export declare const getRequest: (requests: WorkspaceStore["requests"], path: st
         url: string;
         description?: string | undefined;
     } | undefined;
+    'x-internal'?: boolean | undefined;
+    'x-scalar-ignore'?: boolean | undefined;
     security?: Record<string, string[]>[] | undefined;
     tags?: string[] | undefined;
     deprecated?: boolean | undefined;

package/dist/helpers/get-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aACX,cAAc,CAAC,UAAU,CAAC,QAC9B,MAAM,UACJ,MAAM;;;;;;;;;;;;;mBAKu4S,CAAC;;;;;;;;;;;mBAAia,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAwC,CAAC;mBAAkC,CAAC;;;;;aADtoU,CAAA"}
+{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aACX,cAAc,CAAC,UAAU,CAAC,QAC9B,MAAM,UACJ,MAAM;;;;;;;;;;;;;mBAKmqT,CAAC;;;;;;;;;;;;;mBAA8f,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAwC,CAAC;mBAAkC,CAAC;;;;;aAD//U,CAAA"}

package/dist/helpers/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAMxD;;;;GAIG;AACH,eAAO,MAAM,KAAK,kBACD,aAAa,GAAG,MAAM,GAAG,SAAS,kBAG9C;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,KACA,OAAO,CAAC,IAAI,CA0Dd,CAAA"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAMxD;;;;GAIG;AACH,eAAO,MAAM,KAAK,kBACD,aAAa,GAAG,MAAM,GAAG,SAAS,kBAG9C;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,KACA,OAAO,CAAC,IAAI,CA0Dd,CAAA"}