chiraggoyal19 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2756060207
########## 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 have fixed the styling issues but the interactive API page needs some changes from the backend When users click "Execute" in the Swagger UI to test API endpoints, the browser blocks the request with a CORS (Cross-Origin Resource Sharing) error. Why It Happens The documentation site runs on one origin (e.g., http://localhost:3001/ during development, or the production docs URL) The Recon API server runs on a different origin (e.g., http://localhost:9888/)When JavaScript from the docs site tries to make requests to the Recon API, the browser enforces the Same-Origin Policy and blocks the request unless the Recon API server explicitly allows it. The Recon server needs to be configured to send CORS headers in its HTTP responses -- 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]
