local-it/vikunja-api
Archived
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add toc to docs

Browse source
This commit is contained in:
kolaente 2020-09-03 17:34:44 +02:00
parent 8da7db3e26
commit 1a4eef1056
Signed by untrusted user who does not match committer: konrad
GPG key ID: F40E70337AB24C9B
22 changed files with 77 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/content/doc/practical-instructions/swagger-docs.md
View file

@ -12,7 +12,7 @@ menu:
The api documentation is generated using [swaggo](https://github.com/swaggo/swag) from comments.
### Documenting structs
## Documenting structs
You should always comment every field which will be exposed as a json in the api.
These comments will show up in the documentation, it'll make it easier for developers using the api.