Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-13225

Update Help page with doc links in the Web UI

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Closed (View Workflow)
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: 27.1.1, 28.0.0
    • Fix Version/s: Meridian-2021.1.0, 28.0.0
    • Component/s: Documentation
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None
    • Sprint:
      Horizon 2021 - Apr 14 - Apr 28, Horizon 2021 - Apr 28 - May 12
    • HB Backlog Status:
      Backlog

      Description

      With 27.x we migrate from Maven-based AsciiDoc to Antora. We need to update the documentation links in the OpenNMS web UI. Additionally, we add Swagger UI for our REST API. We need to add the links for the OpenAPI doc and Swagger UI in the links as well.

      FYI: The Swagger UI doesn't have a good backlink option, so it might be the easiest we open the Swagger UI in a new tab.

      OpenAPI doc: http://localhost:8980/opennms/api/v2/openapi.json
      Swagger UI: http://localhost:8980/opennms/api/v2/api-docs/?url=/opennms/api/v2/openapi.json#/

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jane.hou Jane Hou
              Reporter:
              indigo Ronny Trommer
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                HB Grooming Date:

                  Git Integration