[PFX-783] Docs: update swagger plugin docs on how to generate a new s…

…wagger.json (#956) * docs: added bit on running build to update swagger file * chore: update package-lock
godaddy · Nov 4, 2024 · e696767 · e696767
1 parent d0cd6dd
commit e696767
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git 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