Skip to content

Commit 61a2979

Browse files
committed
Update readme
1 parent 2a0a79b commit 61a2979

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

.github/workflows/test_server.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ jobs:
2626

2727
compare-openapi:
2828
runs-on: [self-hosted, linux, large]
29-
if: github.event_name == 'pull_request'
30-
needs: [test]
3129
defaults:
3230
run:
3331
working-directory: server

server/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Installation
55

6-
This package just requires `poetry` to be installed on your system, so all the dependencies are managed by it. Go to the `server/` directory in the project and run the following commands:
6+
This package just requires `poetry` to be installed on your system, so all the dependencies are managed by it. Go to the `server/` directory in the project and run the following commands:
77

88
```bash
99
$ poetry install
@@ -17,4 +17,13 @@ Then you can access the server via this URL: http://127.0.0.1:8000
1717

1818
To access the HTML view for the API schema, just run the server and follow the `/#docs` endpoint.
1919

20-
For getting its JSON version, follow the `/openapi.json` endpoint.
20+
For getting its JSON version, follow the `/openapi.json` endpoint. You can also retrieve the schema in the YAML format by following the `/openapi.yaml` endpoint ior just reading the `openapi.yaml` file in the repo.
21+
22+
23+
## Development
24+
25+
### Pre-commit hooks
26+
27+
The repo contains pre-commit hook rules to update the openapi.yaml file before committing the changes. To use it, first install `pre-commit` on your system by running `pip install pre-commit`.
28+
29+
Then go to the project root directory and run `pre-commit install`.

0 commit comments

Comments
 (0)