From cc832b2da7b008e3b2f3ce739e415f0e684b6de2 Mon Sep 17 00:00:00 2001 From: NickOvt Date: Thu, 9 May 2024 11:45:07 +0300 Subject: [PATCH] fix(api-endpoints): public_get and acme endpoints excluded from api docs generation ZMS-156 (#688) * Added submission api endpoint to api docs generation * exclude some acme and public endpoins from api docs generation * rename exclude to excludeRoute --- api.js | 2 +- lib/api/acme.js | 2 +- package-lock.json | 8 ++++---- package.json | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/api.js b/api.js index 8ea5ee5..bfc30d9 100644 --- a/api.js +++ b/api.js @@ -217,7 +217,7 @@ server.use( // public files server.get( - { name: 'public_get', path: '/public/*' }, + { name: 'public_get', path: '/public/*', excludeRoute: true }, restify.plugins.serveStatic({ directory: Path.join(__dirname, 'public'), default: 'index.html' diff --git a/lib/api/acme.js b/lib/api/acme.js index f3ea777..b2e6004 100644 --- a/lib/api/acme.js +++ b/lib/api/acme.js @@ -12,7 +12,7 @@ module.exports = (db, server, routeOptions) => { const acmeChallenge = AcmeChallenge.create({ db: db.database }); server.get( - { name: 'acmeToken', path: '/.well-known/acme-challenge/:token' }, + { name: 'acmeToken', path: '/.well-known/acme-challenge/:token', excludeRoute: true }, responseWrapper(async (req, res) => { res.charSet('utf-8'); diff --git a/package-lock.json b/package-lock.json index d2f4784..cf168eb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -60,7 +60,7 @@ "restify-cors-middleware2": "2.2.1", "restify-errors": "8.0.2", "restify-logger": "2.0.1", - "restifyapigenerate": "1.2.0", + "restifyapigenerate": "1.2.1", "search-string": "3.1.0", "seq-index": "1.1.0", "smtp-server": "3.13.4", @@ -8695,9 +8695,9 @@ } }, "node_modules/restifyapigenerate": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/restifyapigenerate/-/restifyapigenerate-1.2.0.tgz", - "integrity": "sha512-bSw4rQNnu60El+e4Y8oqzvgZgbtc+VemRc7xlCLPm0zE1VSm+6A/QT1Ob+4lu7E17PF+l+OZBIrCEEgxDl3lIg==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/restifyapigenerate/-/restifyapigenerate-1.2.1.tgz", + "integrity": "sha512-38LUDWrsbK14KnhdUwVxjqGCPeY+uPkXKxGLaEPc375YujWMpBl/Sve8XCyvfqoqSXce6fxqQt/tPqN4WVvt6Q==", "engines": { "node": ">=16.0.0" } diff --git a/package.json b/package.json index ee37d8e..859ce78 100644 --- a/package.json +++ b/package.json @@ -96,7 +96,7 @@ "restify-cors-middleware2": "2.2.1", "restify-errors": "8.0.2", "restify-logger": "2.0.1", - "restifyapigenerate": "1.2.0", + "restifyapigenerate": "1.2.1", "search-string": "3.1.0", "seq-index": "1.1.0", "smtp-server": "3.13.4",