errose28 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2789698653
########## docs/05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.mdx: ########## @@ -0,0 +1,17 @@ +# 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 +**Interactive API Testing** + +You can test these APIs directly from this page using the "Try it out" button on each endpoint. + +- **Default server**: `http://localhost:9888` (matches the [Docker quick start guide](/docs/quick-start/installation/docker)) +- **Custom server**: Update the "Recon Server URL" field below to point to your own Recon instance +- **Local instance**: If you're running Recon locally, you can also access the interactive Swagger UI at `http://localhost:9888/api/v1/` Review Comment: I agree there's not much good to come out of a CORS whitelist in a prod cluster, but if it is disabled by default and we specify in the docs not to enable it in prod then there I think it is in the ballpark of all our other security configs where we have different recommendations for quick start vs prod. You second suggestion is interesting though. Perhaps we could either: - Run the swagger API off the Recon server itself so it is always available? (I'm not sure if this would still be a CORS violation) - Run a different server/container to host the interactive version of this page in the docker quick start, while keeping this docs page read-only. I also think that copying the generated curl call from the docs and running it against Recon is a good enough solution as well. -- 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]
