Skip to content

Commit aa97e7f

Browse files
authored
fix: update docs for getobject (#178)
1 parent 9bf39cd commit aa97e7f

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/app.ts

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ const build = (opts: buildOpts = {}): FastifyInstance => {
4141
tags: [
4242
{ name: 'object', description: 'Object end-points' },
4343
{ name: 'bucket', description: 'Bucket end-points' },
44+
{ name: 'deprecated', description: 'Deprecated end-points' },
4445
],
4546
},
4647
})

src/routes/object/getObject.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -116,18 +116,17 @@ export default async function routes(fastify: FastifyInstance) {
116116
}
117117
)
118118

119-
// to be deprecated
120119
fastify.get<getObjectRequestInterface>(
121120
'/:bucketName/*',
122121
{
123122
// @todo add success response schema here
124123
schema: {
125124
params: getObjectParamsSchema,
126125
headers: { $ref: 'authSchema#' },
127-
summary:
128-
'Deprecated (use GET /object/authenticated/{bucketName} instead): Retrieve an object',
126+
summary: 'Get object (deprecated)',
127+
description: 'use GET /object/authenticated/{bucketName} instead',
129128
response: { '4xx': { $ref: 'errorSchema#' } },
130-
tags: ['object'],
129+
tags: ['deprecated'],
131130
},
132131
},
133132
async (request, response) => {

0 commit comments

Comments
 (0)