fix: add route description (#182)

Author: inian

src/routes/object/getObject.ts

@@ -107,7 +107,7 @@ export default async function routes(fastify: FastifyInstance) {
         params: getObjectParamsSchema,
         headers: { $ref: 'authSchema#' },
         summary,
-        response: { '4xx': { $ref: 'errorSchema#' } },
+        response: { '4xx': { $ref: 'errorSchema#', description: 'Error response' } },
         tags: ['object'],
       },
     },
@@ -123,7 +123,7 @@ export default async function routes(fastify: FastifyInstance) {
       schema: {
         params: getObjectParamsSchema,
         headers: { $ref: 'authSchema#' },
-        summary: 'Get object (deprecated)',
+        summary: 'Get object',
         description: 'use GET /object/authenticated/{bucketName} instead',
         response: { '4xx': { $ref: 'errorSchema#' } },
         tags: ['deprecated'],

src/routes/object/getPublicObject.ts

@@ -42,7 +42,7 @@ export default async function routes(fastify: FastifyInstance) {
       schema: {
         params: getPublicObjectParamsSchema,
         summary,
-        response: { '4xx': { $ref: 'errorSchema#' } },
+        response: { '4xx': { $ref: 'errorSchema#', description: 'Error response' } },
         tags: ['object'],
       },
     },

src/routes/object/getSignedObject.ts

@@ -58,7 +58,7 @@ export default async function routes(fastify: FastifyInstance) {
         params: getSignedObjectParamsSchema,
         querystring: getSignedObjectQSSchema,
         summary,
-        response: { '4xx': { $ref: 'errorSchema#' } },
+        response: { '4xx': { $ref: 'errorSchema#', description: 'Error response' } },
         tags: ['object'],
       },
     },

src/schemas/auth.ts

@@ -2,7 +2,12 @@ export const authSchema = {
   $id: 'authSchema',
   type: 'object',
   properties: {
-    authorization: { type: 'string' },
+    authorization: {
+      type: 'string',
+      examples: [
+        'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs',
+      ],
+    },
   },
   required: ['authorization'],
 } as const

src/test/generic-routes.test.ts

@@ -47,21 +47,29 @@ describe('testing Generic Routes Utils', () => {
 
   describe('creating generic schema [createDefaultSchema]', () => {
     test('create generic schema without additional properties', () => {
-      const successResponseSchema = { generic: 'example' }
+      const successResponseSchema = { generic: 'example', description: 'Successful response' }
       const response = {
         headers: { $ref: 'authSchema#' },
-        response: { 200: successResponseSchema, '4xx': { $ref: 'errorSchema#' } },
+        response: {
+          200: successResponseSchema,
+          '4xx': { $ref: 'errorSchema#', description: 'Error response' },
+        },
       }
 
       expect(createDefaultSchema(successResponseSchema, {})).toEqual(response)
     })
 
     test('create generic schema with additional properties', () => {
-      const successResponseSchema = { generic: 'example' }
+      const successResponseSchema = { generic: 'example', description: 'Successful response' }
       const additionalProperties = { generic: 'example' }
       const response = {
-        headers: { $ref: 'authSchema#' },
-        response: { 200: successResponseSchema, '4xx': { $ref: 'errorSchema#' } },
+        headers: {
+          $ref: 'authSchema#',
+        },
+        response: {
+          200: successResponseSchema,
+          '4xx': { $ref: 'errorSchema#', description: 'Error response' },
+        },
         ...additionalProperties,
       }
 

src/utils/generic-routes.ts

@@ -27,7 +27,10 @@ function createResponse(message: string, status?: string, error?: string): Bucke
 function createDefaultSchema(successResponseSchema: any, properties: any): any {
   return {
     headers: { $ref: 'authSchema#' },
-    response: { 200: successResponseSchema, '4xx': { $ref: 'errorSchema#' } },
+    response: {
+      200: { description: 'Successful response', ...successResponseSchema },
+      '4xx': { description: 'Error response', $ref: 'errorSchema#' },
+    },
     ...properties,
   }
 }