[jira] [Commented] (CASSSIDECAR-176) Write OpenAPI specs for Sidecar API

["Bernardo Botella Corbi (Jira)" <ji...@apache.org>]

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

Bernardo Botella Corbi commented on CASSSIDECAR-176:
----------------------------------------------------

Hi! Sorry for the late reply. I just made a new PR with a better annotations approach:
https://github.com/apache/cassandra-sidecar/pull/239

Also, here is the html it renders
 [^final-api-docs.html] 

> Write OpenAPI specs for Sidecar API
> -----------------------------------
>
>                 Key: CASSSIDECAR-176
>                 URL: https://issues.apache.org/jira/browse/CASSSIDECAR-176
>             Project: Sidecar for Apache Cassandra
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Bernardo Botella Corbi
>            Priority: Major
>         Attachments: final-api-docs.html, index.html, screenshot-1.png, screenshot-2.png
>
>          Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> As part of the efforts to document Sidecar, the API needs to be well documented. For that, the industry standard leans towards using OpenAPI (https://spec.openapis.org/oas/latest.html). This will allow us to provide meaningful and maintainable documentation in an open standard, allowing us to autogenerate html and clients dynamically.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org