@tsed/schema/src/decorators/operations/summary.spec.ts

JsonSchema module for Ts.ED Framework

import {getSpec, OperationPath} from "../../index.js";
import {Summary} from "./summary.js";

describe("Summary", () => {
  it("should store metadata", () => {
    class MyController {
      @OperationPath("POST", "/")
      @Summary("summary")
      get() {}
    }

    expect(getSpec(MyController)).toEqual({
      tags: [
        {
          name: "MyController"
        }
      ],
      paths: {
        "/": {
          post: {
            operationId: "myControllerGet",
            parameters: [],
            responses: {
              "200": {
                description: "Success"
              }
            },
            summary: "summary",
            tags: ["MyController"]
          }
        }
      }
    });
  });
  it("should throw error for unsupported usage", () => {
    let actualError: any;
    try {
      // @ts-ignore
      Summary("summary")(class Test {});
    } catch (er) {
      actualError = er;
    }

    expect(actualError.message).toEqual("Summary cannot be used as class decorator on Test");
  });
});