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

Investigate using openAPI&Swagger to document v2 RESTful API

    XMLWordPrintable

Details

    • Task
    • Status: Resolved (View Workflow)
    • Minor
    • Resolution: Fixed
    • 28.0.0
    • 28.0.0
    • None
    • Security Level: Default (Default Security Scheme)
    • None
    • 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

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

              Dates

                Created:
                Updated:
                Resolved:

                Git Integration

                  Error rendering 'com.xiplink.jira.git.jira_git_plugin:git-issue-webpanel'. Please contact your Jira administrators.