duplicatePathParamController.ts

import { Route, Get, Post, Path, Delete, Head } from '@tsoa/runtime';

@Route('GetTest')
export class DuplicatePathParamTestController {
  @Get('{id}') public getPathParamTest(@Path() id: string) {
    return id;
  }

  @Get('{identifier}') public getPathParamTest2(@Path() identifier: string) {
    return identifier;
  }

  @Post('{id}') public postPathParamTest(@Path() id: string) {
    return id;
  }

  @Post('{identifier}') public postPathParamTest2(@Path() identifier: string) {
    return identifier;
  }

  @Post(':anotherIdentifier') public postPathParamTest3(@Path() anotherIdentifier: string) {
    return anotherIdentifier;
  }

  @Post('{identifier}-{identifier2}') public postPathParamTest4(@Path() identifier: string) {
    return identifier;
  }

  @Post('test-{identifier}') public postPathParamPrefixTest1(@Path() identifier: string) {
    return identifier;
  }

  @Post('anothertest-{identifier}') public postPathParamPrefixTest2(@Path() identifier: string) {
    return identifier;
  }

  @Delete('Delete/{id}') public deletePathParamTest(@Path() id: string) {
    return id;
  }

  // This method should not report a warning cause its prefix route is different.
  @Delete('Delete2/{id}') public deletePathParamTest2(@Path() id: string) {
    return id;
  }

  @Delete('Delete/:identifier') public deletePathParamTest3(@Path() identifier: string) {
    return identifier;
  }

  // These two Head method should not raise a warning
  @Head('Head/{id}') public headPathParamTest(@Path() id: string) {
    return id;
  }

  @Head('Head/{id}/{id2}') public headPathParamTest2(@Path() id: string, @Path() id2: string) {
    return { id, id2 };
  }

  // These two Head method should raise a warning,
  // because in this order "id" could be "something-like-this" and would match
  @Head('Head-PartialCollision/{id}') public headPartialCollisionPathParamTest(@Path() id: string) {
    return id;
  }

  @Head('Head-PartialCollision/{id}-{id2}') public headPartialCollisionPathParamTest2(@Path() id: string, @Path() id2: string) {
    return { id, id2 };
  }

  // These two Head method should not raise a warning,
  // as the order is fine
  @Head('Head-NoPartialCollision/{id}-{id2}') public headNoPartialCollisionPathParamTest2(@Path() id: string, @Path() id2: string) {
    return { id, id2 };
  }

  @Head('Head-NoPartialCollision/{id}') public headNoPartialCollisionPathParamTest(@Path() id: string) {
    return id;
  }

  // These two methods should not raise a warning,
  @Get('/') public getTodos() {
    return {};
  }

  @Get('/{id}') public getTodo(@Path() id: string) {
    return id;
  }

  // These two methods should not raise a warning,
  @Get('/sub/') public getSubTodos() {
    return {};
  }

  @Get('/sub/{id}') public getSubTodo(@Path() id: string) {
    return id;
  }

  // These two methods should not raise a warning,
  @Post('{userId}/abc')
  public async f1(@Path() userId: string): Promise<string> {
    return userId;
  }
  @Post('{userId}/abcdef')
  public async f2(@Path() userId: string): Promise<string> {
    return userId;
  }
}