@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
264 lines (263 loc) • 12.8 kB
JavaScript
import Badge_default from "../../../components/Badge/Badge.vue.js";
import Section_default from "../../../components/Section/Section.vue.js";
import SectionColumn_default from "../../../components/Section/SectionColumn.vue.js";
import SectionColumns_default from "../../../components/Section/SectionColumns.vue.js";
import SectionContent_default from "../../../components/Section/SectionContent.vue.js";
import SectionHeader_default from "../../../components/Section/SectionHeader.vue.js";
import SectionHeaderTag_default from "../../../components/Section/SectionHeaderTag.vue.js";
import Anchor_default from "../../../components/Anchor/Anchor.vue.js";
import { getXKeysFromObject } from "../../specification-extension/helpers.js";
import SpecificationExtension_default from "../../specification-extension/SpecificationExtension.vue.js";
import LinkList_default from "../../../components/LinkList/LinkList.vue.js";
import ExternalDocs_default from "../../external-docs/ExternalDocs.vue.js";
import { REQUEST_BODY_COMPOSITION_INDEX_SYMBOL } from "../request-body-composition-index.js";
import OperationPath_default from "../../../components/OperationPath.vue.js";
import ExampleResponses_default from "../../example-responses/ExampleResponses.vue.js";
import OperationParameters_default from "../components/OperationParameters.vue.js";
import OperationResponses_default from "../components/OperationResponses.vue.js";
import Callbacks_default from "../components/callbacks/Callbacks.vue.js";
import SecurityRequirementBadge_default from "../components/SecurityRequirementBadge.vue.js";
import { getOperationStability, getOperationStabilityColor, isOperationDeprecated } from "../helpers/operation-stability.js";
import TestRequestButton_default from "../../test-request-button/TestRequestButton.vue.js";
import XBadges_default from "../../x-badges/XBadges.vue.js";
import AskAgentButton_default from "../../ask-agent-button/AskAgentButton.vue.js";
import { computed, createBlock, createCommentVNode, createElementVNode, createSlots, createTextVNode, createVNode, defineComponent, normalizeClass, openBlock, provide, ref, toDisplayString, unref, useId, withCtx } from "vue";
import { ScalarErrorBoundary, ScalarMarkdown } from "@scalar/components";
import { ScalarIconWebhooksLogo } from "@scalar/icons";
import { OperationCodeSample } from "@scalar/api-client/blocks/operation-code-sample";
import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
//#region src/features/Operation/layouts/ModernLayout.vue?vue&type=script&setup=true&lang.ts
var _hoisted_1 = { class: "flex flex-row justify-between gap-1" };
var _hoisted_2 = { class: "flex gap-1" };
var _hoisted_3 = { class: "flex gap-1" };
var _hoisted_4 = { class: "operation-header" };
var _hoisted_5 = { class: "operation-details" };
var _hoisted_6 = { class: "examples" };
var _hoisted_7 = { class: "flex" };
var ModernLayout_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */ defineComponent({
__name: "ModernLayout",
props: {
id: {},
method: {},
options: {},
path: {},
clientOptions: {},
isWebhook: { type: Boolean },
selectedClient: {},
eventBus: {},
operation: {},
selectedServer: {},
selectedSecuritySchemes: {},
requiredSecurity: {}
},
setup(__props) {
const operationTitle = computed(() => __props.operation.summary || __props.path || "");
const labelId = useId();
const operationExtensions = computed(() => getXKeysFromObject(__props.operation));
/** Track the selected request body content type so the code sample stays in sync */
const selectedRequestBodyContentType = ref();
/** Selected request body oneOf/anyOf variants; synced with schema dropdowns and code sample */
const requestBodyCompositionSelection = ref({});
const requestBodyCompositionSelectionForCodeSample = computed(() => ({ ...requestBodyCompositionSelection.value }));
const requestBodyCompositionSelectionKey = computed(() => JSON.stringify(requestBodyCompositionSelectionForCodeSample.value));
provide(REQUEST_BODY_COMPOSITION_INDEX_SYMBOL, requestBodyCompositionSelection);
return (_ctx, _cache) => {
return openBlock(), createBlock(unref(Section_default), {
id: __props.id,
"aria-labelledby": unref(labelId),
label: operationTitle.value,
tabindex: "-1",
onIntersecting: _cache[2] || (_cache[2] = () => __props.eventBus?.emit("intersecting:nav-item", { id: __props.id }))
}, {
default: withCtx(() => [createVNode(unref(SectionContent_default), null, {
default: withCtx(() => [
createElementVNode("div", _hoisted_1, [createElementVNode("div", _hoisted_2, [
__props.options?.showOperationId && __props.operation.operationId ? (openBlock(), createBlock(unref(Badge_default), { key: 0 }, {
default: withCtx(() => [createTextVNode(toDisplayString(__props.operation.operationId), 1)]),
_: 1
})) : createCommentVNode("", true),
unref(getOperationStability)(__props.operation) ? (openBlock(), createBlock(unref(Badge_default), {
key: 1,
class: normalizeClass(["capitalize", unref(getOperationStabilityColor)(__props.operation)])
}, {
default: withCtx(() => [createTextVNode(toDisplayString(unref(getOperationStability)(__props.operation)), 1)]),
_: 1
}, 8, ["class"])) : createCommentVNode("", true),
__props.isWebhook ? (openBlock(), createBlock(unref(Badge_default), {
key: 2,
class: "font-code text-green flex w-fit items-center justify-center gap-1"
}, {
default: withCtx(() => [createVNode(unref(ScalarIconWebhooksLogo), { weight: "bold" }), _cache[3] || (_cache[3] = createTextVNode("Webhook ", -1))]),
_: 1
})) : createCommentVNode("", true),
createVNode(unref(XBadges_default), {
badges: __props.operation["x-badges"],
position: "before"
}, null, 8, ["badges"])
]), createElementVNode("div", _hoisted_3, [createVNode(unref(XBadges_default), {
badges: __props.operation["x-badges"],
position: "after"
}, null, 8, ["badges"])])]),
createElementVNode("div", _hoisted_4, [createElementVNode("div", { class: normalizeClass(unref(isOperationDeprecated)(__props.operation) && "deprecated") }, [createVNode(unref(SectionHeader_default), { removeMargin: "" }, {
default: withCtx(() => [createVNode(unref(Anchor_default), { onCopyAnchorUrl: _cache[0] || (_cache[0] = () => __props.eventBus?.emit("copy-url:nav-item", { id: __props.id })) }, {
default: withCtx(() => [createVNode(unref(SectionHeaderTag_default), {
id: unref(labelId),
level: 3
}, {
default: withCtx(() => [createTextVNode(toDisplayString(operationTitle.value), 1)]),
_: 1
}, 8, ["id"])]),
_: 1
})]),
_: 1
})], 2), createVNode(SecurityRequirementBadge_default, { requiredSecurity: __props.requiredSecurity }, null, 8, ["requiredSecurity"])]),
createVNode(unref(SectionColumns_default), null, {
default: withCtx(() => [createVNode(unref(SectionColumn_default), null, {
default: withCtx(() => [createElementVNode("div", _hoisted_5, [
createVNode(SpecificationExtension_default, { value: operationExtensions.value }, null, 8, ["value"]),
createVNode(unref(ScalarMarkdown), {
anchorPrefix: __props.id,
"aria-label": "Operation Description",
role: "group",
transformType: "heading",
value: __props.operation.description,
withAnchors: "",
withImages: ""
}, null, 8, ["anchorPrefix", "value"]),
createVNode(OperationParameters_default, {
selectedContentType: selectedRequestBodyContentType.value,
"onUpdate:selectedContentType": _cache[1] || (_cache[1] = ($event) => selectedRequestBodyContentType.value = $event),
breadcrumb: [__props.id],
eventBus: __props.eventBus,
options: __props.options,
parameters: __props.operation.parameters,
requestBody: unref(getResolvedRef)(__props.operation.requestBody)
}, null, 8, [
"selectedContentType",
"breadcrumb",
"eventBus",
"options",
"parameters",
"requestBody"
]),
createVNode(OperationResponses_default, {
breadcrumb: [__props.id],
collapsableItems: !__props.options.expandAllResponses,
eventBus: __props.eventBus,
options: __props.options,
responses: __props.operation.responses
}, null, 8, [
"breadcrumb",
"collapsableItems",
"eventBus",
"options",
"responses"
]),
createVNode(unref(ScalarErrorBoundary), null, {
default: withCtx(() => [__props.operation.callbacks ? (openBlock(), createBlock(Callbacks_default, {
key: 0,
callbacks: __props.operation.callbacks,
class: "mt-6",
eventBus: __props.eventBus,
options: __props.options,
path: __props.path
}, null, 8, [
"callbacks",
"eventBus",
"options",
"path"
])) : createCommentVNode("", true)]),
_: 1
})
])]),
_: 1
}), createVNode(unref(SectionColumn_default), null, {
default: withCtx(() => [createElementVNode("div", _hoisted_6, [
__props.operation.externalDocs ? (openBlock(), createBlock(unref(LinkList_default), { key: 0 }, {
default: withCtx(() => [createVNode(unref(ExternalDocs_default), { value: __props.operation.externalDocs }, null, 8, ["value"])]),
_: 1
})) : createCommentVNode("", true),
createVNode(unref(ScalarErrorBoundary), null, {
default: withCtx(() => [(openBlock(), createBlock(unref(OperationCodeSample), {
key: requestBodyCompositionSelectionKey.value,
clientOptions: __props.clientOptions,
eventBus: __props.eventBus,
fallback: "",
isWebhook: __props.isWebhook,
method: __props.method,
operation: __props.operation,
path: __props.path,
requestBodyCompositionSelection: requestBodyCompositionSelectionForCodeSample.value,
securitySchemes: __props.selectedSecuritySchemes,
selectedClient: __props.selectedClient,
selectedContentType: selectedRequestBodyContentType.value,
selectedServer: __props.selectedServer
}, createSlots({
header: withCtx(() => [createVNode(OperationPath_default, {
class: "font-code text-c-2 [&_em]:text-c-1 min-w-0 [&_em]:not-italic",
deprecated: __props.operation?.deprecated,
path: __props.path
}, null, 8, ["deprecated", "path"])]),
_: 2
}, [!__props.isWebhook ? {
name: "footer",
fn: withCtx(({ exampleName }) => [createElementVNode("div", _hoisted_7, [createVNode(AskAgentButton_default), !__props.options.hideTestRequestButton ? (openBlock(), createBlock(unref(TestRequestButton_default), {
key: 0,
id: __props.id,
eventBus: __props.eventBus,
exampleName,
method: __props.method,
path: __props.path,
requestBodyCompositionSelection: requestBodyCompositionSelectionForCodeSample.value
}, null, 8, [
"id",
"eventBus",
"exampleName",
"method",
"path",
"requestBodyCompositionSelection"
])) : createCommentVNode("", true)])]),
key: "0"
} : void 0]), 1032, [
"clientOptions",
"eventBus",
"isWebhook",
"method",
"operation",
"path",
"requestBodyCompositionSelection",
"securitySchemes",
"selectedClient",
"selectedContentType",
"selectedServer"
]))]),
_: 1
}),
createVNode(unref(ScalarErrorBoundary), null, {
default: withCtx(() => [__props.operation.responses ? (openBlock(), createBlock(unref(ExampleResponses_default), {
key: 0,
responses: __props.operation.responses,
style: { "margin-top": "12px" }
}, null, 8, ["responses"])) : createCommentVNode("", true)]),
_: 1
})
])]),
_: 1
})]),
_: 1
})
]),
_: 1
})]),
_: 1
}, 8, [
"id",
"aria-labelledby",
"label"
]);
};
}
});
//#endregion
export { ModernLayout_vue_vue_type_script_setup_true_lang_default as default };
//# sourceMappingURL=ModernLayout.vue.script.js.map