From 834b3621a006b6b6a36639c278b4a7acfdcdae64 Mon Sep 17 00:00:00 2001 From: Zoee <30841158+n-WN@users.noreply.github.com> Date: Tue, 16 Jul 2024 09:52:09 +0800 Subject: [PATCH 1/2] Update Traffic-Stats-API.zh.md Improve the description of the use of the Traffic Statistics API --- docs/docs/advanced/Traffic-Stats-API.zh.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/advanced/Traffic-Stats-API.zh.md b/docs/docs/advanced/Traffic-Stats-API.zh.md index 0ae8329..54a3d59 100644 --- a/docs/docs/advanced/Traffic-Stats-API.zh.md +++ b/docs/docs/advanced/Traffic-Stats-API.zh.md @@ -1,5 +1,13 @@ # 流量统计 API +如果配置中加入 API secret，调用时需要在请求头加上 `Authorization` 标头。 + +请求： + +```shell +curl -H 'Authorization: secret' http://ip:port/path +``` + ### GET `/traffic` 此接口返回一个 JSON map，是每个用户的流量信息。 From c3f74bc7436d934db30881d1d4a3801bd4dffb1d Mon Sep 17 00:00:00 2001 From: Toby Date: Mon, 22 Jul 2024 17:27:43 -0700 Subject: [PATCH 2/2] feat: en translation --- docs/docs/advanced/Traffic-Stats-API.md | 8 ++++++++ docs/docs/advanced/Traffic-Stats-API.zh.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/docs/advanced/Traffic-Stats-API.md b/docs/docs/advanced/Traffic-Stats-API.md index 8aca02e..5eb7316 100644 --- a/docs/docs/advanced/Traffic-Stats-API.md +++ b/docs/docs/advanced/Traffic-Stats-API.md @@ -1,5 +1,13 @@ # Traffic Stats API +If an API secret is set in your configuration, you will need to add the `Authorization` header when making a request. + +Example: + +```shell +curl -H 'Authorization: secret' http://ip:port/path +``` + ### GET `/traffic` This endpoint returns a JSON map of client IDs to their traffic statistics. diff --git a/docs/docs/advanced/Traffic-Stats-API.zh.md b/docs/docs/advanced/Traffic-Stats-API.zh.md index 54a3d59..5820254 100644 --- a/docs/docs/advanced/Traffic-Stats-API.zh.md +++ b/docs/docs/advanced/Traffic-Stats-API.zh.md @@ -1,6 +1,6 @@ # 流量统计 API -如果配置中加入 API secret，调用时需要在请求头加上 `Authorization` 标头。 +如果配置中设置了 API secret，调用时需要在请求头加上 `Authorization` 标头。 请求：