From a9aa24e6fdb53d33c639c58c1913f55aa75f2469 Mon Sep 17 00:00:00 2001 From: Ahmed Bouhuolia Date: Sat, 7 Sep 2024 15:18:21 +0200 Subject: [PATCH] Revert "feat: Document API endpoints using Swagger" --- packages/server/package.json | 1 - .../Attachments/AttachmentsController.ts | 27 ------------------- .../server/src/api/controllers/Items/Items.ts | 21 --------------- pnpm-lock.yaml | 17 ------------ 4 files changed, 66 deletions(-) diff --git a/packages/server/package.json b/packages/server/package.json index c110993c4..b07d5694b 100644 --- a/packages/server/package.json +++ b/packages/server/package.json @@ -109,7 +109,6 @@ "rtl-detect": "^1.0.4", "socket.io": "^4.7.4", "source-map-loader": "^4.0.1", - "swagger-ui-express": "^5.0.1", "tmp-promise": "^3.0.3", "ts-transformer-keys": "^0.4.2", "tsyringe": "^4.3.0", diff --git a/packages/server/src/api/controllers/Attachments/AttachmentsController.ts b/packages/server/src/api/controllers/Attachments/AttachmentsController.ts index 8576aaa50..ad75ef550 100644 --- a/packages/server/src/api/controllers/Attachments/AttachmentsController.ts +++ b/packages/server/src/api/controllers/Attachments/AttachmentsController.ts @@ -5,14 +5,7 @@ import { body, param } from 'express-validator'; import BaseController from '@/api/controllers/BaseController'; import { AttachmentsApplication } from '@/services/Attachments/AttachmentsApplication'; import { AttachmentUploadPipeline } from '@/services/Attachments/S3UploadPipeline'; -import { - ApiOperation, - ApiResponse, - ApiTags, - Route, -} from '@/decorators/swagger-decorators'; -@ApiTags('Attachments') @Service() export class AttachmentsController extends BaseController { @Inject() @@ -128,26 +121,6 @@ export class AttachmentsController extends BaseController { * @param {NextFunction} next * @returns {Promise} */ - @ApiResponse({ - status: 200, - description: 'Details of the given attachement', - schema: { - type: 'array', - items: { - type: 'object', - properties: { - id: { type: 'string' }, - name: { type: 'string' }, - email: { type: 'string' }, - }, - }, - }, - }) - @ApiOperation({ - summary: 'Retrieve a specific details of attachment', - description: 'Get all registered users', - }) - @Route('/attachments/:id') private async getAttachment( req: Request, res: Response, diff --git a/packages/server/src/api/controllers/Items/Items.ts b/packages/server/src/api/controllers/Items/Items.ts index ad9f25304..814358fd2 100644 --- a/packages/server/src/api/controllers/Items/Items.ts +++ b/packages/server/src/api/controllers/Items/Items.ts @@ -8,11 +8,6 @@ import { IItemDTO, ItemAction, AbilitySubject } from '@/interfaces'; import { DATATYPES_LENGTH } from '@/data/DataTypes'; import CheckAbilities from '@/api/middleware/CheckPolicies'; import { ItemsApplication } from '@/services/Items/ItemsApplication'; -import { - ApiOperation, - ApiResponse, - Route, -} from '@/decorators/swagger-decorators'; @Service() export default class ItemsController extends BaseController { @@ -203,22 +198,6 @@ export default class ItemsController extends BaseController { * @param {Request} req * @param {Response} res */ - @ApiResponse({ - status: 200, - description: 'Details of the given attachement', - schema: { - type: 'object', - properties: { - id: { type: 'string' }, - name: { type: 'string' }, - }, - }, - }) - @ApiOperation({ - summary: 'Creates a new item (inventory or service)', - description: 'Get all registered users', - }) - @Route('/items') private async newItem(req: Request, res: Response, next: NextFunction) { const { tenantId } = req; const itemDTO: IItemDTO = this.matchedBodyData(req); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d96720a9b..f26282a66 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -302,9 +302,6 @@ importers: source-map-loader: specifier: ^4.0.1 version: 4.0.2(webpack@5.91.0) - swagger-ui-express: - specifier: ^5.0.1 - version: 5.0.1(express@4.19.2) tmp-promise: specifier: ^3.0.3 version: 3.0.3 @@ -24211,20 +24208,6 @@ packages: stable: 0.1.8 dev: false - /swagger-ui-dist@5.17.14: - resolution: {integrity: sha512-CVbSfaLpstV65OnSjbXfVd6Sta3q3F7Cj/yYuvHMp1P90LztOLs6PfUnKEVAeiIVQt9u2SaPwv0LiH/OyMjHRw==} - dev: false - - /swagger-ui-express@5.0.1(express@4.19.2): - resolution: {integrity: sha512-SrNU3RiBGTLLmFU8GIJdOdanJTl4TOmT27tt3bWWHppqYmAZ6IDuEuBvMU6nZq0zLEe6b/1rACXCgLZqO6ZfrA==} - engines: {node: '>= v0.10.32'} - peerDependencies: - express: '>=4.0.0 || >=5.0.0-beta' - dependencies: - express: 4.19.2 - swagger-ui-dist: 5.17.14 - dev: false - /symbol-observable@1.2.0: resolution: {integrity: sha512-e900nM8RRtGhlV36KGEU9k65K3mPb1WV70OdjfxlG2EAuM1noi/E/BaW/uMhL7bPEssK8QV57vN3esixjUvcXQ==} engines: {node: '>=0.10.0'}