From ab34f6b13dbf6c6935eb825930baa4dcf814e698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Kuhlmann?= Date: Sun, 26 Dec 2021 15:02:51 +0100 Subject: [PATCH] Update README.md Change formatting --- README.md | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index edb2716..f2b6a73 100644 --- a/README.md +++ b/README.md @@ -40,39 +40,43 @@ docker run\ 🚨 **IMPORTANT: Any confidential data should never transmitted over unencrypted `http` but instead be transmitted over `https`** -[GET `/`](https://ossc.api.kuhlti.me/): This is the production endpoint. Requests made to this url will result in the server performing the request on the ossc website. This route requires valid login credentials. In order to send these you need to specify the `Authorization` header inside your HTTP request. The value of which has to be formatted as follows (pseudo-code): +- [GET `/`](https://ossc.api.kuhlti.me/):
+ This is the production endpoint. Requests made to this url will result in the server performing the request on the ossc website. This route requires valid login credentials. In order to send these you need to specify the `Authorization` header inside your HTTP request. The value of which has to be formatted as follows (pseudo-code): -```sh -Authorization: Basic $base64Encode($username + ':' + $password) -``` + ```sh + Authorization: Basic $base64Encode($username + ':' + $password) + ``` -```sh -curl "https://ossc.api.kuhlti.me" -u ":" -``` + ```sh + curl "https://ossc.api.kuhlti.me" -u ":" + ``` -Using [`jq`](https://stedolan.github.io/jq/) you can use it to create complex cli pipelines. + Using [`jq`](https://stedolan.github.io/jq/) you can use it to create complex cli pipelines. -```sh -curl "https://ossc.api.kuhlti.me" -u ":" | jq -``` + ```sh + curl "https://ossc.api.kuhlti.me" -u ":" | jq + ``` -[GET `/avg`](https://ossc.api.kuhlti.me/avg): This endpoint returns just the average grade as a value. It can easly be used for further processing. +- [GET `/avg`](https://ossc.api.kuhlti.me/avg):
+ This endpoint returns just the average grade as a value. It can easly be used for further processing. -```sh -curl "https://ossc.api.kuhlti.me/avg" -u ":" -``` + ```sh + curl "https://ossc.api.kuhlti.me/avg" -u ":" + ``` -[GET `/test`](https://ossc.api.kuhlti.me/test): In order to reduce the stress on the ossc server, while developing, you can use this endpoint to get a boilerplate of the data you can expect from the production endpoint. +- [GET `/test`](https://ossc.api.kuhlti.me/test):
+ In order to reduce the stress on the ossc server, while developing, you can use this endpoint to get a boilerplate of the data you can expect from the production endpoint. -```sh -curl "https://ossc.api.kuhlti.me/test" -``` + ```sh + curl "https://ossc.api.kuhlti.me/test" + ``` -[GET `/data`](https://ossc.api.kuhlti.me/data): This Endpoint returns all data I store inside my database. I only store none user related information such as the date of each exam and the final result, which only contains the overview of how many students recieved a particular garde. +- [GET `/data`](https://ossc.api.kuhlti.me/data):
+ This Endpoint returns all data I store inside my database. I only store none user related information such as the date of each exam and the final result, which only contains the overview of how many students recieved a particular garde. -```sh -curl "https://ossc.api.kuhlti.me/data" -``` + ```sh + curl "https://ossc.api.kuhlti.me/data" + ``` ## 👨‍⚖️ Disclaimer