ArafatKhan2198 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2720198842
########## 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 agree with this. Instead of hard-coding the host/port to whatever the docs site is running on, we could allow the user to configure the Recon host and port directly in the Swagger UI itself (via the server URL selector or a configurable variable). That way, users following the Docker quick start can simply point Swagger to the default Recon endpoint, and advanced users can override it to target a different Recon instance. Once configured, the Try it out button would correctly issue requests to the specified host/port without additional changes to the docs setup. -- 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]
