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

OpenAPI doesn't show ZetaChain endpoints, only Cosmos SDK ones #1078

Closed
fadeev opened this issue Sep 1, 2023 · 2 comments · Fixed by #1079
Closed

OpenAPI doesn't show ZetaChain endpoints, only Cosmos SDK ones #1078

fadeev opened this issue Sep 1, 2023 · 2 comments · Fixed by #1079
Assignees

Comments

@fadeev
Copy link
Member

fadeev commented Sep 1, 2023

For some reason a | character is being added, which breaks the OpenAPI browser.

  /zeta-chain/crosschain/TSS: |
    get:
        summary: Queries a tSS by index.
        operationId: Query_TSS
        responses:
            "200":
                description: A successful response.
                schema:
                    $ref: '#/definitions/crosschainQueryGetTSSResponse'
            default:
                description: An unexpected error response.
                schema:
                    $ref: '#/definitions/googlerpcStatus'
        tags:
            - Query

And here's a Cosmos SDK endpoint for comparison:

  /cosmos/auth/v1beta1/accounts/{address}:
    get:
      summary: Account returns account details based on address.
      operationId: Account
      responses:
        '200':
          description: A successful response.
          schema:
            type: object
            properties:

This has changed recently, because it used to show all endpoints just fine.

@fadeev fadeev self-assigned this Sep 1, 2023
@fadeev
Copy link
Member Author

fadeev commented Sep 1, 2023

The problem is here:

https://github.com/zeta-chain/node/blob/60edc0e8b43ef44a014721740586b4345aa485c7/scripts/protoc-gen-openapi.sh#L3

We're using the latest version, and apparently one of the version changed how the spec is generated.

@fadeev
Copy link
Member Author

fadeev commented Sep 1, 2023

Source of the issue: grpc-ecosystem/grpc-gateway#3557

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

Successfully merging a pull request may close this issue.

1 participant