[
https://issues.apache.org/jira/browse/GUACAMOLE-2170?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18037508#comment-18037508
]
Patrick Jacobs commented on GUACAMOLE-2170:
-------------------------------------------
While discussing a similar need, I figure that GUACAMOLE-872 addresses the
manual directly, where this issue addresses the need for documentation starting
with the source. I'm happy to move my effort to GUACAMOLE-872 if that would be
more clear, but I think this current issue will be closed when the the REST API
in the source is fully annotated, then I can move on to GUACAMOLE-872 and
figure out some way to represent that documentation in the manual.
Thanks for the feedback! I'll continue annotating the endpoints with
[swagger|https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations/6815224d93218996ff52fa57eb84ca6d3d75aae1].
> Add OpenAPI annotations in the Guacamole Rest API
> -------------------------------------------------
>
> Key: GUACAMOLE-2170
> URL: https://issues.apache.org/jira/browse/GUACAMOLE-2170
> Project: Guacamole
> Issue Type: Improvement
> Components: guacamole
> Reporter: Patrick Jacobs
> Priority: Minor
> Labels: documentation
>
> Adding [Swagger{{{{}}{}}}|https://github.com/swagger-api/swagger-core] will
> automatically generate OpenAPI definitions that can be consumed by client
> generators such as
> [https://github.com/openapi-generators/openapi-python-client|https://github.com/openapi-generators/openapi-python-client.].
> As mentioned in GUACAMOLE-872 and
> [https://github.com/apache/guacamole-manual/pull/123] there is need for
> proper documentation for the client REST API, and this is a step in that
> direction.
>
> This commit is a start:
> [https://github.com/voidstarr/guacamole-client/commit/98cff504ac0f678ad918dcb72555a6bde99d3864]
> I'd like some feedback before continuing down this line.
> Thanks!
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
