leon.hoppe/HopFrame
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Finished documentation

Browse Source
This commit is contained in:
Leon Hoppe
2024-11-22 14:18:40 +01:00
parent 0c2c02136d
commit fee99c60b6
5 changed files with 98 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/endpoints.md
View File

@@ -14,8 +14,8 @@ Base endpoint: `/api/v1/authentication`\
| Method | Endpoint | Payload | Returns |
|--------|---------------|--------------------------------------------------------------|-----------------------|
| PUT | /login | [UserLogin](./models.md#UserLogin) | access token (string) |
| POST | /register | [UserRegister](./models#UserRegister) | access token (string) |
| PUT | /login | [UserLogin](../models.md#UserLogin) | access token (string) |
| POST | /register | [UserRegister](../models.md#UserRegister) | access token (string) |
| GET | /authenticate | | access token (string) |
| DELETE | /logout | | |
| DELETE | /delete | [UserPasswordValidation](./models.md#UserPasswordValidation) | |

17
docs/api/models.md
View File

@@ -8,23 +8,6 @@ public struct SingleValueResult<TValue>(TValue value) {
}
```
## UserLogin
```csharp
public class UserLogin {
public string Email { get; set; }
public string Password { get; set; }
}
```
## UserRegister
```csharp
public class UserRegister {
public string Username { get; set; }
public string Email { get; set; }
public string Password { get; set; }
}
```
## UserPasswordValidation
```csharp
public sealed class UserPasswordValidation {