Uploaded image for project: 'Guacamole'
  1. Guacamole
  2. GUACAMOLE-809

Add documentation for the REST API

    XMLWordPrintableJSON

Details

    • Wish
    • Status: Closed
    • Minor
    • Resolution: Duplicate
    • None
    • None
    • Documentation
    • None

    Description

      The Java Servlet exposes HTTP endpoints as the basis for REST API calls from the frontend client. Currently, there is no easy way to know what these endpoints are without viewing the source code or inspecting the network calls.

      I suggest integrating some API documentation tool (e.g. Swagger) to expose this information in a more accessible manner. 

      Attachments

        Issue Links

          duplicates

          Improvement - An improvement or enhancement to an existing feature or task. GUACAMOLE-872 Guacamole Rest API Documentation

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Activity

            People

              Unassigned Unassigned
              parth.mishra Parth Mishra
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: