feat: add endpoints for retrieving stock alerts and anomaly items, including database queries and models

This commit is contained in:
Tran Anh Tuan
2026-05-13 18:10:34 +07:00
parent 383bed757d
commit 0a56dfeb61
11 changed files with 695 additions and 0 deletions

View File

@@ -2189,6 +2189,108 @@ const docTemplate = `{
}
}
},
"/v1/dashboard/anomalies": {
"get": {
"description": "Retrieve list of component items with abnormal status (damaged, expired, long_unused, pending_inspection)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"dashboard"
],
"summary": "Get anomaly items",
"parameters": [
{
"type": "integer",
"description": "Filter by warehouse ID",
"name": "warehouse_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.SuccessResponse"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/models.AnomalyItem"
}
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/response.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.ErrorResponse"
}
}
}
}
},
"/v1/dashboard/stock-alerts": {
"get": {
"description": "Retrieve list of components that are low on stock (total_quantity \u003c= min_quantity)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"dashboard"
],
"summary": "Get stock alerts",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.SuccessResponse"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/models.StockAlert"
}
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.ErrorResponse"
}
}
}
}
},
"/v1/dashboard/summary": {
"get": {
"description": "Retrieve dashboard summary with key statistics",
@@ -2202,6 +2304,14 @@ const docTemplate = `{
"dashboard"
],
"summary": "Get dashboard summary",
"parameters": [
{
"type": "integer",
"description": "Filter by warehouse ID",
"name": "warehouse_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
@@ -3904,6 +4014,38 @@ const docTemplate = `{
}
}
},
"models.AnomalyItem": {
"type": "object",
"properties": {
"componentId": {
"type": "integer"
},
"componentName": {
"type": "string"
},
"componentUnit": {
"type": "string"
},
"containerId": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"id": {
"type": "integer"
},
"quantity": {
"type": "integer"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
},
"models.Cabinet": {
"type": "object",
"properties": {
@@ -4322,6 +4464,32 @@ const docTemplate = `{
}
}
},
"models.StockAlert": {
"type": "object",
"properties": {
"componentTypeId": {
"type": "integer"
},
"componentTypeName": {
"type": "string"
},
"id": {
"type": "integer"
},
"minQuantity": {
"type": "integer"
},
"name": {
"type": "string"
},
"totalQuantity": {
"type": "integer"
},
"unit": {
"type": "string"
}
}
},
"models.TodayInvoiceCount": {
"type": "object",
"properties": {