devabhishekpal commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2786266383
########## 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: Thanks for the inputs @errose28. I am not too sure of the implications of allowing CORS changes specially in secure environments. I guess on local envs it is fine to use via docker, but then the usecase for production clusters doesn't make much sense. Allowing any other domain to access resources in secured production clusters seems like a security incident waiting to happen. One thing could be that someone can run Swagger in their local machine and then perform API calls by adding their machine into the CORS whitelist but that seems too complex for something that can be done instead by copy pasting the generated cURL call. I am open to inputs and any scenario where this would be useful to have -- 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]
