NMS-13493: Add OpenAPI docs for IpInterfaceRestService

[ssuman-opennms]

All Contributors

• [x] Have you read and followed our Contribution Guidelines?
• [x] Have you made an issue in the OpenNMS issue tracker?
  If so, you should:
  1. update the title of this PR to be of the format: ${JIRA-ISSUE-NUMBER}: subject of pull request
  2. update the JIRA link at the bottom of this comment to refer to the real issue number
  3. prefix your commit messages with the issue number, if possible
• [x] Have you made a comment in that issue which points back to this PR?
• [x] Have you updated the JIRA link at the bottom of this comment to link to your issue?
• [x] If this is a new or updated feature, is there documentation for the new behavior?
• [ ] If this is new code, are there unit and/or integration tests?
• [ ] If this PR targets a foundation-* branch, does it avoid changing files in $OPENNMS_HOME/etc/?

Pull Request Process

One or more reviewers should be assigned to each PR.

If you know that a particular person is subject matter expert in the area your PR affects, feel free to assign one or more reviewers when you create this PR, otherwise reviewers will be assigned for you.

If you have made additions or changes to the documentation, or if you need documentation for these code changes, please make sure a technical writer has looked it over.

Once the reviewer(s) accept the PR and the branch passes continuous integration, the PR is eligible for merge.

At that time, if you have commit access (are an OpenNMS Group employee or a member of the Order of the Green Polo) you are welcome to merge the PR. Otherwise, a reviewer can merge it for you.

Thanks for taking time to contribute!

External References

• JIRA (Issue Tracker): http://issues.opennms.org/browse/NMS-13493

[indigo423]

Hello, @ssuman-opennms can you please spend a little bit more love when you create PR`s? See here:

[uguggilam]

1. Reference to https://docs.opennms.com/horizon/28.0.2/development/rest/ipinterfaces.html , reviewed and removed PUT and POST contracts from IPInterfaceRest Service API and expose read only API (GET).
2. Updated Swagger descriptions, API response codes and service class to add unimplemented API contracts.
3. Unit tested updated changes in local. please find attached screenshots for reference

[CLAassistant]

All committers have signed the CLA.

[cgorantla]

Validated this Rest API, everything works as before, minor doc comments.

[RangerRick]

closing this, as it's been superceded by #5420 (which is also blocked by mis-generated API info, but at least we won't have 2 of them)