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

Evaluate Swagger for REST API documentation

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Resolved (View Workflow)
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 28.0.0
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None

      Description

      Right now our REST API is documented and organized manually. There are tools available which allow building feature-rich documentation, where one of them is https://swagger.io. Evaluate if this we can use this documentation framework in our code base.

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Git Integration