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

rpc: remove logic for generating openapi spec #20724

Merged
merged 2 commits into from
Dec 23, 2024
Merged

Conversation

bmwill
Copy link
Contributor

@bmwill bmwill commented Dec 23, 2024

Description

Since we'll be leveraging gRPC + protobuf instead of a handrolled REST
api we no longer need to maintain the infra for generating an openapi
scpec. In the future we can explore generating an openapi spec from the
proto files themselves as is used in grpc-gateway.

Test plan

How did you test the new or updated feature?


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • gRPC:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:

Since we'll be leveraging gRPC + protobuf instead of a handrolled REST
api we no longer need to maintain the infra for generating an openapi
scpec. In the future we can explore generating an openapi spec from the
proto files themselves as is used in grpc-gateway.
@bmwill bmwill requested a review from phoenix-o December 23, 2024 20:33
Copy link

vercel bot commented Dec 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 8:38pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 8:38pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 8:38pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 8:38pm

@bmwill bmwill enabled auto-merge (rebase) December 23, 2024 21:11
@bmwill bmwill merged commit 3d86fb0 into MystenLabs:main Dec 23, 2024
50 checks passed
@bmwill bmwill deleted the rpc branch December 23, 2024 21:37
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 this pull request may close these issues.

2 participants