mazyar/tm_back
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Notification Filters and AllMarkSeen Endpoint to API Documentation

Browse Source 
- Introduced new query parameters for filtering notifications by 'seen' status and 'priority' in the API documentation, enhancing the flexibility of notification retrieval.
- Added a new endpoint to mark all notifications as seen for a user, including detailed Swagger documentation for the new functionality.
- Updated existing API documentation to reflect the changes, ensuring clarity for API consumers and improving overall documentation quality.
This commit is contained in:
n.nakhostin
2025-09-22 13:05:10 +03:30
parent ef9ad22841
commit fe70c7170b
4 changed files with 230 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+85
View File
@@ -2499,6 +2499,18 @@ const docTemplate = `{
"name": "recipient",
"in": "query"
},
{
"type": "boolean",
"description": "Seen filter",
"name": "seen",
"in": "query"
},
{
"type": "string",
"description": "Priority filter",
"name": "priority",
"in": "query"
},
{
"type": "integer",
"description": "Limit results",
@@ -2717,6 +2729,18 @@ const docTemplate = `{
"name": "recipient",
"in": "query"
},
{
"type": "boolean",
"description": "Seen filter",
"name": "seen",
"in": "query"
},
{
"type": "string",
"description": "Priority filter",
"name": "priority",
"in": "query"
},
{
"type": "integer",
"description": "Limit results",
@@ -5422,6 +5446,18 @@ const docTemplate = `{
"name": "recipient",
"in": "query"
},
{
"type": "boolean",
"description": "Seen filter",
"name": "seen",
"in": "query"
},
{
"type": "string",
"description": "Priority filter",
"name": "priority",
"in": "query"
},
{
"type": "integer",
"description": "Limit results",
@@ -5493,6 +5529,55 @@ const docTemplate = `{
}
}
},
"/api/v1/notifications/all-seen/{user_id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Mark all notifications as seen for a user",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Notification"
],
"summary": "Mark all notifications as seen for a user",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.APIResponse"
}
}
}
}
},
"/api/v1/notifications/mark-seen/{id}": {
"get": {
"security": [