Skip to content

Commit

Permalink
Merge pull request #12 from c-osmosis/frostornge/swagger
Browse files Browse the repository at this point in the history
feat: add static api docs
  • Loading branch information
byeongsu-hong authored Oct 23, 2020
2 parents ca239d1 + c324844 commit ad41d0d
Show file tree
Hide file tree
Showing 19 changed files with 58,395 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Edit at https://www.toptal.com/developers/gitignore?templates=intellij,vscode,macos,windows

build
**/*/node_modules

### Go ###
# Binaries for programs and plugins
Expand Down
11 changes: 10 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

.PHONY: clean buildpath osmosis proto
.PHONY: clean buildpath osmosis proto docs

all: osmosis proto

Expand All @@ -26,3 +26,12 @@ proto:
@echo
@echo "=========== Generate Complete ============"
@echo

docs:
@echo
@echo "=========== Generate Message ============"
@echo
./scripts/generate-docs.sh
@echo
@echo "=========== Generate Complete ============"
@echo
18 changes: 18 additions & 0 deletions client/docs/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"swagger": "2.0",
"info": {
"title": "Osmosis - gRPC Gateway docs",
"description": "A REST interface for state queries, legacy transactions",
"version": "1.0.0"
},
"apis": [
{
"url": "../../tmp-swagger-gen/osmosis/gamm/v1beta1/query.swagger.json",
"operationIds": {
"rename": {
"Params": "GAMMParams"
}
}
}
]
}
Loading

0 comments on commit ad41d0d

Please sign in to comment.