Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Add docs to Health-Check Rest API

Description

http://issues.opennms.org/browse/NMS-13312 have included OpenAPI yaml file which is not available outside codebase. 

Either we need to support OpenAPI fully on Minion so that user fetch documentation from URL or  add this in OpenNMS docs.

 

Acceptance / Success Criteria

None

Lucidchart Diagrams

Activity

Show:

Alberto January 20, 2022 at 3:49 PM

Merged to develop

Alberto January 11, 2022 at 2:14 AM

Jane Hou June 25, 2021 at 2:12 PM

I'll add it to our traditional adoc (https://issues.opennms.org/browse/NMS-13411) so that we can support both before we decide where to publish the OpenAPI doc. 

Chandra Gorantla June 24, 2021 at 9:01 PM

If we are unable to provide OpenAPI doc, we need to add doc for Health Rest API just like all other Rest API here:

https://github.com/OpenNMS/opennms/tree/develop/docs/modules/development/pages/rest

Otherwise it is not exposed to users.

Jane Hou June 24, 2021 at 8:49 PM
Edited

We are not going to provide run time OpenAPI doc generation in minion like OpenNMS does today because 1) Offline OpenAPI doc is always preferred than getting it during the runtime if we have a choice. 2) Generating OpenAPI doc during the runtime of an application will impact some performance of the application. Since minion is very sensitive to performance,  it's probably not a good idea to do that.

A common way to do this is publishing the Health Check OpenAPI doc to a web URL such as OpenNMS doc site or somewhere else. 

Fixed

Details

Assignee

Reporter

HB Grooming Date

HB Backlog Status

Doc Backlog Status

Doc Backlog Grooming Date

Sprint

Fix versions

Priority

PagerDuty

Created June 17, 2021 at 2:12 PM
Updated February 4, 2022 at 6:17 PM
Resolved January 20, 2022 at 3:49 PM