From 2f2401f820ed433111d3beb8867f1b6dcc7420f2 Mon Sep 17 00:00:00 2001 From: Leo <49914615+SnowJuli@users.noreply.github.com> Date: Sun, 31 Oct 2021 23:30:24 +0100 Subject: [PATCH] fix typo --- CONTRIBUTING.md | 2 +- docs/restapi/README.md | 2 +- web/src/app/routes/guild-admin/data/ga-data.component.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb88bdc0..b4be0211 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ The web interface communicates with the shinpuru backend over a RESTful HTTP API If you want to add API endpoints, just add the endpoints to one of the controllers *(don't forget to register the endpoint in the controller's `Setup` method!)*, or create a new entire controller, which then needs to be registered in the API `Route`. If you need service dependencies in your controller, just add it to the controllers struct and get it from the passed `di.Container` *(more explained below)* in the `Setup` method. -Also, fiber works a lot with middlewares, which can be chained anywhere into the fiber route chain. In shinpurus implementation, there are three main types of middlewares. +Also, fiber works a lot with middlewares, which can be chained anywhere into the fiber route chain. In shinpuru's implementation, there are three main types of middlewares. 1. The high level middlewares like the rate limiter, CORS or file system middleware, which are set before all incomming requests. 2. Controller specific middlewares which are defined in the router. Mainly, this is used for the authorizeation middleware, which checks for auth tokens in the requests. This middleware is required by some controllers and not required for others. 3. Endpoint specific middlewares which are defined for specific endpoints only. Mainly, this is used for the permission middleware which checks for required user permissions to execute specific endpoints. diff --git a/docs/restapi/README.md b/docs/restapi/README.md index 921371b0..ae9e93b1 100644 --- a/docs/restapi/README.md +++ b/docs/restapi/README.md @@ -4,7 +4,7 @@ When enabled by config, shinpuru exposes a RESTful HTTP API which exposes all fu ## Authentication -All requests to the API needs to be authenticated and authorized. To authenticate your requests, you need to generate an API token in shinpurus web interface. +All requests to the API needs to be authenticated and authorized. To authenticate your requests, you need to generate an API token in shinpuru's web interface. ![](https://i.imgur.com/KYp2OdR.png) ![](https://i.imgur.com/RBrQwrH.png) diff --git a/web/src/app/routes/guild-admin/data/ga-data.component.html b/web/src/app/routes/guild-admin/data/ga-data.component.html index a0e59df5..a299b73a 100644 --- a/web/src/app/routes/guild-admin/data/ga-data.component.html +++ b/web/src/app/routes/guild-admin/data/ga-data.component.html @@ -3,7 +3,7 @@

Data Removal

- Here you can delete ALL data stored in shinpurus database + Here you can delete ALL data stored in shinpuru's database and object storage associated to this guild.
This includes the following data sets: