fix: add decorators for proper openapi spec generation

ProjectLibertyLabs · Jul 31, 2024 · 9e3fe8b · 9e3fe8b
1 parent 6d467f5
commit 9e3fe8b
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 53 deletions.
diff --git a/services/account/package.json b/services/account/package.json
@@ -154,6 +154,7 @@
       "^#lib/blockchain(|/.*)$": "<rootDir>/libs/common/src/blockchain/$1",
       "^#lib/config(|/.*)$": "<rootDir>/libs/common/src/config/$1",
       "^#lib/interfaces(|/.*)$": "<rootDir>/libs/common/src/interfaces/$1",
+      "^#lib/queues(|/.*)$": "<rootDir>/libs/common/src/queues/$1",
       "^#lib/services(|/.*)$": "<rootDir>/libs/common/src/services/$1",
       "^#lib/types(|/.*)$": "<rootDir>/libs/common/src/types/$1",
       "^#lib/utils(|/.*)$": "<rootDir>/libs/common/src/utils/$1"

diff --git a/services/content-publishing/apps/api/src/controllers/v1/asset.controller.v1.ts b/services/content-publishing/apps/api/src/controllers/v1/asset.controller.v1.ts
@@ -1,4 +1,4 @@
-import { FilesUploadDto, UploadResponseDto } from '#libs/dtos/common.dto';
+import { FilesUploadDto, UploadResponseDto } from '../../../../../libs/common/src/dtos/common.dto';
 import { DSNP_VALID_MIME_TYPES } from '#libs/dtos/validation.dto';
 import {
   Controller,
@@ -11,7 +11,7 @@ import {
   UseInterceptors,
 } from '@nestjs/common';
 import { FilesInterceptor } from '@nestjs/platform-express';
-import { ApiBody, ApiConsumes, ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiBody, ApiConsumes, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { ApiService } from '../../api.service';
 
 @Controller('v1/asset')
@@ -32,6 +32,7 @@ export class AssetControllerV1 {
     description: 'Asset files',
     type: FilesUploadDto,
   })
+  @ApiResponse({ status: '2XX', type: UploadResponseDto })
   async assetUpload(
     @UploadedFiles(
       new ParseFilePipeBuilder()

diff --git a/services/content-publishing/apps/api/src/controllers/v1/content.controller.v1.ts b/services/content-publishing/apps/api/src/controllers/v1/content.controller.v1.ts
@@ -1,5 +1,5 @@
 import { Body, Controller, Delete, HttpCode, Logger, Param, Post, Put } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { ApiService } from '../../api.service';
 import {
   DsnpUserIdParam,
@@ -25,6 +25,7 @@ export class ContentControllerV1 {
   @Post(':userDsnpId/broadcast')
   @ApiOperation({ summary: 'Create DSNP Broadcast for User' })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async broadcast(
     @Param() userDsnpId: DsnpUserIdParam,
     @Body() broadcastDto: BroadcastDto,
@@ -36,6 +37,7 @@ export class ContentControllerV1 {
   @Post(':userDsnpId/reply')
   @ApiOperation({ summary: 'Create DSNP Reply for User' })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async reply(@Param() userDsnpId: DsnpUserIdParam, @Body() replyDto: ReplyDto): Promise<AnnouncementResponseDto> {
     const metadata = await this.apiService.validateAssetsAndFetchMetadata(replyDto as AssetIncludedRequestDto);
     return this.apiService.enqueueRequest(AnnouncementTypeDto.REPLY, userDsnpId.userDsnpId, replyDto, metadata);
@@ -44,6 +46,7 @@ export class ContentControllerV1 {
   @Post(':userDsnpId/reaction')
   @ApiOperation({ summary: 'Create DSNP Reaction for User' })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async reaction(
     @Param() userDsnpId: DsnpUserIdParam,
     @Body() reactionDto: ReactionDto,
@@ -54,6 +57,7 @@ export class ContentControllerV1 {
   @Put(':userDsnpId')
   @ApiOperation({ summary: 'Update DSNP Content for User' })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async update(@Param() userDsnpId: DsnpUserIdParam, @Body() updateDto: UpdateDto): Promise<AnnouncementResponseDto> {
     const metadata = await this.apiService.validateAssetsAndFetchMetadata(updateDto as AssetIncludedRequestDto);
     return this.apiService.enqueueRequest(AnnouncementTypeDto.UPDATE, userDsnpId.userDsnpId, updateDto, metadata);
@@ -62,6 +66,7 @@ export class ContentControllerV1 {
   @Delete(':userDsnpId')
   @ApiOperation({ summary: 'Delete DSNP Content for User' })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async delete(
     @Param() userDsnpId: DsnpUserIdParam,
     @Body() tombstoneDto: TombstoneDto,

diff --git a/services/content-publishing/apps/api/src/controllers/v1/development.controller.v1.ts b/services/content-publishing/apps/api/src/controllers/v1/development.controller.v1.ts
@@ -7,7 +7,7 @@ import { Controller, Get, Logger, NotFoundException, Param, Post } from '@nestjs
 import { InjectQueue } from '@nestjs/bullmq';
 import { Queue } from 'bullmq';
 import { Job } from 'bullmq/dist/esm/classes/job';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import {
   createBroadcast,
   createProfile,
@@ -67,6 +67,7 @@ export class DevelopmentControllerV1 {
 
   @Get('/asset/:assetId')
   @ApiOperation({ summary: 'Get an Asset given an assetId', description: 'ONLY enabled when ENVIRONMENT="dev".' })
+  @ApiResponse({ status: '2XX', type: Buffer })
   // eslint-disable-next-line consistent-return
   async getAsset(@Param('assetId') assetId: string) {
     if (await this.ipfsService.isPinned(assetId)) {

diff --git a/services/content-publishing/apps/api/src/controllers/v1/profile.controller.v1.ts b/services/content-publishing/apps/api/src/controllers/v1/profile.controller.v1.ts
@@ -1,5 +1,5 @@
 import { Body, Controller, HttpCode, Logger, Param, Put } from '@nestjs/common';
-import { ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { ApiService } from '../../api.service';
 import {
   DsnpUserIdParam,
@@ -21,6 +21,7 @@ export class ProfileControllerV1 {
   @Put(':userDsnpId')
   @ApiOperation({ summary: "Update a user's Profile" })
   @HttpCode(202)
+  @ApiResponse({ status: '2XX', type: AnnouncementResponseDto })
   async profile(
     @Param() userDsnpId: DsnpUserIdParam,
     @Body() profileDto: ProfileDto,

diff --git a/services/content-publishing/libs/common/src/dtos/activity.dto.ts b/services/content-publishing/libs/common/src/dtos/activity.dto.ts
@@ -24,7 +24,8 @@ import {
 } from 'class-validator';
 import { Type } from 'class-transformer';
 import { DURATION_REGEX } from './validation.dto';
-import { IsDsnpUserURI } from '#libs/utils/dsnp-validation.decorator';
+import { DSNP_USER_URI_REGEX, IsDsnpUserURI } from '#libs/utils/dsnp-validation.decorator';
+import { ApiProperty } from '@nestjs/swagger';
 
 // eslint-disable-next-line no-shadow
 export enum UnitTypeDto {

diff --git a/services/content-publishing/libs/common/src/dtos/common.dto.ts b/services/content-publishing/libs/common/src/dtos/common.dto.ts
@@ -16,6 +16,7 @@ export class AnnouncementResponseDto {
 }
 
 export class UploadResponseDto {
+  @ApiProperty()
   assetIds: string[];
 }
 

diff --git a/services/content-publishing/package-lock.json b/services/content-publishing/package-lock.json
diff --git a/services/content-publishing/package.json b/services/content-publishing/package.json
@@ -68,7 +68,7 @@
     "@nestjs/event-emitter": "^2.0.4",
     "@nestjs/platform-express": "^10.3.10",
     "@nestjs/schedule": "^4.0.2",
-    "@nestjs/swagger": "^7.3.1",
+    "@nestjs/swagger": "^7.4.0",
     "@polkadot/api": "^10.12.4",
     "@polkadot/api-base": "^10.12.4",
     "@polkadot/types": "^10.12.4",