Skip to content

Commit 11dd21b

Browse files
committed
added gitignore and note regarding the openapi.json file
1 parent 8f3f4c9 commit 11dd21b

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

doc/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
*.aux
22
*.log
33
*.synctex.gz
4-
4+
openapi.json

doc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ pip3 install mkdocs
1414
pip3 install $(mkdocs get-deps)
1515
mkdocs server
1616
```
17+
18+
When testing the API reference you need to retrieve the openapi.json file from the Hashtopolis server (e.g. via `http://localhost:8080/api/v2/openapi.json) and place it inside this folder.

0 commit comments

Comments
 (0)