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

Investigate using openAPI&Swagger to document v2 RESTful API

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 28.0.0
    • Fix Version/s: 28.0.0
    • Component/s: None
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None
    • Sprint:
      Horizon 2021 - Feb 17 - Mar 3, Horizon 2021 - Mar 3 - Mar 17, Horizon 2021 - Mar 17 - Mar 31

      Description

      API documentation often follows a docs-as-code workflow, where the tools to author and publish documentation align closely with the same tools developers use to write, manage, build, and deploy code.

      Investigate using OpenAPI/Swagger for API documentation and code generation. Also, Swagger UI can be very useful for users to make restful calls directly while reading the document. 

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jane.hou Jane Hou
              Reporter:
              jane.hou Jane Hou
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Git Integration