From a02240b579a82007305b50321d7cef66cf7a084f Mon Sep 17 00:00:00 2001 From: Rajiv Sahal Date: Mon, 7 Oct 2024 04:34:25 +0530 Subject: [PATCH] fix: add missing ApiOperation tag v2 (#16947) * add missing api operation tag * update openapi spec for docs --- .../v2/src/modules/stripe/controllers/stripe.controller.ts | 5 ++++- docs/api-reference/v2/openapi.json | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/apps/api/v2/src/modules/stripe/controllers/stripe.controller.ts b/apps/api/v2/src/modules/stripe/controllers/stripe.controller.ts index cbf6b1b6e4..a19c65f721 100644 --- a/apps/api/v2/src/modules/stripe/controllers/stripe.controller.ts +++ b/apps/api/v2/src/modules/stripe/controllers/stripe.controller.ts @@ -22,7 +22,7 @@ import { BadRequestException, Headers, } from "@nestjs/common"; -import { ApiTags as DocsTags } from "@nestjs/swagger"; +import { ApiTags as DocsTags, ApiOperation } from "@nestjs/swagger"; import { plainToClass } from "class-transformer"; import { Request } from "express"; import { stringify } from "querystring"; @@ -40,6 +40,7 @@ export class StripeController { @Get("/connect") @UseGuards(ApiAuthGuard) @HttpCode(HttpStatus.OK) + @ApiOperation({ summary: "Get stripe connect URL" }) async redirect( @Req() req: Request, @Headers("Authorization") authorization: string, @@ -72,6 +73,7 @@ export class StripeController { @Get("/save") @UseGuards() @Redirect(undefined, 301) + @ApiOperation({ summary: "Save stripe credentials" }) async save( @Query("state") state: string, @Query("code") code: string, @@ -95,6 +97,7 @@ export class StripeController { @Get("/check") @UseGuards(ApiAuthGuard) @HttpCode(HttpStatus.OK) + @ApiOperation({ summary: "Check stripe connection" }) async check(@GetUser() user: UserWithProfile): Promise { return await this.stripeService.checkIfStripeAccountConnected(user.id); } diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.json index d6d728663d..1920c1dee1 100644 --- a/docs/api-reference/v2/openapi.json +++ b/docs/api-reference/v2/openapi.json @@ -4633,6 +4633,7 @@ "/v2/stripe/connect": { "get": { "operationId": "StripeController_redirect", + "summary": "Get stripe connect URL", "parameters": [ { "name": "Authorization", @@ -4661,6 +4662,7 @@ "/v2/stripe/save": { "get": { "operationId": "StripeController_save", + "summary": "Save stripe credentials", "parameters": [ { "name": "state", @@ -4697,6 +4699,7 @@ "/v2/stripe/check": { "get": { "operationId": "StripeController_check", + "summary": "Check stripe connection", "parameters": [], "responses": { "200": {