From cdff8d286abb3118b8eeaac3b0946b14814dcb02 Mon Sep 17 00:00:00 2001 From: Julian Lam Date: Mon, 28 Dec 2020 19:38:22 -0500 Subject: [PATCH] chore(api): add deprecation notices re: #9123 --- src/controllers/api.js | 5 +++++ src/routes/api.js | 1 + 2 files changed, 6 insertions(+) diff --git a/src/controllers/api.js b/src/controllers/api.js index f6748dfb81..432507f969 100644 --- a/src/controllers/api.js +++ b/src/controllers/api.js @@ -2,6 +2,7 @@ const validator = require('validator'); const nconf = require('nconf'); +const winston = require('winston'); const meta = require('../meta'); const user = require('../user'); @@ -152,6 +153,10 @@ apiController.getObject = async function (req, res, next) { if (!method) { return next(); } + + winston.warn('[api] This route has been deprecated and will likely be removed in v1.17.0'); + winston.warn('[api] Use GET /api/v3/(posts|topics|categories)/:id instead'); + try { const result = await method(req.params.id, req.uid); if (!result) { diff --git a/src/routes/api.js b/src/routes/api.js index 3280246626..3461a28550 100644 --- a/src/routes/api.js +++ b/src/routes/api.js @@ -19,6 +19,7 @@ module.exports = function (app, middleware, controllers) { router.get('/user/uid/:userslug/export/uploads', middleware.checkAccountPermissions, middleware.exposeUid, controllers.user.exportUploads); router.get('/user/uid/:userslug/export/profile', middleware.checkAccountPermissions, middleware.exposeUid, controllers.user.exportProfile); + // TODO: Deprecate in v1.17.0 router.get('/:type/pid/:id', middleware.authenticateOrGuest, controllers.api.getObject); router.get('/:type/tid/:id', middleware.authenticateOrGuest, controllers.api.getObject); router.get('/:type/cid/:id', middleware.authenticateOrGuest, controllers.api.getObject);