docusaurus-plugin-openapi-docs/lib/markdown/createDeprecationNotice.js

OpenAPI plugin for Docusaurus.

"use strict";
/* ============================================================================
 * Copyright (c) Palo Alto Networks
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 * ========================================================================== */
Object.defineProperty(exports, "__esModule", { value: true });
exports.createDeprecationNotice = createDeprecationNotice;
const utils_1 = require("./utils");
function createAdmonition({ children }) {
    return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
}
function createDeprecationNotice({ deprecated, description, }) {
    return (0, utils_1.guard)(deprecated, () => createAdmonition({
        children: description && description.length > 0
            ? (0, utils_1.clean)(description)
            : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
    }));
}