You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@guacamole.apache.org by "Patrick Jacobs (Jira)" <ji...@apache.org> on 2025/11/10 23:38:00 UTC
[jira] [Updated] (GUACAMOLE-2170) Add OpenAPI annotations in the Guacamole Rest API

     [ https://issues.apache.org/jira/browse/GUACAMOLE-2170?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Patrick Jacobs updated GUACAMOLE-2170:
--------------------------------------
    Description: 
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!

  was:
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.


> 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)