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

feat(openapi): generate openapi.yml with Ignite CLI for use with Swagger #1651

Merged
merged 5 commits into from
Oct 27, 2023

Conversation

Unique-Divine
Copy link
Member

@Unique-Divine Unique-Divine commented Oct 26, 2023

Purpose

For Review

Just run

bash tools/ignite-openapi.sh

and you should get an output like so:

✅ Success: symlinked config
Checking chain config file:
✔ config file OK
Checking dependency tools:
✔ tools/tools.go exists
✔ tools file OK
✔ Generated OpenAPI spec
⋆ OpenAPI path: /home/realu/warpath/NibiruChain/nibiru/dist/openapi.yml
✅ Success: Completed generation of OpenAPI spec

Note that the output file is more than 27,000 lines long, so we shouldn't commit it.

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

Merging #1651 (1d6b50a) into master (562209b) will increase coverage by 0.08%.
Report is 2 commits behind head on master.
The diff coverage is 85.61%.

@@            Coverage Diff             @@
##           master    #1651      +/-   ##
==========================================
+ Coverage   74.23%   74.31%   +0.08%     
==========================================
  Files         183      191       +8     
  Lines       14977    15079     +102     
==========================================
+ Hits        11118    11206      +88     
- Misses       3229     3243      +14     
  Partials      630      630              
Files Coverage Δ
app/app.go 57.60% <100.00%> (+0.46%) ⬆️
app/keepers.go 99.20% <100.00%> (ø)
wasmbinding/exec_perp.go 90.74% <100.00%> (ø)
wasmbinding/stargate_query.go 100.00% <100.00%> (ø)
wasmbinding/wasm.go 100.00% <100.00%> (ø)
x/epochs/keeper/grpc_query.go 100.00% <100.00%> (ø)
x/perp/v2/keeper/keeper.go 96.66% <100.00%> (+0.11%) ⬆️
x/perp/v2/keeper/settlement.go 77.41% <ø> (+0.69%) ⬆️
x/perp/v2/types/genesis.go 85.36% <100.00%> (ø)
x/devgas/v1/types/export.go 0.00% <0.00%> (ø)
... and 7 more

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a symlink. Git has a special way of representing these.

@Unique-Divine Unique-Divine marked this pull request as ready for review October 26, 2023 02:53
@Unique-Divine Unique-Divine requested a review from a team as a code owner October 26, 2023 02:53
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is auto-generated by ignite CLI

@Unique-Divine Unique-Divine merged commit 9169d8b into master Oct 27, 2023
@Unique-Divine Unique-Divine deleted the ignite-cli branch October 27, 2023 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Completed
Development

Successfully merging this pull request may close these issues.

docs: generate vuejs openapi docs for the chain
2 participants