forked from crypto-org-chain/cronos
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Problem: swagger doc is not embed in api service (crypto-org-chain#110)
* Problem: swagger doc is not embed in api service Closes: crypto-org-chain#108 Soluton: - register swagger service in app - add swagger gen scripts only lint our own proto files, add proto-swagger-gen to CI fix protobuf lint fix protogen gomod2nix install statik in script pin statik version try to fix CI error rebase changelog * update proto-gen * fix nix build * don't check swagger gen in CI * Update CHANGELOG.md * don't check proto doc in CI
- Loading branch information
Showing
37 changed files
with
102,379 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ jobs: | |
| - uses: actions/[email protected] | ||
| - name: proto-gen | ||
| run: | | ||
| make proto-gen | ||
| git checkout -- go.mod go.sum | ||
| make proto-gen # proto-swagger-gen FIXME swagger-gen result is not reproducible in CI | ||
| git checkout -- go.mod go.sum docs/api/proto-docs.md # FIXME doc gen not reproducible in CI | ||
| - name: check working directory is clean | ||
| uses: numtide/clean-git-action@v1 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| version: v1 | ||
| directories: | ||
| - proto | ||
| - third_party/proto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Cosmos SDK - Legacy REST and gRPC Gateway docs", | ||
| "description": "A REST interface for state queries, legacy transactions", | ||
| "version": "1.0.0" | ||
| }, | ||
| "apis": [ | ||
| { | ||
| "url": "./client/docs/swagger_legacy.yaml", | ||
| "dereference": { | ||
| "circular": "ignore" | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cronos/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "EvmParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/ethermint/evm/v1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "EvmParams1" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/ethermint/feemarket/v1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "EvmParams2" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/auth/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Account": "AuthAccount", | ||
| "Params": "AuthParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Balance": "BankBalance", | ||
| "Params": "BankParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/base/tendermint/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "BaseParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/distribution/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "DistributionParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/evidence/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "EvidenceParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/gov/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "GovParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/mint/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "MintParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/params/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "Params" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/slashing/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "SlashingParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/staking/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "StakingParams", | ||
| "DelegatorValidators": "StakingDelegatorValidators" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/tx/v1beta1/service.swagger.json", | ||
| "dereference": { | ||
| "circular": "ignore" | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/upgrade/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "UpgradeParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/authz/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "AuthzParams" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "url": "./tmp-swagger-gen/cosmos/feegrant/v1beta1/query.swagger.json", | ||
| "operationIds": { | ||
| "rename": { | ||
| "Params": "FeegrantParams" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| package statik | ||
|
|
||
| // This just for fixing the error in importing empty github.com/cosmos/cosmos-sdk/client/docs/statik |
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <!-- HTML for static distribution bundle build --> | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Swagger UI</title> | ||
| <link rel="stylesheet" type="text/css" href="swagger-ui.css" > | ||
| <link rel="icon" type="image/png" href="favicon-32x32.png" sizes="32x32" /> | ||
| <link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" /> | ||
| <style> | ||
| html | ||
| { | ||
| box-sizing: border-box; | ||
| overflow: -moz-scrollbars-vertical; | ||
| overflow-y: scroll; | ||
| } | ||
|
|
||
| *, | ||
| *:before, | ||
| *:after | ||
| { | ||
| box-sizing: inherit; | ||
| } | ||
|
|
||
| body | ||
| { | ||
| margin:0; | ||
| background: #fafafa; | ||
| } | ||
| </style> | ||
| </head> | ||
|
|
||
| <body> | ||
| <div id="swagger-ui"></div> | ||
|
|
||
| <script src="swagger-ui-bundle.js"> </script> | ||
| <script src="swagger-ui-standalone-preset.js"> </script> | ||
| <script> | ||
| window.onload = function() { | ||
|
|
||
| // Build a system | ||
| const ui = SwaggerUIBundle({ | ||
| url: "./swagger.yaml", | ||
| dom_id: '#swagger-ui', | ||
| deepLinking: true, | ||
| presets: [ | ||
| SwaggerUIBundle.presets.apis, | ||
| SwaggerUIStandalonePreset | ||
| ], | ||
| plugins: [ | ||
| SwaggerUIBundle.plugins.DownloadUrl | ||
| ], | ||
| layout: "StandaloneLayout" | ||
| }) | ||
|
|
||
| window.ui = ui | ||
| } | ||
| </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| <!doctype html> | ||
| <html lang="en-US"> | ||
| <body onload="run()"> | ||
| </body> | ||
| </html> | ||
| <script> | ||
| 'use strict'; | ||
| function run () { | ||
| var oauth2 = window.opener.swaggerUIRedirectOauth2; | ||
| var sentState = oauth2.state; | ||
| var redirectUrl = oauth2.redirectUrl; | ||
| var isValid, qp, arr; | ||
|
|
||
| if (/code|token|error/.test(window.location.hash)) { | ||
| qp = window.location.hash.substring(1); | ||
| } else { | ||
| qp = location.search.substring(1); | ||
| } | ||
|
|
||
| arr = qp.split("&") | ||
| arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';}) | ||
| qp = qp ? JSON.parse('{' + arr.join() + '}', | ||
| function (key, value) { | ||
| return key === "" ? value : decodeURIComponent(value) | ||
| } | ||
| ) : {} | ||
|
|
||
| isValid = qp.state === sentState | ||
|
|
||
| if (( | ||
| oauth2.auth.schema.get("flow") === "accessCode"|| | ||
| oauth2.auth.schema.get("flow") === "authorizationCode" | ||
| ) && !oauth2.auth.code) { | ||
| if (!isValid) { | ||
| oauth2.errCb({ | ||
| authId: oauth2.auth.name, | ||
| source: "auth", | ||
| level: "warning", | ||
| message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server" | ||
| }); | ||
| } | ||
|
|
||
| if (qp.code) { | ||
| delete oauth2.state; | ||
| oauth2.auth.code = qp.code; | ||
| oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl}); | ||
| } else { | ||
| let oauthErrorMsg | ||
| if (qp.error) { | ||
| oauthErrorMsg = "["+qp.error+"]: " + | ||
| (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") + | ||
| (qp.error_uri ? "More info: "+qp.error_uri : ""); | ||
| } | ||
|
|
||
| oauth2.errCb({ | ||
| authId: oauth2.auth.name, | ||
| source: "auth", | ||
| level: "error", | ||
| message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server" | ||
| }); | ||
| } | ||
| } else { | ||
| oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl}); | ||
| } | ||
| window.close(); | ||
| } | ||
| </script> |
Oops, something went wrong.