TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-05 22:55:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add short text about editing openapi files to dev docs

Browse Source
This commit is contained in:
eikek 2021-06-12 21:36:18 +02:00
parent b1740fb305
commit 1ca800a38e
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/site/content/docs/dev/development.md
View File

@ -102,6 +102,26 @@ $ export DOCSPELL_ENV=dev
$ sbt "restserver/reStart"
```
# Developing Backend
## OpenAPI
The http API is specified in the corresponding `-openapi.yml` file.
The `component` section is being used to generate code for the client
and the server, so that both are always in sync. However, the route
definitions are not checked against the server implementation.
Changes to the openapi files can be checked by running a sbt task:
``` scala
restapi/openapiLint //and/or
joexapi/openapiLint
```
These tasks must not show any errors (it is checked by the CI). The
warnings should also be fixed.
# Nix Expressions
The directory `/nix` contains nix expressions to install docspell via