@tsed/schema/src/decorators/operations/operationPath.ts

JsonSchema module for Ts.ED Framework

import {DecoratorTypes, UnsupportedDecoratorType} from "@tsed/core";

import {OperationVerbs} from "../../constants/OperationVerbs.js";
import {JsonEntityFn} from "../common/jsonEntityFn.js";

/**
 * Declare new Operation with his path and http method.
 *
 * ::: warning
 * Don't use decorator with Ts.ED application.
 *
 * Use these decorators instead:
 *
 * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
 *
 * :::
 *
 * @param method
 * @param path
 * @decorator
 * @swagger
 * @schema
 * @operation
 */
export function OperationPath(method: OperationVerbs | string, path: string | RegExp = "/") {
  return JsonEntityFn((store, args) => {
    if (store.decoratorType !== DecoratorTypes.METHOD) {
      throw new UnsupportedDecoratorType(OperationPath, args);
    }

    store.operation!.addOperationPath(method.toUpperCase(), path);
  });
}