[
https://issues.apache.org/jira/browse/GUACAMOLE-2170?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18037412#comment-18037412
]
Nick Couchman commented on GUACAMOLE-2170:
------------------------------------------
[~voidstarr] Is there some reason that this should be a separate issue from
GUACAMOLE-872?
The commit you referenced seems fine to me as a start - I think this is a great
step in the direction of getting some proper and automated API documentation!
> 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)
