docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Support Multi Instance

Open philip-ellis-sp opened this issue 3 years ago • 4 comments

Description

Added ability to generate and clean api docs for all instances when more than one are defined

Motivation and Context

This fixes an issue where you cannot cli commands when more than one instance is defined (https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/231)

How Has This Been Tested?

Ran the CLI with multi and single instance defined, ensured docs are created and cleaned without issue

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • [x] I have updated the documentation accordingly.
  • [x] I have read the CONTRIBUTING document.
  • [x] I have added tests to cover my changes if appropriate.
  • [x] All new and existing tests passed.

philip-ellis-sp avatar Sep 06 '22 14:09 philip-ellis-sp

:tada: Thanks for opening this pull request! We really appreciate contributors like you! :raised_hands:

Visit the preview URL for this PR (updated for commit 8135c3d):

https://docusaurus-openapi-36b86--pr243-j4wn1b6j.web.app

(expires Thu, 06 Oct 2022 14:35:34 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

github-actions[bot] avatar Sep 06 '22 14:09 github-actions[bot]

Thanks for the PR @philip-ellis-sp!

Does this implementation run the commands against all instances? If yes, does it also require config keys to be globally unique?

sserrata avatar Sep 06 '22 15:09 sserrata

Hi @philip-ellis-sp, thanks again for opening this PR! It really helped point me in the right direction. I went ahead and merged a PR that should bring multi-instance support to the CLI with a new -p or --plugin-id option. You can upgrade to 0.0.0-441 to preview/test. I appreciate any feedback.

sserrata avatar Sep 07 '22 18:09 sserrata