errose28 commented on code in PR #264: URL: https://github.com/apache/ozone-site/pull/264#discussion_r2747526384
########## 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/` +::: + +<SwaggerUI spec="/recon-api.yaml" defaultServer="http://localhost:9888"; /> Review Comment: Also, can we match the font and font size of the text within the API definitions to match what is on the website? The text pointed to by the red arrows should be the same type. Currently the text in the API definition is difficult to read. <img width="1043" height="876" alt="Image" src="https://github.com/user-attachments/assets/17c9b510-af0f-4937-beaf-fcc6c52ba96e"; /> ########## 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: The interactive API section is also not working for me, seems it can't find the endpoint, although I can open the main Recon UI at http://localhost:9888/#/Overview ########## 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: This page is 404 in my docker deployment. Is a copy of this interactive page supposed to be rendered here? ########## 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/` +::: + +<SwaggerUI spec="/recon-api.yaml" defaultServer="http://localhost:9888"; /> Review Comment: Can we improve the styling of this element? - We shouldn't use green or black on a green background. - The Recon server URL is listed twice. We only need it in the configuration box. - The `Ozone Recon Rest API` section is redundant since we already have the same title on the page. - The links to the yaml and apache license should probably be put in the markdown directly since they are currently left on their own with a unique font and no context. <img width="1068" height="385" alt="Image" src="https://github.com/user-attachments/assets/d8263aca-f099-4fb7-9a55-18436294f79f"; /> -- 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]
