[
https://issues.apache.org/jira/browse/CASSSIDECAR-176?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17906362#comment-17906362
]
Stefan Miklosovic edited comment on CASSSIDECAR-176 at 12/17/24 10:11 AM:
--------------------------------------------------------------------------
I am commenting just on what I see, not sure if we can do something about that
at all:
1) it seems like there are duplicate lines like this, not sure why
!screenshot-1.png!
2) when I hover over some section, it will change its background to white and
then I just don't see where I am
!screenshot-2.png!
3) It would be cool to have some examples of responses when JSON is returned.
All I see now is that it returned 200 and that's it.
I have tested this in Firefox 133.0
was (Author: smiklosovic):
I am commenting just on what I see, not sure if we can do something about that
at all:
1) it seems like there are duplicate lines like this, not sure why
!screenshot-1.png!
2) when I hover over some section, it will change it background to while and
then I just don't see where I am
!screenshot-2.png!
3) It would be cool to have some examples of responses when JSON is returned.
All I see now is that it returned 200 and that's it.
I have tested this in Firefox 133.0
> 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]
