Skip to content

add us2 region for NinjaOne#58

Open
Deenk wants to merge 2 commits into
mainfrom
work/dw/PLUG-4644-ninjaone-us2-region
Open

add us2 region for NinjaOne#58
Deenk wants to merge 2 commits into
mainfrom
work/dw/PLUG-4644-ninjaone-us2-region

Conversation

@Deenk
Copy link
Copy Markdown
Contributor

@Deenk Deenk commented Jun 5, 2026

📋 Summary

Adds the US2 region as a selectable option for the NinjaOne plugin. A customer whose NinjaOne instance is hosted in the US2 region was unable to connect via SquaredUp, as only US, EU, Canada, and OC regions were previously available. This PR adds the US2 API base URL (https://us2-api.ninjarmm.com) to the region selector.


🔗 Related issue(s)

  • Relates to PLUG-4644

🧩 Plugin details

  • Plugin name: NinjaOne
  • Type of change:
    • Bug fix
    • New datastream
    • Enhancement to existing datastream
    • Performance improvement
    • Documentation / metadata / logo

⚠️ Breaking changes

Does this PR introduce any breaking changes?

  • No
  • Yes (please describe):

📚 Documentation

  • Documentation updated
  • No documentation changes needed

✅ Checklist

  • No secrets or credentials included
  • Plugin, datastream and UI naming follow SquaredUp guidelines
  • I agree to the Code of Conduct

@Deenk Deenk added the bug Something isn't working label Jun 5, 2026
@Deenk Deenk changed the title add us2 region add us2 region for NinjaOne Jun 5, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

🧩 Plugin PR Summary

📦 Modified Plugins

  • plugins/NinjaOne/v1

📋 Results

Step Status
Validation ✅ Passed
Deployment 🚀 Deployed

🔍 Validation Details

ninja-one
{
  "valid": true,
  "pluginName": "ninja-one",
  "pluginType": "cloud",
  "summary": {
    "Data Streams": 37,
    "Import Definitions": 1,
    "UI Configuration": true,
    "Has Icon": true,
    "Has Default Content": true,
    "Config Validation": true,
    "Custom Types": true
  }
}

@Deenk Deenk marked this pull request as ready for review June 5, 2026 15:42
@Deenk Deenk requested a review from a team June 5, 2026 15:42
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — small, mechanical config change adding US2 region with appropriate version bump.

Extended reasoning...

Overview

This PR adds the US2 region to the NinjaOne plugin's region selector in plugins/NinjaOne/v1/ui.json and bumps the plugin version in metadata.json from 1.1.11 to 1.1.12. The change consists of inserting one new option (https://api.us2.ninjarmm.com / US2) into an existing radio field, alongside the required version increment.

Security risks

None. The change adds a static URL constant to a radio dropdown — no auth code, no credential handling, no parsing logic, no user input processing. The base URL is still consumed by the existing OAuth2 clientCredentials flow defined in metadata.json, which is unchanged.

Level of scrutiny

Low. This is exactly the kind of mechanical, low-risk config change that fits the approval criteria — a single new entry in a list of allowed region values, following the established pattern of the other four entries. Validation passed in CI and the PR is correctly version-bumped per repo guidelines.

Other factors

A bug-hunter Nit was raised about docs/README.md line 24 still enumerating only the original four regions; this is a real but cosmetic inconsistency (the dropdown is authoritative, so functionality is unaffected) and is captured in an inline comment for the author to address. It is not severe enough to block approval. An earlier commit (02fec4f) on this branch already corrected the URL from the PR description's us2-api.ninjarmm.com to the correct api.us2.ninjarmm.com, so the URL form is current.

Comment on lines +13 to +16
{
"value": "https://api.us2.ninjarmm.com",
"label": "US2"
},
Copy link
Copy Markdown

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.md is 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), but plugins/NinjaOne/v1/docs/README.md was not updated. Line 24 still reads:

  1. Region: Select your NinjaOne instance region (US, EU, Canada, or OC). The API URL will be automatically configured based on your selection.

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 in metadata.json and 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

  1. A US2 NinjaOne customer opens the plugin configuration screen in SquaredUp.
  2. They click the "Help adding this plugin" link (defined in metadata.json links), or read the embedded help text.
  3. They see: "Select your NinjaOne instance region (US, EU, Canada, or OC)."
  4. Their region (US2) is not in the list, so they conclude the plugin doesn't support US2.
  5. They abandon the setup — even though the dropdown in ui.json now does in fact include US2 with https://api.us2.ninjarmm.com.

Impact

Cosmetic / documentation only — the radio button in ui.json is 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.md line 24 to include US2 in the enumeration:

1. **Region**: Select your NinjaOne instance region (US, US2, EU, Canada, or OC). The API URL will be automatically configured based on your selection.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Development

Successfully merging this pull request may close these issues.

1 participant