[
https://issues.apache.org/jira/browse/CASSSIDECAR-176?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17906827#comment-17906827
]
Bernardo Botella Corbi commented on CASSSIDECAR-176:
----------------------------------------------------
Turns out there was a lack of features on the version I was initially using.
The reason for using the old version is that Gradle was complaining with any
version newer than 7.1.0, so I stuck to a previous version. Now, thanks to
[this|https://github.com/apache/cassandra-sidecar/commit/d0825397a5e560b4fc1e7eb00f4ec79f18bc650b]
patch, after rebasing I can use a newer version that actually generates the
response payload examples.
I also modified the summary lines, so lines won't be duplicated anymore.
> 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: screenshot-1.png, screenshot-2.png
>
> Time Spent: 10m
> 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: [email protected]
For additional commands, e-mail: [email protected]
