Skip to content

Commit

Permalink
Fix readme, Add to gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
Tommel71 committed Nov 25, 2024
1 parent d24c8c3 commit 001caf7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,7 @@ tests/instance/config.yaml

#Plugins
gsrest/plugins

#IDE
.idea

10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,10 @@ REST log messages can be delivered via mail. See `instance/config.yaml.template`

### Generate server stub

Install version 4.44.2 of yq (https://github.com/mikefarah/yq/) and run the following command to generate the server stub:

```sh
BRANCH=master
docker run --rm \
-v "${PWD}:/build" \
-v "${PWD}/templates:/templates" \
openapitools/openapi-generator-cli \
generate -i "https://raw.githubusercontent.com/graphsense/graphsense-openapi/${BRANCH}/graphsense.yaml" \
-g python-aiohttp -o /build -t /templates
generate-openapi-server
```

The service implementation (`gsrest/service`) should use the generated models
Expand Down

0 comments on commit 001caf7

Please sign in to comment.