Skip to content

Conversation

@chiraggoyal19
Copy link

What changes were proposed in this pull request?

Added Swagger API for Recon as a Docusaurus page.

Please describe your PR in detail:

  • Added Swagger API recon as a Docusaurus page.

What is the link to the Apache Jira?

HDDS-10684

How was this patch tested?

Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.

  • The CI checks on my fork are passing
  • I verified the rendered content using a local preview
  • I manually verified the steps provided in this change work as described

Copy link
Contributor

@jojochuang jojochuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[ERROR] Client bundle compiled with errors therefore further build is impossible.
Module not found: Error: Can't resolve 'swagger-ui-react' in '/Users/weichiu/sandbox/ozone-site/src/components/SwaggerUI'


Module not found: Error: Can't resolve 'swagger-ui-react/swagger-ui.css' in '/Users/weichiu/sandbox/ozone-site/src/components/SwaggerUI'
 ELIFECYCLE  Command failed with exit code 1.

@jojochuang jojochuang marked this pull request as ready for review January 21, 2026 17:36
@chiraggoyal19 chiraggoyal19 changed the title HDDS-10684:Add Swagger API for Recon as a Docusaurus page. HDDS-10684.Add Swagger API for Recon as a Docusaurus page. Jan 21, 2026
Copy link
Contributor

@jojochuang jojochuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

Looking good! Just need to address the markdownlint warnings.

@chiraggoyal19 chiraggoyal19 changed the title HDDS-10684.Add Swagger API for Recon as a Docusaurus page. HDDS-10684. Add Swagger API for Recon as a Docusaurus page. Jan 22, 2026
@errose28
Copy link
Contributor

If recon-api.yaml is auto generated, maintained outside this repo, and/or not meant to be read directly by devs feel free to add a rule to skip it from yaml linting.

Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this @chiraggoyal19

Just a note if anyone else hits issues like this step 3 in the quick start should resolve it.

@errose28
Copy link
Contributor

Looks like there's a link pointing to the recon API page that will need to be updated. These links are actually formatted incorrectly, they should not use number prefixes or file extensions so we have flexibility to change this in the future. For example, the page with the broken link should have had its links set up like this:

diff --git a/docs/03-core-concepts/01-architecture/06-recon.md b/docs/03-core-concepts/01-architecture/06-recon.md
index dedb7b6dc..7a98760cb 100644
--- a/docs/03-core-concepts/01-architecture/06-recon.md
+++ b/docs/03-core-concepts/01-architecture/06-recon.md
@@ -52,12 +52,12 @@ Recon can integrate with any Prometheus instance configured to collected metrics
 
 ## API Reference
 
-[Link to complete API Reference](../../05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.md)
+[Link to complete API Reference](../../administrator-guide/operations/observability/recon/recon-rest-api)
 
 ## Persisted state
 
-- A local copy of [OM database](./02-ozone-manager.md#persisted-state)
-- A local copy of [SCM database](./03-storage-container-manager.md#persisted-state)
+- A local copy of [OM database](./ozone-manager#persisted-state)
+- A local copy of [SCM database](./storage-container-manager#persisted-state)
 
 The following data is persisted in Recon in the specified RocksDB directory:

I filed HDDS-14512 to handle this in the future, but for now we should just update the links pointing to this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants