You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: server/README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,15 +15,16 @@ Then you can access the server via this URL: http://127.0.0.1:8000
15
15
16
16
## Accessing API schema
17
17
18
-
To access the HTML view for the API schema, just run the server and follow the `/#docs` endpoint.
18
+
To access the HTML view for the API schema, just run the server and follow the [/#docs](http://127.0.0.1:8000/#docs) endpoint.
19
19
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.
20
+
For getting its JSON version, follow the [/openapi.json](http://127.0.0.1:8000/openapi.json) endpoint.
21
21
22
+
You can retrieve the schema in the YAML format by following the [/openapi.yaml](http://127.0.0.1:8000/openapi.yaml) endpoint ior just reading the [openapi.yaml](./hwapi/openapi.yaml) file in the repo.
22
23
23
24
## Development
24
25
25
26
### Pre-commit hooks
26
27
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
+
The repo contains pre-commit hook rules to update the openapi.yaml file before committing the changes. To use it, first make sure `pre-commit`is installed on your system (is installed with poetry dev dependencies).
28
29
29
-
Then go to the project root directory and run `pre-commit install`.
30
+
Then go to the `server/`directory and run `poetry run pre-commit install`.
0 commit comments