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

Indexer just launched new version. #148

Closed
AlterionX opened this issue Mar 24, 2022 · 5 comments
Closed

Indexer just launched new version. #148

AlterionX opened this issue Mar 24, 2022 · 5 comments

Comments

@AlterionX
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Indexer just got updated. SDK should be correspondingly updated.

Describe the solution you'd like
A way to generate the algonaut indexer sdk via the yaml file describing the algorand indexer api.

Additional context
Not aure what the update actually entails. I mostly heard about it through the grapevine.

@AlterionX
Copy link
Contributor Author

AlterionX commented Mar 24, 2022

https://github.com/algorand/indexer/blob/develop/api/indexer.oas3.yml

^ the OpenAPI config file.

I haven't had a chance to see if algonaut does any of that codegen stuff, so feel free to close if it does.

@ivnsch
Copy link
Contributor

ivnsch commented Mar 25, 2022

I was told that the initial indexer API was generated automatically, but I don't know how. To my knowledge, there's nothing in our code base to do this.

Noting that the generated code had some issues, like unnecessary use of Box, non ideal use of Option (e.g. when just a Vec makes more sense), lack of types (conversion to Address), etc. It might be possible to customize it.

@ivnsch
Copy link
Contributor

ivnsch commented Mar 29, 2022

@manuelmauro maybe you want to add something - just saw your OpenApi clients linked in #10. It might be worth going through e.g. https://openapi-generator.tech/docs/customization/ to see if it's possible to customize it to match our current more idiomatic API.

@manuelmauro
Copy link
Owner

Yes, I can confirm that I built the current API looking at Algorand's developer documentation and the generated OAS. But I tried to improve the ergonomics addressing issues like those @ivanschuetz highlighted in the previous comment.

@ivnsch
Copy link
Contributor

ivnsch commented Apr 23, 2022

Will be solved as part of #164 and #165

@ivnsch ivnsch closed this as completed Apr 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants