From e696767ab058549340998e696010d72de07dc600 Mon Sep 17 00:00:00 2001 From: Jordan Pina <106619535+jpina1-godaddy@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:01:52 -0800 Subject: [PATCH] [PFX-783] Docs: update swagger plugin docs on how to generate a new swagger.json (#956) * docs: added bit on running build to update swagger file * chore: update package-lock --- package-lock.json | 78 +++++++++++++++++++++++- packages/gasket-plugin-swagger/README.md | 3 + 2 files changed, 78 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index d71d8c4bb..5f5147132 100644 --- a/package-lock.json +++ b/package-lock.json @@ -188,6 +188,16 @@ "@algolia/transporter": "4.24.0" } }, + "node_modules/@algolia/client-common": { + "version": "5.12.0", + "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.12.0.tgz", + "integrity": "sha512-od3WmO8qxyfNhKc+K3D17tvun3IMs/xMNmxCG9MiElAkYVbPPTRUYMkRneCpmJyQI0hNx2/EA4kZgzVfQjO86Q==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 14.0.0" + } + }, "node_modules/@algolia/client-personalization": { "version": "4.24.0", "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-4.24.0.tgz", @@ -211,6 +221,22 @@ "@algolia/transporter": "4.24.0" } }, + "node_modules/@algolia/client-search": { + "version": "5.12.0", + "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.12.0.tgz", + "integrity": "sha512-R3qzEytgVLHOGNri+bpta6NtTt7YtkvUe/QBcAmMDjW4Jk1P0eBYIPfvnzIPbINRsLxIq9fZs9uAYBgsrts4Zg==", + "dev": true, + "peer": true, + "dependencies": { + "@algolia/client-common": "5.12.0", + "@algolia/requester-browser-xhr": "5.12.0", + "@algolia/requester-fetch": "5.12.0", + "@algolia/requester-node-http": "5.12.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, "node_modules/@algolia/events": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", @@ -298,6 +324,19 @@ "@algolia/requester-common": "4.24.0" } }, + "node_modules/@algolia/requester-browser-xhr": { + "version": "5.12.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.12.0.tgz", + "integrity": "sha512-KxwleraFuVoEGCoeW6Y1RAEbgBMS7SavqeyzWdtkJc6mXeCOJXn1iZitb8Tyn2FcpMNUKlSm0adrUTt7G47+Ow==", + "dev": true, + "peer": true, + "dependencies": { + "@algolia/client-common": "5.12.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, "node_modules/@algolia/requester-common": { "version": "4.24.0", "resolved": "https://registry.npmjs.org/@algolia/requester-common/-/requester-common-4.24.0.tgz", @@ -305,6 +344,32 @@ "dev": true, "license": "MIT" }, + "node_modules/@algolia/requester-fetch": { + "version": "5.12.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.12.0.tgz", + "integrity": "sha512-FuDZXUGU1pAg2HCnrt8+q1VGHKChV/LhvjvZlLOT7e56GJie6p+EuLu4/hMKPOVuQQ8XXtrTHKIU3Lw+7O5/bQ==", + "dev": true, + "peer": true, + "dependencies": { + "@algolia/client-common": "5.12.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, + "node_modules/@algolia/requester-node-http": { + "version": "5.12.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.12.0.tgz", + "integrity": "sha512-ncDDY7CxZhMs6LIoPl+vHFQceIBhYPY5EfuGF1V7beO0U38xfsCYEyutEFB2kRzf4D9Gqppn3iWX71sNtrKcuw==", + "dev": true, + "peer": true, + "dependencies": { + "@algolia/client-common": "5.12.0" + }, + "engines": { + "node": ">= 14.0.0" + } + }, "node_modules/@algolia/transporter": { "version": "4.24.0", "resolved": "https://registry.npmjs.org/@algolia/transporter/-/transporter-4.24.0.tgz", @@ -8923,6 +8988,7 @@ "os": [ "darwin" ], + "peer": true, "engines": { "node": ">=10" } @@ -8940,6 +9006,7 @@ "os": [ "darwin" ], + "peer": true, "engines": { "node": ">=10" } @@ -8957,6 +9024,7 @@ "os": [ "linux" ], + "peer": true, "engines": { "node": ">=10" } @@ -8974,6 +9042,7 @@ "os": [ "linux" ], + "peer": true, "engines": { "node": ">=10" } @@ -8991,6 +9060,7 @@ "os": [ "linux" ], + "peer": true, "engines": { "node": ">=10" } @@ -9008,6 +9078,7 @@ "os": [ "linux" ], + "peer": true, "engines": { "node": ">=10" } @@ -9025,6 +9096,7 @@ "os": [ "linux" ], + "peer": true, "engines": { "node": ">=10" } @@ -9042,6 +9114,7 @@ "os": [ "win32" ], + "peer": true, "engines": { "node": ">=10" } @@ -9059,6 +9132,7 @@ "os": [ "win32" ], + "peer": true, "engines": { "node": ">=10" } @@ -9076,6 +9150,7 @@ "os": [ "win32" ], + "peer": true, "engines": { "node": ">=10" } @@ -17090,7 +17165,6 @@ "version": "0.1.13", "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", - "dev": true, "license": "MIT", "optional": true, "dependencies": { @@ -17101,7 +17175,6 @@ "version": "0.6.3", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", - "dev": true, "license": "MIT", "optional": true, "dependencies": { @@ -35568,7 +35641,6 @@ "version": "4.2.1", "resolved": "https://registry.npmjs.org/redux/-/redux-4.2.1.tgz", "integrity": "sha512-LAUYz4lc+Do8/g7aeRa8JkyDErK6ekstQaqWQrNRW//MY1TvCEpMtpTWvlQ+FPbWCx+Xixu/6SHt5N0HR+SB4w==", - "dev": true, "license": "MIT", "dependencies": { "@babel/runtime": "^7.9.2" diff --git a/packages/gasket-plugin-swagger/README.md b/packages/gasket-plugin-swagger/README.md index 3b212351c..e24771229 100644 --- a/packages/gasket-plugin-swagger/README.md +++ b/packages/gasket-plugin-swagger/README.md @@ -43,6 +43,9 @@ By specifying the `swagger.jsdocs` options in the `gasket.js`, the Swagger definition file will be generated with `npm run build`. It can be output to either a JSON (default) or YAML file. +To keep your Swagger definition file up-to-date, you can run `npm run build` whenever you make changes to the swagger property in your +`gasket.js` file or modify JSDoc comments in your routes folder. This will rebuild the Swagger file to capture the latest updates accurately. + ```js // gasket.js