errose28 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2718753242
########## src/components/SwaggerUI/styles.module.css: ########## Review Comment: Can we leave the GET and PUT blocks in their original colors instead of making everything green? Those colors are standard across Swagger UIs and serve as visual cues for readers to the types of calls when skimming the page. ########## docs/05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.mdx: ########## @@ -0,0 +1,11 @@ +# Recon REST API + +import SwaggerUI from '@site/src/components/SwaggerUI'; + +Ozone Recon's public **REST API** follows the [OpenAPI specification](https://www.openapis.org/), and is documented below. The docs are generated using [Swagger React UI](https://github.com/swagger-api/swagger-ui). + +:::info Review Comment: I don't think this is actually working. When I click `Execute` it is going to the same host and port the website is running on (localhost:3001 when I'm testing). Can we configure this to go to the default Recon host and port if someone was to follow the docker quick start guide by default, and possibly make it configurable if they want to point it to a different Recon instance? Also, please update the PR description to indicate how this was tested. ########## docs/05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.mdx: ########## @@ -0,0 +1,11 @@ +# Recon REST API + +import SwaggerUI from '@site/src/components/SwaggerUI'; + +Ozone Recon's public **REST API** follows the [OpenAPI specification](https://www.openapis.org/), and is documented below. The docs are generated using [Swagger React UI](https://github.com/swagger-api/swagger-ui). + +:::info +**NOTE!** You can find an interactive version of this documentation on your local Ozone Recon instance at **/api/v1/** (if Recon is running). Review Comment: nit. The callout already says "info" above it. ```suggestion You can find an interactive version of this documentation on your local Ozone Recon instance at **/api/v1/** (if Recon is running). ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
