docs: add swagger ui in docs (#15241)

This commit is contained in:
Julien Robert 2023-03-02 13:40:26 +01:00 committed by GitHub
parent de16912e39
commit 0141817fca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 8 additions and 6 deletions

View File

@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "Cosmos SDK - gRPC Gateway docs",
"description": "A REST interface for state queries",
"description": "A REST interface for state queries.",
"version": "1.0.0"
},
"apis": [

View File

@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Cosmos SDK - gRPC Gateway docs
description: A REST interface for state queries
description: A REST interface for state queries.
version: 1.0.0
paths:
/cosmos/auth/v1beta1/account_info/{address}:

View File

@ -17,6 +17,8 @@ echo "building docusaurus main docs"
mv ~/versioned_docs ~/versioned_sidebars .
npm ci && npm run build
mv build ~/output
echo "adding swagger docs"
cp -r ../client/docs/swagger-ui ~/output/swagger
while read -r branch path_prefix; do
echo "building vuepress $branch docs"
(git clean -fdx && git reset --hard && git checkout $branch && npm install && VUEPRESS_BASE="/$path_prefix/" npm run build)

View File

@ -8,4 +8,4 @@ rm -rf docs/tooling/04-hubl.md
rm -rf docs/run-node/04-rosetta.md
rm -rf docs/architecture
rm -rf docs/spec
rm -rf versioned_docs versioned_sidebars versions.json
rm -rf versioned_docs versioned_sidebars versions.json

View File

@ -30,4 +30,4 @@ cp ../tools/rosetta/README.md ./docs/run-node/04-rosetta.md
cp -r ./architecture ./docs
## Add spec documentation
cp -r ./spec ./docs
cp -r ./spec ./docs

View File

@ -35,7 +35,7 @@ const sidebars = {
{
type: "link",
label: "REST API Spec",
href: "https://v1.cosmos.network/rpc/v0.45.1",
href: "https://docs.cosmos.network/swagger/",
},
{
type: "link",

View File

@ -24,7 +24,7 @@ Here are some production-grade modules that can be used in Cosmos SDK applicatio
* [NFT](./nft/README.md) - NFT module implemented based on [ADR43](https://docs.cosmos.network/main/architecture/adr-043-nft-module.html).
* [Consensus](./consensus/README.md) - Consensus module for modifying Tendermint's ABCI consensus params.
* [Circuit](./circuit/README.md) - Circuit breaker module for pausing messages.
* [Genutil](./genutil/README.md) - Genesis utilities for the Cosmos SDK.
To learn more about the process of building modules, visit the [building modules reference documentation](https://docs.cosmos.network/main/building-modules/intro).