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

Integrate OpenAPI for Mirror Node Model Generation #276

Closed
ivaylogarnev-limechain opened this issue Nov 12, 2024 · 1 comment
Closed

Integrate OpenAPI for Mirror Node Model Generation #276

ivaylogarnev-limechain opened this issue Nov 12, 2024 · 1 comment
Assignees
Milestone

Comments

@ivaylogarnev-limechain
Copy link
Contributor

Integrating OpenAPI to generate models for Mirror Node data will address property naming inconsistencies between mirror and consensus node data. By generating TypeScript models from the existing Mirror Node Swagger documentation, we can improve property accessibility and streamline the development process.

Using OpenAPI enables automated model generation directly from the .yaml files, giving developers immediate access to all fields in Mirror Node data. This eliminates the need for manual exploration or logging, allowing for more efficient and accurate development with property suggestions and type-checking.

Additionally, this integration will contribute to a more organized and maintainable codebase as new features and endpoints are added. With type-checked models in place, the development workflow will be enhanced, reducing runtime errors and supporting greater scalability as the project grows.

@ivaylogarnev-limechain ivaylogarnev-limechain changed the title Integrate OpenAPI for Mirror Node Model Generation to Enhance Development Workflow Integrate OpenAPI for Mirror Node Model Generation Nov 12, 2024
@rwalworth rwalworth modified the milestones: Sprint 16, Sprint 17 Feb 4, 2025
@rwalworth
Copy link
Contributor

@ivaylogarnev-limechain I think this can be closed, yes? Just FYI, if you create a branch in the issue, when the PR with which that branch is associated is merged, it will automatically close the issue.

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

No branches or pull requests

2 participants