@redocly/respect-core/lib/modules/description-parser/get-operation-by-path.js

API testing framework core

import JsonPointerLib from 'json-pointer';
import { red } from 'colorette';
export function getOperationByPath(operationPath, descriptionDetails) {
    const { $sourceDescriptions, sourceDescriptions } = descriptionDetails;
    const [basePath, fragmentIdentifier] = operationPath.split('#');
    if (!sourceDescriptions) {
        throw new Error(`Missing described sourceDescriptions`);
    }
    const descriptionName = sourceDescriptions.find((sourceDescription) => {
        if (['openapi', 'arazzo'].includes(sourceDescription.type)) {
            if (basePath.includes('$sourceDescriptions.')) {
                const [, sourceDescriptionName] = basePath.split('.');
                return sourceDescription.name === sourceDescriptionName;
            }
            return 'url' in sourceDescription && sourceDescription.url === basePath;
        }
        return false;
    })?.name;
    if (!descriptionName) {
        throw new Error(`Unknown operationPath ${red(operationPath)}. API description ${red(basePath)} is not listed in 'sourceDescriptions' workflow section.`);
    }
    const description = $sourceDescriptions[descriptionName] || {};
    const securitySchemes = description?.components?.securitySchemes;
    const [prop, path, method] = JsonPointerLib.parse(fragmentIdentifier);
    if (prop !== 'paths') {
        throw new Error(`Invalid fragment identifier: ${fragmentIdentifier} at operationPath ${red(operationPath)}.`);
    }
    const { servers } = description;
    const operation = JsonPointerLib.get(description, fragmentIdentifier) || {};
    const pathItemObject = JsonPointerLib.get(description, JsonPointerLib.compile(['paths', path])) ||
        {};
    // FIXME: use servers from path level
    return {
        servers: pathItemObject.servers || servers, // use servers from path level if exists
        ...operation, // operation level servers override path level or global servers
        pathParameters: pathItemObject.parameters || [],
        path,
        method,
        descriptionName,
        securitySchemes,
    };
}
//# sourceMappingURL=get-operation-by-path.js.map