Add OpenAPI docs for Node Rest API

Description

Add OpenAPI docs for Node Rest API
Example Annotations here

 

 

Acceptance / Success Criteria

Swagger UI should be able to display  description, Response codes and Model objects, parameters that need to be supplied.

 Bonus: Make sure all existing paths cover error-cases and write test cases for error checks.

Attachments

1

Lucidchart Diagrams

Activity

Show:

Tikayat Mohanta September 1, 2021 at 2:45 PM

I have completed Testing attaching Test Result . 

I have raise PR : https://github.com/OpenNMS/opennms/pull/3616

Tikayat Mohanta August 30, 2021 at 1:10 PM
Edited

Task Name

Status (In Progress, Done, On Hold, Pending)

Comments

Analysis

 Done

 

Coding
-Api Creation (Done)
-Updating service class to implement new service api (Done)
-Able to see changes in Swagger UI(Done)

Done

 

Unit Testing

Done

 

Internal code review

Done

 

 fixing internal code review comment

Done

 

Client Code review

Pending

 

Pushing to git

Done

 

Merge Request

Raised PR to Chandra

 

Won't Fix

Details

Assignee

Reporter

Priority

PagerDuty

Created August 5, 2021 at 9:46 PM
Updated March 2, 2022 at 8:48 PM
Resolved February 15, 2022 at 6:58 PM