added endpoint documentation

This commit is contained in:
Leon Hoppe
2024-11-22 12:20:33 +01:00
parent 2bc8a5d70b
commit 16ef41800d
4 changed files with 56 additions and 2 deletions

33
docs/api/models.md Normal file
View File

@@ -0,0 +1,33 @@
# HopFrame Models
All models used by the RestAPI are listed below
## SingleValueResult
```csharp
public struct SingleValueResult<TValue>(TValue value) {
public TValue Value { get; set; } = 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 {
public string Password { get; set; }
}
```