@scalar/api-reference 1.36.2 → 1.38.0

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

@@ -1 +1 @@
-{"version":3,"file":"ClassicLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ClassicLayout.vue"],"names":[],"mappings":"AAucA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAWrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AAE9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAiBrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AAEvF,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC,MAAM,EAAE,cAAc,CAAA;IACtB,MAAM,EAAE,yBAAyB,CAAA;IACjC,SAAS,EAAE,eAAe,CAAA;IAE1B,SAAS,EAAE,OAAO,CAAA;IAClB,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,KAAK,EAAE,cAAc,CAAA;CACtB,CAAC;;AAwfF,wBAMG"}
+{"version":3,"file":"ClassicLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ClassicLayout.vue"],"names":[],"mappings":"AAudA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,oDAAoD,CAAA;AAM3D,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAYrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAiBrE,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,eAAe,CAAA;IAE1B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,KAAK,EAAE,cAAc,CAAA;IACrB,gGAAgG;IAChG,OAAO,EAAE;QACP,6EAA6E;QAC7E,SAAS,EAAE,OAAO,CAAA;QAClB,aAAa,EAAE,iBAAiB,EAAE,CAAA;QAClC,eAAe,EAAE,OAAO,GAAG,SAAS,CAAA;QACpC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1C,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AA8gBF,wBAMG"}

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

@@ -1,7 +1,7 @@
 import o from "./ClassicLayout.vue2.js";
 /* empty css                   */
 import t from "../../../_virtual/_plugin-vue_export-helper.js";
-const f = /* @__PURE__ */ t(o, [["__scopeId", "data-v-fd385796"]]);
+const c = /* @__PURE__ */ t(o, [["__scopeId", "data-v-4fb6913c"]]);
 export {
-  f as default
+  c as default
 };

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

@@ -1,89 +1,90 @@
-import { defineComponent as k, computed as v, createBlock as r, openBlock as i, unref as o, createSlots as g, withCtx as s, createElementVNode as a, createCommentVNode as n, createElementBlock as S, createVNode as t, withModifiers as C, toDisplayString as d, normalizeClass as B, createTextVNode as m } from "vue";
-import { ScalarErrorBoundary as w, ScalarIconButton as O, ScalarMarkdown as W } from "@scalar/components";
-import { ScalarIconPlay as $, ScalarIconCopy as R, ScalarIconWebhooksLogo as q } from "@scalar/icons";
-import { isOperationDeprecated as I, getOperationStability as c, getOperationStabilityColor as T } from "@scalar/oas-utils/helpers";
-import { useClipboard as E } from "@scalar/use-hooks/useClipboard";
-import { getResolvedRef as L } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import z from "../../../components/OperationPath.vue.js";
-import D from "../components/callbacks/Callbacks.vue.js";
-import N from "../components/OperationParameters.vue.js";
-import P from "../components/OperationResponses.vue.js";
-import V from "../../../components/Section/SectionAccordion.vue.js";
-import _ from "../../example-responses/ExampleResponses.vue.js";
-import A from "../../../components/LinkList/LinkList.vue.js";
-import M from "../../external-docs/ExternalDocs.vue.js";
-import j from "../../../v2/blocks/scalar-request-example-block/components/RequestExample.vue.js";
-import h from "../../x-badges/XBadges.vue.js";
-import U from "../../test-request-button/TestRequestButton.vue.js";
-import F from "../../../components/HttpMethod/HttpMethod.vue.js";
-import G from "../../../components/Anchor/Anchor.vue.js";
-import u from "../../../components/Badge/Badge.vue.js";
-const H = { class: "operation-title" }, J = { class: "operation-details" }, K = { class: "endpoint-label" }, Q = { class: "endpoint-label-path" }, X = { class: "endpoint-label-name" }, Y = { class: "endpoint-content" }, Z = { class: "operation-details-card" }, x = { class: "operation-details-card-item" }, ee = { class: "operation-details-card-item" }, oe = {
+import { defineComponent as v, computed as S, createBlock as a, openBlock as i, unref as o, createSlots as g, withCtx as r, createElementVNode as s, createCommentVNode as n, createElementBlock as l, createVNode as t, Fragment as C, toDisplayString as d, withModifiers as B, normalizeClass as w, createTextVNode as c } from "vue";
+import { OperationCodeSample as O } from "@scalar/api-client/v2/blocks/operation-code-sample";
+import { ScalarErrorBoundary as I, ScalarIconButton as P, ScalarMarkdown as R } from "@scalar/components";
+import { ScalarIconPlay as $, ScalarIconCopy as q, ScalarIconWebhooksLogo as W } from "@scalar/icons";
+import { isOperationDeprecated as T, getOperationStability as h, getOperationStabilityColor as L } from "@scalar/oas-utils/helpers";
+import { useClipboard as z } from "@scalar/use-hooks/useClipboard";
+import { getResolvedRef as D } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import E from "../../../components/OperationPath.vue.js";
+import N from "../components/callbacks/Callbacks.vue.js";
+import V from "../components/OperationParameters.vue.js";
+import F from "../components/OperationResponses.vue.js";
+import A from "../../../components/Section/SectionAccordion.vue.js";
+import M from "../../example-responses/ExampleResponses.vue.js";
+import j from "../../../components/LinkList/LinkList.vue.js";
+import U from "../../external-docs/ExternalDocs.vue.js";
+import u from "../../x-badges/XBadges.vue.js";
+import G from "../../test-request-button/TestRequestButton.vue.js";
+import H from "../../../components/HttpMethod/HttpMethod.vue.js";
+import J from "../../../components/Anchor/Anchor.vue.js";
+import f from "../../../components/Badge/Badge.vue.js";
+const K = { class: "operation-title" }, Q = { class: "operation-details" }, X = { class: "endpoint-label" }, Y = { class: "endpoint-label-path" }, Z = { class: "endpoint-label-name" }, _ = {
+  key: 1,
+  class: "font-code text-sm"
+}, x = { class: "endpoint-content" }, ee = { class: "operation-details-card" }, oe = { class: "operation-details-card-item" }, te = { class: "operation-details-card-item" }, ie = {
   key: 0,
   class: "operation-details-card-item"
-}, Be = /* @__PURE__ */ k({
+}, Oe = /* @__PURE__ */ v({
   __name: "ClassicLayout",
   props: {
     id: {},
     path: {},
-    clientOptions: {},
     method: {},
-    config: {},
     operation: {},
-    isWebhook: { type: Boolean },
     server: {},
     securitySchemes: {},
-    store: {}
+    store: {},
+    options: {}
   },
-  setup(p) {
-    const f = v(() => p.operation.summary || p.path || ""), { copyToClipboard: y } = E();
-    return (e, l) => (i(), r(o(V), {
+  setup(m) {
+    const y = S(() => m.operation.summary || m.path || ""), { copyToClipboard: k } = z();
+    return (e, p) => (i(), a(o(A), {
       id: e.id,
       class: "reference-endpoint",
       transparent: ""
     }, g({
-      title: s(() => [
-        a("div", H, [
-          a("div", J, [
-            t(o(F), {
+      title: r(() => [
+        s("div", K, [
+          s("div", Q, [
+            t(o(H), {
               class: "endpoint-type",
               method: e.method,
               short: ""
             }, null, 8, ["method"]),
-            t(o(G), {
+            t(o(J), {
               id: e.id,
               class: "endpoint-anchor"
             }, {
-              default: s(() => [
-                a("h3", K, [
-                  a("div", Q, [
-                    t(z, {
-                      deprecated: o(I)(e.operation),
+              default: r(() => [
+                s("h3", X, [
+                  s("div", Y, [
+                    t(E, {
+                      deprecated: o(T)(e.operation),
                       path: e.path
                     }, null, 8, ["deprecated", "path"])
                   ]),
-                  a("div", X, d(f.value), 1),
-                  o(c)(e.operation) ? (i(), r(o(u), {
+                  s("div", Z, d(y.value), 1),
+                  o(h)(e.operation) ? (i(), a(o(f), {
                     key: 0,
-                    class: B(["capitalize", o(T)(e.operation)])
+                    class: w(["capitalize", o(L)(e.operation)])
                   }, {
-                    default: s(() => [
-                      m(d(o(c)(e.operation)), 1)
+                    default: r(() => [
+                      c(d(o(h)(e.operation)), 1)
                     ]),
                     _: 1
                   }, 8, ["class"])) : n("", !0),
-                  e.isWebhook ? (i(), r(o(u), {
+                  e.options.isWebhook ? (i(), a(o(f), {
                     key: 1,
                     class: "font-code text-green flex w-fit items-center justify-center gap-1"
                   }, {
-                    default: s(() => [
-                      t(o(q), { weight: "bold" }),
-                      l[1] || (l[1] = m("Webhook "))
+                    default: r(() => [
+                      t(o(W), { weight: "bold" }),
+                      p[1] || (p[1] = c("Webhook "))
                     ]),
                     _: 1,
                     __: [1]
                   })) : n("", !0),
-                  t(o(h), {
+                  t(o(u), {
                     badges: e.operation["x-badges"],
                     position: "before"
                   }, null, 8, ["badges"])
@@ -94,82 +95,90 @@ const H = { class: "operation-title" }, J = { class: "operation-details" }, K =
           ])
         ])
       ]),
-      actions: s(({ active: b }) => [
-        t(o(h), {
+      actions: r(({ active: b }) => [
+        t(o(u), {
           badges: e.operation["x-badges"],
           position: "after"
         }, null, 8, ["badges"]),
-        b && !e.isWebhook ? (i(), r(o(U), {
-          key: 0,
-          method: e.method,
-          path: e.path
-        }, null, 8, ["method", "path"])) : e.config?.hideTestRequestButton ? n("", !0) : (i(), r(o($), {
-          key: 1,
-          class: "endpoint-try-hint size-4.5"
-        })),
-        t(o(O), {
+        e.options?.hideTestRequestButton ? n("", !0) : (i(), l(C, { key: 0 }, [
+          b && !e.options.isWebhook ? (i(), a(o(G), {
+            key: 0,
+            method: e.method,
+            path: e.path
+          }, null, 8, ["method", "path"])) : (i(), a(o($), {
+            key: 1,
+            class: "endpoint-try-hint size-4.5"
+          }))
+        ], 64)),
+        e.options?.showOperationId && e.operation.operationId ? (i(), l("span", _, d(e.operation.operationId), 1)) : n("", !0),
+        t(o(P), {
           class: "endpoint-copy p-0.5",
-          icon: o(R),
+          icon: o(q),
           label: "Copy endpoint URL",
           size: "xs",
           variant: "ghost",
-          onClick: l[0] || (l[0] = C((te) => o(y)(e.path), ["stop"]))
+          onClick: p[0] || (p[0] = B((se) => o(k)(e.path), ["stop"]))
         }, null, 8, ["icon"])
       ]),
-      default: s(() => [
-        a("div", Y, [
-          a("div", Z, [
-            a("div", x, [
-              t(N, {
+      default: r(() => [
+        s("div", x, [
+          s("div", ee, [
+            s("div", oe, [
+              t(V, {
+                options: e.options,
                 parameters: (
                   // These have been resolved in the Operation.vue component
                   e.operation.parameters
                 ),
-                requestBody: o(L)(e.operation.requestBody)
-              }, null, 8, ["parameters", "requestBody"])
+                requestBody: o(D)(e.operation.requestBody)
+              }, null, 8, ["options", "parameters", "requestBody"])
             ]),
-            a("div", ee, [
-              t(P, {
-                collapsableItems: !1,
+            s("div", te, [
+              t(F, {
+                options: {
+                  orderRequiredPropertiesFirst: e.options.orderRequiredPropertiesFirst,
+                  orderSchemaPropertiesBy: e.options.orderSchemaPropertiesBy
+                },
                 responses: e.operation.responses
-              }, null, 8, ["responses"])
+              }, null, 8, ["options", "responses"])
             ]),
-            e.operation?.callbacks ? (i(), S("div", oe, [
-              t(D, {
+            e.operation?.callbacks ? (i(), l("div", ie, [
+              t(N, {
                 callbacks: e.operation.callbacks,
                 method: e.method,
+                options: e.options,
                 path: e.path
-              }, null, 8, ["callbacks", "method", "path"])
+              }, null, 8, ["callbacks", "method", "options", "path"])
             ])) : n("", !0)
           ]),
-          e.operation.responses ? (i(), r(o(_), {
+          e.operation.responses ? (i(), a(o(M), {
             key: 0,
             class: "operation-example-card",
             responses: e.operation.responses
           }, null, 8, ["responses"])) : n("", !0),
-          a("div", null, [
-            e.operation.externalDocs ? (i(), r(o(A), { key: 0 }, {
-              default: s(() => [
-                t(o(M), {
+          s("div", null, [
+            e.operation.externalDocs ? (i(), a(o(j), { key: 0 }, {
+              default: r(() => [
+                t(o(U), {
                   value: e.operation.externalDocs
                 }, null, 8, ["value"])
               ]),
               _: 1
             })) : n("", !0),
-            t(o(w), null, {
-              default: s(() => [
-                t(o(j), {
+            t(o(I), null, {
+              default: r(() => [
+                t(o(O), {
                   class: "operation-example-card",
-                  clientOptions: e.clientOptions,
+                  clientOptions: e.options.clientOptions,
                   fallback: "",
+                  isWebhook: e.options.isWebhook,
                   method: e.method,
                   operation: e.operation,
                   path: e.path,
-                  isWebhook: e.isWebhook,
                   securitySchemes: e.securitySchemes,
                   selectedClient: e.store.workspace["x-scalar-default-client"],
                   selectedServer: e.server
-                }, null, 8, ["clientOptions", "method", "operation", "path", "isWebhook", "securitySchemes", "selectedClient", "selectedServer"])
+                }, null, 8, ["clientOptions", "isWebhook", "method", "operation", "path", "securitySchemes", "selectedClient", "selectedServer"])
               ]),
               _: 1
             })
@@ -180,8 +189,8 @@ const H = { class: "operation-title" }, J = { class: "operation-details" }, K =
     }, [
       e.operation.description ? {
         name: "description",
-        fn: s(() => [
-          t(o(W), {
+        fn: r(() => [
+          t(o(R), {
             anchorPrefix: e.id,
             transformType: "heading",
             value: e.operation.description,
@@ -195,5 +204,5 @@ const H = { class: "operation-title" }, J = { class: "operation-details" }, K =
   }
 });
 export {
-  Be as default
+  Oe as default
 };

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

@@ -1,19 +1,26 @@
+import { type ClientOptionGroup } from '@scalar/api-client/v2/blocks/operation-code-sample';
 import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
-import type { ApiReferenceConfiguration } from '@scalar/types';
 import type { WorkspaceStore } from '@scalar/workspace-store/client';
 import type { OperationObject, SecuritySchemeObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-import type { ClientOptionGroup } from '../../../v2/blocks/scalar-request-example-block/types';
 type __VLS_Props = {
     id: string;
     path: string;
-    clientOptions: ClientOptionGroup[];
-    config: ApiReferenceConfiguration;
     method: HttpMethodType;
     operation: OperationObject;
-    isWebhook: boolean;
     securitySchemes: SecuritySchemeObject[];
     server: ServerObject | undefined;
     store: WorkspaceStore;
+    /** Global options that can be derived from the top level config or assigned at a block level */
+    options: {
+        /** Sets some additional display properties when an operation is a webhook */
+        isWebhook: boolean;
+        showOperationId: boolean | undefined;
+        hideTestRequestButton: boolean | undefined;
+        expandAllResponses: boolean | undefined;
+        clientOptions: ClientOptionGroup[];
+        orderRequiredPropertiesFirst: boolean | undefined;
+        orderSchemaPropertiesBy: 'alpha' | 'preserve' | undefined;
+    };
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

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":"AAuNA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAOrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAuBrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AAEvF,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC,MAAM,EAAE,yBAAyB,CAAA;IACjC,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,eAAe,CAAA;IAE1B,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,KAAK,EAAE,cAAc,CAAA;CACtB,CAAC;;AAwbF,wBAMG"}
+{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AA+OA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,oDAAoD,CAAA;AAE3D,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAOrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EACV,eAAe,EAEf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AAuBrE,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,eAAe,CAAA;IAC1B,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,KAAK,EAAE,cAAc,CAAA;IACrB,gGAAgG;IAChG,OAAO,EAAE;QACP,6EAA6E;QAC7E,SAAS,EAAE,OAAO,CAAA;QAClB,eAAe,EAAE,OAAO,GAAG,SAAS,CAAA;QACpC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAA;QAC1C,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAA;QACvC,aAAa,EAAE,iBAAiB,EAAE,CAAA;QAClC,4BAA4B,EAAE,OAAO,GAAG,SAAS,CAAA;QACjD,uBAAuB,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;KAC1D,CAAA;CACF,CAAC;;AA0dF,wBAMG"}

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 m = /* @__PURE__ */ t(o, [["__scopeId", "data-v-0b2d484d"]]);
+const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-acddad0e"]]);
 export {
-  m as default
+  e as default
 };