RSTIMPRT plugin OPNsense/Dnsmasq setup doc

[mikesalz]

Added RSTIMPRT plugin OPNsense/Dnsmasq setup doc and supporting images

Summary by CodeRabbit

• Documentation
  • Added a comprehensive, step-by-step guide for configuring the RSTIMPRT plugin to import data from an OPNsense Dnsmasq REST API, including user privilege setup, API key/secret generation, connection details, and field mappings, with screenshots for each step.
• Chores
  • Updated VS Code settings to disable Postman dotenv-detection notification UI.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7363cd9d-0674-497f-9054-9fe1199f5d90

📥 Commits

Reviewing files that changed from the base of the PR and between 489463e and 5885b41.

📒 Files selected for processing (2)

• .vscode/settings.json
• docs/REST_IMPORT.md

✅ Files skipped from review due to trivial changes (1)

• docs/REST_IMPORT.md

---

📝 Walkthrough

Walkthrough

A new documentation file docs/REST_IMPORT.md is added with a step-by-step guide for importing OPNsense Dnsmasq device data via the RSTIMPRT plugin. VS Code settings are also updated to disable a Postman dotenv-detection notification.

Changes

Documentation and Configuration Updates

Layer / File(s)	Summary
REST import setup guide docs/REST_IMPORT.md	Adds the full guide with intro, steps to create an OPNsense user with the Dnsmasq DNS/DHCP privilege, steps to generate and download an API key/secret, and RSTIMPRT plugin configuration instructions covering REST URL, basic auth, and MAC/IP/hostname/vendor field mappings, with embedded screenshots throughout.
Developer environment configuration .vscode/settings.json	Adds a VS Code setting to disable Postman's dotenv-detection notification UI.

🐇 A guide hops in to show the way,
With API keys and REST at play,
OPNsense users, privileges bright,
Device fields mapped just right,
While VS Code quiets the Postman chime today! 🔔

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding documentation for setting up the RSTIMPRT plugin with OPNsense/Dnsmasq, which is the primary focus of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/REST_IMPORT.md (1)

31-37: ⚡ Quick win

Add guidance on disabling SSL verification for self-signed OPNsense certificates.

The example uses HTTPS (https://192.168.1.1:8443/...). Many OPNsense deployments use self-signed certificates. The plugin supports a Verify SSL option (disabled by default) — consider adding a note to disable it if users encounter SSL certificate validation errors.

💡 Suggested addition

After line 37, consider adding:

    - Verify SSL: Uncheck this if your OPNsense uses a self-signed certificate (common for local installations)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/REST_IMPORT.md` around lines 31 - 37, The documentation for
REST_IMPORT.md is missing guidance on SSL verification for self-signed
certificates commonly used in OPNsense deployments. Add a new bullet point after
the Password/API Secret field in the connection info list that explains the
Verify SSL option, noting that it should be unchecked if the OPNsense instance
uses a self-signed certificate to prevent SSL certificate validation errors when
connecting via HTTPS.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/REST_IMPORT.md`:
- Around line 48-49: The REST_IMPORT.md file has duplicate step numbering where
both the "Click **Update**" action and the "Click **Save**" action are numbered
as step 7. Change the numbering of the second step (the one with "Click
**Save**") from 7 to 8 to maintain proper sequential ordering of the numbered
list.

---

Nitpick comments:
In `@docs/REST_IMPORT.md`:
- Around line 31-37: The documentation for REST_IMPORT.md is missing guidance on
SSL verification for self-signed certificates commonly used in OPNsense
deployments. Add a new bullet point after the Password/API Secret field in the
connection info list that explains the Verify SSL option, noting that it should
be unchecked if the OPNsense instance uses a self-signed certificate to prevent
SSL certificate validation errors when connecting via HTTPS.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6895c964-e645-470e-a71f-fd9010a7971e

📥 Commits

Reviewing files that changed from the base of the PR and between bfbe04e and 489463e.

⛔ Files ignored due to path filters (5)

• docs/img/REST_IMPORT/opnsense_user.png is excluded by !**/*.png
• docs/img/REST_IMPORT/opnsense_user_api_key.png is excluded by !**/*.png
• docs/img/REST_IMPORT/opnsense_user_api_key_confirm.png is excluded by !**/*.png
• docs/img/REST_IMPORT/rstimport_config_1.png is excluded by !**/*.png
• docs/img/REST_IMPORT/rstimport_config_2.png is excluded by !**/*.png

📒 Files selected for processing (1)

• docs/REST_IMPORT.md

[jokob-sk]

revert settings.json