diff --git a/src/controllers/RunnerTeamController.ts b/src/controllers/RunnerTeamController.ts index d864319..8632fc0 100644 --- a/src/controllers/RunnerTeamController.ts +++ b/src/controllers/RunnerTeamController.ts @@ -25,7 +25,7 @@ export class RunnerTeamController { @Get() @Authorized("TEAM:GET") @ResponseSchema(ResponseRunnerTeam, { isArray: true }) - @OpenAPI({ description: 'Lists all runnerTeams.' }) + @OpenAPI({ description: 'Lists all teams.
This includes their parent organisations and contact (if existing/associated).' }) async getAll() { let responseTeams: ResponseRunnerTeam[] = new Array(); const runners = await this.runnerTeamRepository.find({ relations: ['parentGroup', 'contact'] }); @@ -40,7 +40,7 @@ export class RunnerTeamController { @ResponseSchema(ResponseRunnerTeam) @ResponseSchema(RunnerTeamNotFoundError, { statusCode: 404 }) @OnUndefined(RunnerTeamNotFoundError) - @OpenAPI({ description: 'Returns a runnerTeam of a specified id (if it exists)' }) + @OpenAPI({ description: 'Lists all information about the team whose id got provided.' }) async getOne(@Param('id') id: number) { let runnerTeam = await this.runnerTeamRepository.findOne({ id: id }, { relations: ['parentGroup', 'contact'] }); if (!runnerTeam) { throw new RunnerTeamNotFoundError(); } @@ -50,7 +50,7 @@ export class RunnerTeamController { @Post() @Authorized("TEAM:CREATE") @ResponseSchema(ResponseRunnerTeam) - @OpenAPI({ description: 'Create a new runnerTeam object (id will be generated automagicly).' }) + @OpenAPI({ description: 'Create a new organsisation.
Please remember to provide it\'s parent group\'s id.' }) async post(@Body({ validate: true }) createRunnerTeam: CreateRunnerTeam) { let runnerTeam; try { @@ -70,7 +70,7 @@ export class RunnerTeamController { @ResponseSchema(ResponseRunnerTeam) @ResponseSchema(RunnerTeamNotFoundError, { statusCode: 404 }) @ResponseSchema(RunnerTeamIdsNotMatchingError, { statusCode: 406 }) - @OpenAPI({ description: "Update a runnerTeam object (id can't be changed)." }) + @OpenAPI({ description: "Update the team whose id you provided.
Please remember that id's can't be changed." }) async put(@Param('id') id: number, @Body({ validate: true }) runnerTeam: UpdateRunnerTeam) { let oldRunnerTeam = await this.runnerTeamRepository.findOne({ id: id }, { relations: ['parentGroup', 'contact'] }); @@ -93,7 +93,7 @@ export class RunnerTeamController { @ResponseSchema(ResponseEmpty, { statusCode: 204 }) @ResponseSchema(RunnerTeamHasRunnersError, { statusCode: 406 }) @OnUndefined(204) - @OpenAPI({ description: 'Delete a specified runnerTeam (if it exists).' }) + @OpenAPI({ description: 'Delete the team whose id you provided.
If the team still has runners associated this will fail.
To delete the team with all associated runners set the force QueryParam to true (cascading deletion might take a while).
If no team with this id exists it will just return 204(no content).' }) async remove(@Param("id") id: number, @QueryParam("force") force: boolean) { let team = await this.runnerTeamRepository.findOne({ id: id }); if (!team) { return null; }