fix: swagger docs & swagger generation #2233 (#2271)

osmosis-labs · Aug 3, 2022 · 1592bb8 · 1592bb8
1 parent d0aaca0
commit 1592bb8
Show file tree

Hide file tree

Showing 9 changed files with 56,579 additions and 33,971 deletions.
diff --git a/Makefile b/Makefile
@@ -166,6 +166,7 @@ docs:
 	@echo
 	@echo "=========== Generate Complete ============"
 	@echo
+.PHONY: docs
 
 protoVer=v0.7
 protoImageName=tendermintdev/sdk-proto-gen:$(protoVer)

diff --git a/client/docs/config.json b/client/docs/config.json
@@ -7,26 +7,26 @@
   },
   "apis": [
     {
-      "url": "../../tmp-swagger-gen/osmosis/gamm/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/epochs/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "GAMMParams"
+          "Params": "EpochsParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/osmosis/epochs/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/gamm/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "EpochsParams"
+          "Params": "GAMMParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/osmosis/pool-incentives/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/incentives/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "PoolIncentivesParams"
+          "Params": "IncentivesParams"
         }
       }
     },
@@ -39,26 +39,44 @@
       }
     },
     {
-      "url": "../../tmp-swagger-gen/osmosis/incentives/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/mint/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "IncentivesParams"
+          "Params": "MintParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/osmosis/pool-incentives/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "LockableDurations": "PoolLockableDurations",
+          "Params": "PoolIncentivesParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/osmosis/claim/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/superfluid/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "ClaimParams"
+          "Params": "SuperfluidParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/osmosis/mint/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/osmosis/tokenfactory/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "MintParams"
+          "Params": "TokenfactoryParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/osmosis/txfees/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "TxFeesParams",
+          "BaseDenom": "TxFeesBaseDenom"
         }
       }
     },
@@ -71,100 +89,106 @@
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/authz/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "BankParams"
+          "Params": "AuthzParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/distribution/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "DistributionParams"
+          "Params": "BankParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/evidence/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/base/tendermint/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "EvidenceParams"
+          "Params": "BaseParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/gov/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/distribution/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "GovParams"
+          "Params": "DistributionParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/params/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/evidence/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "Params"
+          "Params": "EvidenceParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/slashing/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/feegrant/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "SlashingParams"
+          "Params": "FeegrantParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/staking/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/gov/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "StakingParams",
-          "Pool": "StakingPool",
-          "DelegatorValidators": "StakingDelegatorValidators"
+          "Params": "GovParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/cosmos/upgrade/v1beta1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/mint/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "UpgradeParams"
+          "Params": "CosmosMintParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/ibc/core/channel/v1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/params/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "IBCChannelParams"
+          "Params": "Params"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/ibc/core/client/v1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/slashing/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "IBCClientParams"
+          "Params": "SlashingParams"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/ibc/core/connection/v1/query.swagger.json",
+      "url": "../../tmp-swagger-gen/cosmos/staking/v1beta1/query.swagger.json",
       "operationIds": {
         "rename": {
-          "Params": "IBCConnectionParams"
+          "Params": "StakingParams",
+          "Pool": "StakingPool",
+          "DelegatorValidators": "StakingDelegatorValidators"
         }
       }
     },
     {
-      "url": "../../tmp-swagger-gen/ibc/applications/transfer/v1/query.swagger.json",
+      "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": "IBCTransferParams"
+          "Params": "UpgradeParams"
         }
       }
     }

diff --git a/client/docs/package.json b/client/docs/package.json
@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "redoc-cli": "^0.9.12",
-    "swagger-combine": "^1.3.0",
+    "swagger-combine": "^1.4.0",
     "swagger2openapi": "^7.0.3"
   }
 }
diff --git a/client/docs/static/openapi/index.html b/client/docs/static/openapi/index.html