Skip to content

Commit c3e43f3

Browse files
committed
Update links in README
1 parent 61a2979 commit c3e43f3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

server/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ Then you can access the server via this URL: http://127.0.0.1:8000
1515

1616
## Accessing API schema
1717

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.
1919

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.
2121

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.
2223

2324
## Development
2425

2526
### Pre-commit hooks
2627

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).
2829

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

Comments
 (0)