From 3decabe03934a8f0ecebc1c81b50b5f12ec73ab5 Mon Sep 17 00:00:00 2001 From: saisilinus Date: Tue, 26 Apr 2022 16:41:32 +0300 Subject: [PATCH] fix(components.yaml): move components.yaml out of src Move components.yaml out of src to prevent code duplication BREAKING CHANGE: swagger routes have to use the new components.yaml path i.e. packages/components.yaml --- dist/routes/v1/swagger.route.js | 2 +- dist/routes/v1/swagger.route.js.map | 2 +- .../swagger => packages}/components.yaml | 0 src/modules/swagger/components.yaml | 100 ------------------ src/routes/v1/swagger.route.ts | 2 +- 5 files changed, 3 insertions(+), 103 deletions(-) rename {dist/modules/swagger => packages}/components.yaml (100%) delete mode 100644 src/modules/swagger/components.yaml diff --git a/dist/routes/v1/swagger.route.js b/dist/routes/v1/swagger.route.js index d2d761d..b381c39 100644 --- a/dist/routes/v1/swagger.route.js +++ b/dist/routes/v1/swagger.route.js @@ -6,7 +6,7 @@ import swaggerDefinition from '../../modules/swagger/swagger.definition'; const router = express.Router(); const specs = swaggerJsdoc({ swaggerDefinition, - apis: ['dist/modules/swagger/components.yaml', 'dist/routes/v1/*.js'], + apis: ['packages/components.yaml', 'dist/routes/v1/*.js'], }); router.use('/', swaggerUi.serve); router.get( diff --git a/dist/routes/v1/swagger.route.js.map b/dist/routes/v1/swagger.route.js.map index e045f75..cb86ce0 100644 --- a/dist/routes/v1/swagger.route.js.map +++ b/dist/routes/v1/swagger.route.js.map @@ -1 +1 @@ -{"version":3,"file":"swagger.route.js","sourceRoot":"","sources":["../../../src/routes/v1/swagger.route.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,iBAAiB,MAAM,0CAA0C,CAAC;AAEzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;AAEhC,MAAM,KAAK,GAAG,YAAY,CAAC;IACzB,iBAAiB;IACjB,IAAI,EAAE,CAAC,sCAAsC,EAAE,qBAAqB,CAAC;CACtE,CAAC,CAAC;AAEH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;AACjC,MAAM,CAAC,GAAG,CACR,GAAG,EACH,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE;IACrB,QAAQ,EAAE,IAAI;CACf,CAAC,CACH,CAAC;AAEF,eAAe,MAAM,CAAC"} \ No newline at end of file +{"version":3,"file":"swagger.route.js","sourceRoot":"","sources":["../../../src/routes/v1/swagger.route.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,iBAAiB,MAAM,0CAA0C,CAAC;AAEzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;AAEhC,MAAM,KAAK,GAAG,YAAY,CAAC;IACzB,iBAAiB;IACjB,IAAI,EAAE,CAAC,0BAA0B,EAAE,qBAAqB,CAAC;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;AACjC,MAAM,CAAC,GAAG,CACR,GAAG,EACH,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE;IACrB,QAAQ,EAAE,IAAI;CACf,CAAC,CACH,CAAC;AAEF,eAAe,MAAM,CAAC"} \ No newline at end of file diff --git a/dist/modules/swagger/components.yaml b/packages/components.yaml similarity index 100% rename from dist/modules/swagger/components.yaml rename to packages/components.yaml diff --git a/src/modules/swagger/components.yaml b/src/modules/swagger/components.yaml deleted file mode 100644 index efea42c..0000000 --- a/src/modules/swagger/components.yaml +++ /dev/null @@ -1,100 +0,0 @@ -components: - schemas: - User: - type: object - properties: - id: - type: string - email: - type: string - format: email - name: - type: string - role: - type: string - enum: [user, admin] - example: - id: 5ebac534954b54139806c112 - email: fake@example.com - name: fake name - role: user - - Token: - type: object - properties: - token: - type: string - expires: - type: string - format: date-time - example: - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1ZWJhYzUzNDk1NGI1NDEzOTgwNmMxMTIiLCJpYXQiOjE1ODkyOTg0ODQsImV4cCI6MTU4OTMwMDI4NH0.m1U63blB0MLej_WfB7yC2FTMnCziif9X8yzwDEfJXAg - expires: 2020-05-12T16:18:04.793Z - - AuthTokens: - type: object - properties: - access: - $ref: '#/components/schemas/Token' - refresh: - $ref: '#/components/schemas/Token' - - UserWithTokens: - type: object - properties: - user: - $ref: '#/components/schemas/User' - tokens: - $ref: '#/components/schemas/AuthTokens' - - Error: - type: object - properties: - code: - type: number - message: - type: string - - responses: - DuplicateEmail: - description: Email already taken - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: 400 - message: Email already taken - Unauthorized: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: 401 - message: Please authenticate - Forbidden: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: 403 - message: Forbidden - NotFound: - description: Not found - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: 404 - message: Not found - - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT \ No newline at end of file diff --git a/src/routes/v1/swagger.route.ts b/src/routes/v1/swagger.route.ts index 2858b2b..fb9c1e6 100644 --- a/src/routes/v1/swagger.route.ts +++ b/src/routes/v1/swagger.route.ts @@ -7,7 +7,7 @@ const router = express.Router(); const specs = swaggerJsdoc({ swaggerDefinition, - apis: ['dist/modules/swagger/components.yaml', 'dist/routes/v1/*.js'], + apis: ['packages/components.yaml', 'dist/routes/v1/*.js'], }); router.use('/', swaggerUi.serve);