errose28 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2760173119
########## 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 info @chiraggoyal19. I think we should remove the interactive elements for now since they are not working. In follow up tasks I suggest we do the following: - We can make a change in Recon that adds a config key to specify hosts to allow CORS for. - We make the default value of that config empty (no change for existing deployments) but in the docker quick start only we set it to `ozone.apache.org` - We add a note to the docs saying that if you want to use this against a different Recon instance you will need to set this config accordingly. This way there are no security changes for existing prod clusters, only the docker quick start which is explicitly for testing only. This would start working automatically when the new site is published, but we can still test it before then by modifying the config in docker as needed. @ArafatKhan2198 @devabhishekpal @devmadhuu does this sound like a reasonable approach? -- 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]
