Skip to content

Commit

Permalink
Merge pull request #305 from SnowJuli/master
Browse files Browse the repository at this point in the history
fix typo
  • Loading branch information
zekroTJA authored Oct 31, 2021
2 parents f57f695 + 2f2401f commit a2ef606
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion web/src/app/routes/guild-admin/data/ga-data.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<div>
<h3>Data Removal</h3>
<p class="mt-4">
Here you can delete <strong>ALL</strong> data stored in shinpurus database
Here you can delete <strong>ALL</strong> data stored in shinpuru's database
and object storage associated to this guild.<br />
This includes the following data sets:
</p>
Expand Down

0 comments on commit a2ef606

Please sign in to comment.