You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@guacamole.apache.org by "samir chahine (Jira)" <ji...@apache.org> on 2019/12/05 01:04:00 UTC

[jira] [Commented] (GUACAMOLE-809) Add documentation for the REST API

    [ https://issues.apache.org/jira/browse/GUACAMOLE-809?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16988358#comment-16988358 ] 

samir chahine commented on GUACAMOLE-809:
-----------------------------------------

I have already completed the work on this here: https://issues.apache.org/jira/browse/GUACAMOLE-872

Just awaiting CR, but you can still look through the code!

> Add documentation for the REST API
> ----------------------------------
>
>                 Key: GUACAMOLE-809
>                 URL: https://issues.apache.org/jira/browse/GUACAMOLE-809
>             Project: Guacamole
>          Issue Type: Wish
>          Components: Documentation
>            Reporter: Parth Mishra
>            Priority: Minor
>
> 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. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)