ruochen/ez-api
1
0
Fork 0
mirror of https://github.com/EZ-Api/ez-api.git synced 2026-01-13 17:47:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): add alerts report endpoint and apikey-stats query params

Browse Source 
- Add internal /internal/alerts/report POST endpoint documentation
- Add reportAlertEntry, reportAlertsRequest, reportAlertsResponse schemas
- Add since/until query parameters to /admin/apikey-stats/summary endpoint
This commit is contained in:
zenfun
2025-12-31 14:18:42 +08:00
parent bfba16bbd4
commit 57797f38cb
3 changed files with 340 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
docs/docs.go
View File

@@ -737,6 +737,20 @@ const docTemplate = `{
"admin"
],
"summary": "APIKey stats summary (admin)",
"parameters": [
{
"type": "integer",
"description": "Start time (unix seconds)",
"name": "since",
"in": "query"
},
{
"type": "integer",
"description": "End time (unix seconds)",
"name": "until",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
@@ -3385,6 +3399,52 @@ const docTemplate = `{
}
}
},
"/internal/alerts/report": {
"post": {
"description": "Internal endpoint for Data Plane to report alerts to Control Plane",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"internal"
],
"summary": "Report alerts from DP",
"parameters": [
{
"description": "Alerts to report",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/internal_api.reportAlertsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/internal_api.reportAlertsResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/gin.H"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/gin.H"
}
}
}
}
},
"/internal/apikey-stats/flush": {
"post": {
"description": "Internal endpoint for flushing accumulated APIKey stats from DP to CP database",
@@ -5856,6 +5916,74 @@ const docTemplate = `{
}
}
},
"internal_api.reportAlertEntry": {
"type": "object",
"required": [
"severity",
"title",
"type"
],
"properties": {
"fingerprint": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "string"
},
"related_id": {
"type": "integer"
},
"related_name": {
"type": "string"
},
"related_type": {
"type": "string"
},
"severity": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"internal_api.reportAlertsRequest": {
"type": "object",
"required": [
"alerts"
],
"properties": {
"alerts": {
"type": "array",
"items": {
"$ref": "#/definitions/internal_api.reportAlertEntry"
}
}
}
},
"internal_api.reportAlertsResponse": {
"type": "object",
"properties": {
"accepted": {
"type": "integer"
},
"deduplicated": {
"type": "integer"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"internal_api.statsFlushEntry": {
"type": "object",
"properties": {

128
docs/swagger.json
View File

@@ -731,6 +731,20 @@
"admin"
],
"summary": "APIKey stats summary (admin)",
"parameters": [
{
"type": "integer",
"description": "Start time (unix seconds)",
"name": "since",
"in": "query"
},
{
"type": "integer",
"description": "End time (unix seconds)",
"name": "until",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
@@ -3379,6 +3393,52 @@
}
}
},
"/internal/alerts/report": {
"post": {
"description": "Internal endpoint for Data Plane to report alerts to Control Plane",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"internal"
],
"summary": "Report alerts from DP",
"parameters": [
{
"description": "Alerts to report",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/internal_api.reportAlertsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/internal_api.reportAlertsResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/gin.H"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/gin.H"
}
}
}
}
},
"/internal/apikey-stats/flush": {
"post": {
"description": "Internal endpoint for flushing accumulated APIKey stats from DP to CP database",
@@ -5850,6 +5910,74 @@
}
}
},
"internal_api.reportAlertEntry": {
"type": "object",
"required": [
"severity",
"title",
"type"
],
"properties": {
"fingerprint": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "string"
},
"related_id": {
"type": "integer"
},
"related_name": {
"type": "string"
},
"related_type": {
"type": "string"
},
"severity": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"internal_api.reportAlertsRequest": {
"type": "object",
"required": [
"alerts"
],
"properties": {
"alerts": {
"type": "array",
"items": {
"$ref": "#/definitions/internal_api.reportAlertEntry"
}
}
}
},
"internal_api.reportAlertsResponse": {
"type": "object",
"properties": {
"accepted": {
"type": "integer"
},
"deduplicated": {
"type": "integer"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"internal_api.statsFlushEntry": {
"type": "object",
"properties": {

84
docs/swagger.yaml
View File

@@ -1164,6 +1164,51 @@ definitions:
ref:
type: string
type: object
internal_api.reportAlertEntry:
properties:
fingerprint:
type: string
message:
type: string
metadata:
type: string
related_id:
type: integer
related_name:
type: string
related_type:
type: string
severity:
type: string
title:
type: string
type:
type: string
required:
- severity
- title
- type
type: object
internal_api.reportAlertsRequest:
properties:
alerts:
items:
$ref: '#/definitions/internal_api.reportAlertEntry'
type: array
required:
- alerts
type: object
internal_api.reportAlertsResponse:
properties:
accepted:
type: integer
deduplicated:
type: integer
errors:
items:
type: string
type: array
type: object
internal_api.statsFlushEntry:
properties:
last_accessed_at:
@@ -1681,6 +1726,15 @@ paths:
/admin/apikey-stats/summary:
get:
description: Aggregate APIKey success/failure stats across all provider groups
parameters:
- description: Start time (unix seconds)
in: query
name: since
type: integer
- description: End time (unix seconds)
in: query
name: until
type: integer
produces:
- application/json
responses:
@@ -3386,6 +3440,36 @@ paths:
summary: Get current identity
tags:
- auth
/internal/alerts/report:
post:
consumes:
- application/json
description: Internal endpoint for Data Plane to report alerts to Control Plane
parameters:
- description: Alerts to report
in: body
name: request
required: true
schema:
$ref: '#/definitions/internal_api.reportAlertsRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/internal_api.reportAlertsResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/gin.H'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/gin.H'
summary: Report alerts from DP
tags:
- internal
/internal/apikey-stats/flush:
post:
consumes: