Govor-team/Govor
2
2
Fork 0
mirror of https://github.com/Govor-team/Govor.git synced 2026-07-21 19:54:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

re

Browse Source
This commit is contained in:
Artemy
2025-07-24 20:36:45 +07:00
parent 1fe6e015fc
commit 7ac5565aea
2 changed files with 0 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files
endpoints/friendshipcontroller.md
-114
View File
@@ -1,114 +0,0 @@
---
description: >-
Controller for managing friendship-related operations, including searching for
users and retrieving the list of friends for the current user.
---
# FriendshipController
### Controller Description
* **Route**: `api/friends`
* **Authorize**: Requires authenticated user (`[Authorize]`).
### Endpoints
#### <mark style="color:$info;">Search</mark>
* **Description**: Searches for users based on a query string.
* **Route**: `[GET] api/friends/search?query=`
* **HTTP Method**: `GET`
* **Request**:
* **Query Parameter**: `query` (string, required)
* **Responses**:
* <mark style="color:$success;">**200 OK**</mark>: Returns a list of matching users.
```json
[
{
"id": "Guid",
"username": "string",
"description": "string",
"wasOnline": "DateTime",
"iconId": "Guid"
}
]
```
* <mark style="color:$danger;">**400 Bad Request**</mark>: If the query is empty.
```json
"Query cannot be empty"
```
* <mark style="color:$danger;">**403 Forbidden**</mark>: If user lacks authorization.
```json
"string"
```
* <mark style="color:$warning;">**500 Internal Server Error**</mark>: Indicates an unexpected error.
```json
{
"error": "Internal error during user search."
}
```
#### <mark style="color:$info;">GetFriends</mark>
* **Description**: Retrieves the list of friends for the authenticated user.
* **Route**: `[GET] api/friends`
* **HTTP Method**: `GET`
* **Request**: None
* **Responses**:
* <mark style="color:$success;">**200 OK**</mark>: Returns a list of the user's friends or an empty list if none.
```json
[
{
"id": "Guid",
"username": "string",
"description": "string",
"wasOnline": "DateTime",
"iconId": "Guid"
}
]
```
* <mark style="color:$danger;">**403 Forbidden**</mark>: If user lacks authorization.
```json
"string"
```
* <mark style="color:$warning;">**500 Internal Server Error**</mark>: Indicates an unexpected error.
```json
{
"error": "Internal server error."
}
```
### Data Models
#### UserDto
* **Description**: Data transfer object for user information.
* **Structure**:
```json
{
"id": "Guid",
"username": "string",
"description": "string",
"wasOnline": "DateTime",
"iconId": "Guid"
}
```
### Error Handling
* **Invalid User ID**: Handled by `ICurrentUserService`, aborts if invalid.
* **Invalid Operations**: Returns `400 Bad Request` for empty query.
* **Unexpected Errors**: Caught and returned as `500 Internal Server Error`.
### Logging
* Logs warnings for `SearchUsersException`.
* Logs errors for unexpected exceptions and `InvalidOperationException`.
endpoints/friendsrequestquerycontroller.md
-109
View File
@@ -1,109 +0,0 @@
---
description: >-
Controller for querying friend request-related data, including incoming friend
requests and responses to sent friend requests.
---
# FriendsRequestQueryController
### Controller Description
* **Route**: `api/friends`
* **Authorize**: Requires authenticated user (`[Authorize]`).
### Endpoints
#### <mark style="color:$info;">GetIncomingRequests</mark>
* **Description**: Retrieves a list of incoming friend requests for the authenticated user.
* **Route**: `[GET] api/friends/requests`
* **HTTP Method**: `GET`
* **Request**: None
* **Responses**:
* <mark style="color:$success;">**200 OK**</mark>: Returns a list of incoming friend requests or an empty list if none.
```json
[
{
"id": "Guid",
"senderId": "Guid",
"receiverId": "Guid",
"status": "string",
"createdAt": "DateTime"
}
]
```
* <mark style="color:$danger;">**403 Forbidden**</mark>: If user lacks authorization.
```json
"string"
```
* <mark style="color:$warning;">**500 Internal Server Error**</mark>: Indicates an unexpected error.
```json
{
"error": "Internal server error."
}
```
#### <mark style="color:$info;">GetResponses</mark>
* **Description**: Retrieves a list of responses to the authenticated user's sent friend requests.
* **Route**: `[GET] api/friends/responses`
* **HTTP Method**: `GET`
* **Request**: None
* **Responses**:
* <mark style="color:$success;">**200 OK**</mark>: Returns a list of friend request responses or an empty list if none.
```json
[
{
"id": "Guid",
"senderId": "Guid",
"receiverId": "Guid",
"status": "string",
"createdAt": "DateTime"
}
]
```
* <mark style="color:$danger;">**403 Forbidden**</mark>: If user lacks authorization.
```json
"string"
```
* <mark style="color:$warning;">**500 Internal Server Error**</mark>: Indicates an unexpected error.
```json
{
"error": "Internal server error."
}
```
### Data Models
#### FriendshipDto
* **Description**: Data transfer object for friend request information.
* **Structure**:
```json
{
"id": "Guid",
"senderId": "Guid",
"receiverId": "Guid",
"status": "string",
"createdAt": "DateTime"
}
```
### Error Handling
* **Invalid User ID**: Handled by `ICurrentUserService`, aborts if invalid.
* **Invalid Operations**: Returns `200 OK` with an empty list for `InvalidOperationException`.
* **Unexpected Errors**: Caught and returned as `500 Internal Server Error`.
### Logging
* Logs warnings for `InvalidOperationException`.
* Logs information for successful response retrieval.
* Logs errors for unexpected exceptions.