[
https://issues.apache.org/jira/browse/CASSSIDECAR-176?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17906814#comment-17906814
]
Bernardo Botella Corbi commented on CASSSIDECAR-176:
----------------------------------------------------
Thanks for taking a look [~smiklosovic]!
1) That's on me. I duplicated the description AND summary lines. They are meant
to have different texts. Will update.
2) That's... Unexpected. I'll see if there is some tweaks to be done on the
generator.
3) That's also unexpected. There are examples for all the responses on the
spec. Let me check as well.
> 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]
