swagger doc modified, duplicate query name changed/removed

comdex-official · Mar 9, 2023 · ff726bd · ff726bd
1 parent 71da8fe
commit ff726bd
Show file tree

Hide file tree

Showing 59 changed files with 189,863 additions and 2,265 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@
 /cover.out
 /bin/
 __pycache__
-*.pyc
+*.pyc
+**/*/node_modules
diff --git a/Makefile b/Makefile
@@ -182,9 +182,21 @@ protoVer=v0.1
 containerProtoGenSwagger=comdex-proto-gen-swagger-$(protoVer)
 
 proto-swagger-gen:
-	@echo "Generating Protobuf Swagger"
-	@if docker ps -a --format '{{.Names}}' | grep -Eq "^${containerProtoGenSwagger}$$"; then docker start -a $(containerProtoGenSwagger); else docker run --name $(containerProtoGenSwagger) -v $(CURDIR):/workspace --workdir /workspace $(protoImageName) \
-		sh ./scripts/protoc_swagger_gen.sh; fi
+	@echo
+	@echo "=========== Generating Docs ============"
+	@echo
+	./scripts/protoc_swagger_gen.sh
+
+	@if [ -n "$(git status --porcelain)" ]; then \
+        echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
+        exit 1;\
+    else \
+        echo "\033[92mSwagger docs are in sync\033[0m";\
+    fi
+	@echo
+	@echo "=========== Docs Generation Complete ============"
+	@echo
+.PHONY: docs
 
 test-sim-nondeterminism:
 	@echo "Running non-determinism test..."

diff --git a/client/.DS_Store b/client/.DS_Store
diff --git a/client/docs/.DS_Store b/client/docs/.DS_Store
diff --git a/client/docs/config.json b/client/docs/config.json
@@ -0,0 +1,218 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "comdex - gRPC Gateway docs",
+    "description": "A REST interface for state queries, legacy transactions",
+    "version": "1.0.0"
+  },
+  "apis": [
+    {
+      "url": "../../tmp-swagger-gen/comdex/asset/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "AssetParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/auction/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "auctionParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/bandoracle/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "bandoracleParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/collector/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "collectorParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/esm/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "esmParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/lend/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "lendParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/liquidity/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "liquidityParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/locker/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "lockerParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/market/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "marketParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/rewards/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "rewardsParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/tokenmint/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "tokenmintParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/comdex/vault/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "vaultParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/cosmos/auth/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "AuthParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/cosmos/authz/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "AuthzParams"
+        }
+      }
+    },
+    {
+      "url": "../../tmp-swagger-gen/cosmos/bank/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "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/feegrant/v1beta1/query.swagger.json",
+      "operationIds": {
+        "rename": {
+          "Params": "FeegrantParams"
+        }
+      }
+    },
+    {
+      "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": "CosmosMintParams"
+        }
+      }
+    },
+    {
+      "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",
+          "Pool": "StakingPool",
+          "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"
+        }
+      }
+    }
+  ]
+}
diff --git a/client/docs/package.json b/client/docs/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "docs",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "combine": "swagger-combine ./config.json -o static/swagger/swagger.yaml -f yaml --continueOnConflictingPaths --includeDefinitions",
+    "convert": "swagger2openapi static/swagger/swagger.yaml --outfile static/openapi/openapi.yaml --yaml",
+    "build": "redoc-cli bundle static/openapi/openapi.yaml --output ./static/openapi/index.html"
+  },
+  "dependencies": {
+    "redoc-cli": "^0.9.12",
+    "swagger-combine": "^1.4.0",
+    "swagger2openapi": "^7.0.3"
+  }
+}
diff --git a/client/docs/static/.DS_Store b/client/docs/static/.DS_Store
diff --git a/client/docs/static/openapi/index.html b/client/docs/static/openapi/index.html