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

[Bug]: OpenAPI spec does not follow proper OpenAPI specifications #19268

Closed
1 task done
Olshansk opened this issue Jan 27, 2024 · 2 comments
Closed
1 task done

[Bug]: OpenAPI spec does not follow proper OpenAPI specifications #19268

Olshansk opened this issue Jan 27, 2024 · 2 comments
Labels

Comments

@Olshansk
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

What happened?

tl;dr We tried and gave up on using an auto SDK generator that uses the OpenAPI spec as a basis.


This is a request to revisit if the OpenAPI spec autogenerated follows proper specifications.

Related links:

Cosmos SDK Version

0.47

How to reproduce?

Non-trivial amount of effort.

  1. Use the auto-generated OpenAPI spec at ./docs/static/openapi.yml
  2. Follow the instructions at https://buildwithfern.com/ to auto-generate a golang and typescript SDK
  3. An example can be found at pokt-network/poktroll/pull/344
@Olshansk Olshansk added the T:Bug label Jan 27, 2024
@tac0turtle
Copy link
Member

Hey we are using a generator for this: https://github.com/grpc-ecosystem/grpc-gateway/tree/main/protoc-gen-openapiv2. We dont write it manually so i can see there may be bugs, but since we try to avoid touching generated code there may not be anything we can do unless the dependency updates

@Olshansk
Copy link
Author

@tac0turtle Noted.

I opened this this issue in Fern.

If time ever permits me to do it myself, I'll look into it, but it would be closer to the end of the year unless someone in their ecosystem looks into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants