Skip to content

NMS-19509: SNMP Config Rest API documentation#8360

Merged
synqotik merged 2 commits intofeatures/snmp-config-db-migrationfrom
jira/NMS-19509-snmp-config-rest-docs
Mar 26, 2026
Merged

NMS-19509: SNMP Config Rest API documentation#8360
synqotik merged 2 commits intofeatures/snmp-config-db-migrationfrom
jira/NMS-19509-snmp-config-rest-docs

Conversation

@synqotik
Copy link
Copy Markdown
Contributor

@synqotik synqotik commented Mar 16, 2026

Documentation for the new SNMP Configuration Rest API.

Moves the docs for the older XML-based APIs to a "Legacy" page.

I will make a separate ticket to go through the legacy APIs and see which are or are not still valid and update that documentation.

External References

@github-actions github-actions Bot added the docs label Mar 16, 2026
@synqotik synqotik force-pushed the jira/NMS-19509-snmp-config-rest-docs branch from dd90a1b to 2b3e027 Compare March 16, 2026 22:44
@synqotik synqotik marked this pull request as ready for review March 16, 2026 22:48
Copy link
Copy Markdown
Contributor

@cgorantla cgorantla left a comment

Choose a reason for hiding this comment

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

Looks good. couple of comments.

Comment thread docs/modules/development/pages/rest/snmp_configuration.adoc Outdated
Comment thread docs/modules/development/pages/rest/snmp_configuration.adoc Outdated
@synqotik synqotik requested a review from cgorantla March 23, 2026 21:06
Copy link
Copy Markdown
Contributor

@cgorantla cgorantla left a comment

Choose a reason for hiding this comment

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

LGTM!

@synqotik synqotik merged commit 261f252 into features/snmp-config-db-migration Mar 26, 2026
5 checks passed
@synqotik synqotik deleted the jira/NMS-19509-snmp-config-rest-docs branch March 26, 2026 16:46
synqotik added a commit that referenced this pull request Apr 2, 2026
* NMS-19226: Initial SNMP Config UI scaffolding (#8198)

* SNMP Config to DB: Migrate snmp-config.xml to CM

* NMS-19270: Rest API for SNMP Config, Lookup and Add/Remove Definitions (#8216)

* NMS-19270: Rest API for SNMP Config (get, lookup, add/remove definition)

* NMS-19270: Updates per PR review

* NMS-19270: PR review updates

* NMS-19265: SNMP Config Lookup and Definitions UI (#8230)

* Add github/copilot-instructions.md file

* NMS-19265: Add initial SNMP Config UI

* NMS-19265: Fixes after Copilot PR review

* NMS-19272: SNMP Config Rest API: Add, update and remove profiles (#8235)

* NMS-19272: SNMP Config Rest: add and remove profiles

* fix spacing

* Fix issue in AnAgentConfigFactory

* fix MenuHeaderIT

* NMS-19440: SNMP Config revised Lookup UI (#8247)

* NMS-19398: Save SNMP Profiles (#8254)

* NMS-19443: Add SCV UI component and SNMP Config support (#8269)

* NMS-19443: Some UI updates to Definitions table

* NMS-19443: SCVSearchDrawer and wire up to SNMP Config

* NMS-19443: scvStore unit tests

* User can click IP range badges to set SNMP Config details IP addresses

* fixes per PR review

* NMS-19397: SnmpConfigRestService integration tests (#8272)

* NMS-19456: SNMP Config upload/download Rest API (#8278)

* NMS-19456: SNMP Config upload/download Rest API

* NMS-19456: Updates as per PR review

* fixes as per Copilot review

* Remove unneeded event, other fix

* remove unneeded event

* NMS-19506: SNMP Config UI for upload and download

* fix loadConfig usage

Instead of using loadConfig at the retrieval, we need to do loadConfig in the updateConfig path
This will ensure cache to be updated after every update

* NMS-19507: Use dropdowns for some SNMP config items, move SCV icon
outside of FeatherInput

* NMS-19506: Fix issue where monitoring locations dropdown was not populating correctly

* Reset state when SnmpConfig mounted or remounted.

* NMS-19516: Snmp Config Rest API, add a complete definition

* Merge pull request #8303 from OpenNMS/jira/NMS-19517-snmp-config-full-definition-ui

NMS-19517: SNMP Config edit and remove full definitions; sorting

* NMS-19275: SNMP Config Default Override Rest API (#8330)

* NMS-19559: SNMP Config default override UI (#8338)

* NMS-19584: Add concurrently to UI to run builds in parallel (#8341)

* NMS-19542: Add search to SNMP Config definitions and profiles, layout updates (#8350)

* NMS-19542: SNMP Config layout updates, search

* Fix for unit test timeout issue

* Skip failing tests for now

* Updates as per PR review

* Add ui/CLAUDE.md

* more updates

* Profiles pagination

* Update node/vitest. Undo skipping some tests.

* remove CLAUDE.md

* NMS-19564: Display current default in hint in SNMP Config UI (#8361)

* NMS-19615: SNMP Config UI layout updates (#8364)

* NMS-19509: SNMP Config Rest API documentation (#8360)

* NMS-19509: SNMP Config Rest API docs

* NMS-19509: Fixes

* NMS-19623: Mask secrets 'toString()' output in SNMP Config model classes

* NMS-19623: Remove 'ValidationException' reference

* NMS-19623: Restrict SNMP Config Rest API to Admin and Provision roles

* more updates

* fix

* Fix smoke test for SNMP Config

* NMS-19263: guard against null in SnmpConfigManager

* null reference fixes and initial SnmpPeerFactory fix

* NMS-19623: Updates to locking logic, SnmpPeerFactory m_config and dao initialization

* fix integration test WillItUnmarshalIT

* fix

* Fix jaxb SnmpConfigTest

* Update opennms-dao/src/main/java/org/opennms/netmgt/dao/jaxb/callback/SnmpConfigConfigurationValidationCallback.java

Co-authored-by: Christian Pape <Christian.Pape@informatik.hs-fulda.de>

* NMS-19623: Suppress emitting empty profiles XML element in SnmpConfig

* Fix missing TTL from SnmpPeerFactory.saveDefaultOverrides and setConfigurationParams

---------

Co-authored-by: Christian Pape <Christian.Pape@informatik.hs-fulda.de>
Co-authored-by: Chandra Gorantla <chandra@opennms.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants