-
Notifications
You must be signed in to change notification settings - Fork 51
HDDS-10684. Add Swagger API for Recon as a Docusaurus page. #264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: HDDS-9225-website-v2
Are you sure you want to change the base?
HDDS-10684. Add Swagger API for Recon as a Docusaurus page. #264
Conversation
…with Docusaurus theme integration.
jojochuang
left a comment
There was a problem hiding this 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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
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. |
errose28
left a comment
There was a problem hiding this 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.
docs/05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.mdx
Outdated
Show resolved
Hide resolved
docs/05-administrator-guide/03-operations/09-observability/02-recon/02-recon-rest-api.mdx
Show resolved
Hide resolved
Co-authored-by: Ethan Rose <33912936+errose28@users.noreply.github.com>
…aml to resolve linting erros
|
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. |

What changes were proposed in this pull request?
Added Swagger API for Recon as a Docusaurus page.
Please describe your PR in detail:
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.