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

docs: Plan is marked as google.protobuf.Any in Swagger #125

Closed
5 tasks
dongsam opened this issue Sep 17, 2021 · 0 comments
Closed
5 tasks

docs: Plan is marked as google.protobuf.Any in Swagger #125

dongsam opened this issue Sep 17, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dongsam
Copy link
Contributor

dongsam commented Sep 17, 2021

Summary

Plan model on Swagger v1.2.0 is marked as google.protobuf.Any because the Plan is interface type

Proposal

Auth's AccountI interface, which is such a case, is also in the following state.

// QueryAccountsResponse is the response type for the Query/Accounts RPC method.
message QueryAccountsResponse {
  // accounts are the existing accounts
  repeated google.protobuf.Any accounts = 1 [(cosmos_proto.accepts_interface) = "AccountI"];

  // pagination defines the pagination in the response.
  cosmos.base.query.v1beta1.PageResponse pagination = 2;
}

Therefore, we plan to solve the issue by adding comments to the Plan field of QueryPlansResponse so that the description can be exposed.

It can be solved from #39

Bullet Points

  • adding comments to the Plan field of QueryPlansResponse

References


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@dongsam dongsam added the documentation Improvements or additions to documentation label Sep 17, 2021
@dongsam dongsam added this to the Farming F1 v1.0 milestone Sep 17, 2021
@jaybxyz jaybxyz changed the title Plan is marked as google.protobuf.Any in Swagger docs: Plan is marked as google.protobuf.Any in Swagger Oct 5, 2021
@jaybxyz jaybxyz self-assigned this Oct 14, 2021
jaybxyz added a commit to jaybxyz/farming that referenced this issue Oct 15, 2021
…108-improve-sim-tests

* commit 'f5ff949f16b4cc6f8a3061a0512faa3c9defb8eb':
  docs: apply proto-all, fix typo
  fix: refine sentinel errors (tendermint#167)
  chore: apply suggestions from code review
  chore: resolve tendermint#125 and fix proto lint issue
  docs: add swagger related files generate statik file
  feat: go get grpc-gateway v2
  chore: add detailed descriptions and responses for all queries and update Makefile
  feat: add  third party proto files
  chore: apply changes from code review
  docs: add swager spec for params
  chore: add comments for types
  chore: update comments for keeper
  docs: leave proper comments
  docs: update comments
  docs: add comments for flags
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
None yet
Development

No branches or pull requests

3 participants