-
Notifications
You must be signed in to change notification settings - Fork 1
add us2 region for NinjaOne #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Deenk
wants to merge
2
commits into
main
Choose a base branch
from
work/dw/PLUG-4644-ninjaone-us2-region
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π‘ The README enumerates only "US, EU, Canada, or OC" as available regions and was not updated to include the new US2 option added in ui.json. Since
docs/README.mdis rendered in-product during plugin setup, a US2 customer reading these docs may incorrectly conclude their region is unsupported. Fix by updating line 24 to read(US, US2, EU, Canada, or OC).Extended reasoning...
What the bug is
This PR adds US2 as a fifth region option in
plugins/NinjaOne/v1/ui.json(lines 13-16), butplugins/NinjaOne/v1/docs/README.mdwas not updated. Line 24 still reads:The PR checklist marks
No documentation changes needed, but the README explicitly enumerates the available regions rather than describing them generically, so the new option needs to be added to keep the docs in sync with the UI.Why this matters
The README in
plugins/NinjaOne/v1/docs/is shown in-product to users during plugin configuration (it powers the "Help adding this plugin" link referenced inmetadata.jsonand is rendered in the configuration UI). A US2 customer β exactly the customer this PR is trying to unblock per PLUG-4644 β could read this enumeration during setup and conclude their region is not supported, defeating the user-facing goal of the PR.Step-by-step proof
metadata.jsonlinks), or read the embedded help text.ui.jsonnow does in fact includeUS2withhttps://api.us2.ninjarmm.com.Impact
Cosmetic / documentation only β the radio button in
ui.jsonis authoritative and a customer who looks at the dropdown directly will see US2. Functionality is not broken. Hence nit severity. But this directly contradicts the PR's stated user-facing goal of making US2 reachable, so it's worth fixing in this same PR.How to fix
Update
plugins/NinjaOne/v1/docs/README.mdline 24 to include US2 in the enumeration:No other documentation changes appear necessary β US2 doesn't require a separate setup flow, just a different base URL, which the existing prose already covers.