Skip to content
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

Error in HTTP API docs #1201

Open
BrunoCampana opened this issue Jan 13, 2025 · 1 comment
Open

Error in HTTP API docs #1201

BrunoCampana opened this issue Jan 13, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BrunoCampana
Copy link
Member

Description of the Issue:


Diagnosis:

  • The documentation on the Hathor docs website is auto-generated from the openapi.json file in the Hathor core.
  • The openapi.json file documents the Hathor core's HTTP API in the OpenAPI standard.
  • This openapi.json file is generated automatically via hathor-core CLI.
  • For every new Hathor core release, the new version is used to regenerate the openapi.json file via CLI.
  • It appears there are issues in this auto-generation process.
  • There may be additional errors beyond this specific case.
  • This documentation needs to be reviewed by me thoroughly to identify and address any inaccuracies.
  • The review has not yet been prioritized due to other pressing tasks.
@BrunoCampana BrunoCampana added the documentation Improvements or additions to documentation label Jan 13, 2025
@BrunoCampana BrunoCampana changed the title **Error Found in Hathor Core HTTP API Documentation** Error Found in Hathor Core HTTP API Documentation Jan 13, 2025
@BrunoCampana BrunoCampana changed the title Error Found in Hathor Core HTTP API Documentation Error in HTTP API docs Jan 13, 2025
@jansegre jansegre moved this from Todo to In Progress (WIP) in Hathor Network Jan 13, 2025
@jansegre
Copy link
Member

I double checked and locally I can generate the openapi.json and then the docs with redoc-cli build openapi.json and both push_tx and submit_block show the correct endpoint, so I'm not really sure how the public docs got generated with an error. I'll talk with you to see if you can generate them locally and see if there's any issues, it might have been a bug on redoc's side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress (WIP)
Development

No branches or pull requests

2 participants