Client/server
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(api): standardize formatting and add missing newlines in API files

Browse Source
This commit is contained in:
Chang lue Tsen 2025-07-05 14:30:05 -04:00
parent 987e25e7ac
commit 1a849fd461
41 changed files with 140 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apis/admin/ads.api
View File

@ -76,3 +76,4 @@ service ppanel {
@handler GetAdsDetail
get /detail (GetAdsDetailRequest) returns (Ads)
}

1
apis/admin/announcement.api
View File

@ -73,3 +73,4 @@ service ppanel {
@handler GetAnnouncement
get /detail (GetAnnouncementRequest) returns (Announcement)
}

2
apis/admin/auth.api
View File

@ -25,7 +25,6 @@ type (
GetAuthMethodListResponse {
List []AuthMethodConfig `json:"list"`
}
TestSmsSendRequest {
AreaCode string `json:"area_code" validate:"required"`
Telephone string `json:"telephone" validate:"required"`
@ -70,3 +69,4 @@ service ppanel {
@handler GetEmailPlatform
get /email_platform returns (PlatformResponse)
}

1
apis/admin/console.api
View File

@ -85,3 +85,4 @@ service ppanel {
@handler QueryTicketWaitReply
get /ticket returns (TicketWaitRelpyResponse)
}

1
apis/admin/coupon.api
View File

@ -82,3 +82,4 @@ service ppanel {
@handler GetCouponList
get /list (GetCouponListRequest) returns (GetCouponListResponse)
}

3
apis/admin/device.api
View File

@ -1,9 +1,10 @@
syntax = "v1"
info(
info (
title: "Device API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)

1
apis/admin/log.api
View File

@ -37,3 +37,4 @@ service ppanel {
@handler GetMessageLogList
get /message/list (GetMessageLogListRequest) returns (GetMessageLogListResponse)
}

1
apis/admin/order.api
View File

@ -65,3 +65,4 @@ service ppanel {
@handler UpdateOrderStatus
put /status (UpdateOrderStatusRequest)
}

1
apis/admin/payment.api
View File

@ -78,3 +78,4 @@ service ppanel {
@handler GetPaymentPlatform
get /platform returns (PlatformResponse)
}

1
apis/admin/server.api
View File

@ -187,3 +187,4 @@ service ppanel {
@handler GetRuleGroupList
get /rule_group_list returns (GetRuleGroupResponse)
}

4
apis/admin/subscribe.api
View File

@ -88,13 +88,10 @@ type (
GroupId int64 `form:"group_id,omitempty"`
Search string `form:"search,omitempty"`
}
SubscribeItem {
Subscribe
Sold int64 `json:"sold"`
}
GetSubscribeListResponse {
List []SubscribeItem `json:"list"`
Total int64 `json:"total"`
@ -161,3 +158,4 @@ service ppanel {
@handler SubscribeSort
post /sort (SubscribeSortRequest)
}

1
apis/admin/system.api
View File

@ -202,3 +202,4 @@ service ppanel {
@handler UpdateVerifyCodeConfig
put /verify_code_config (VerifyCodeConfig)
}

1
apis/admin/ticket.api
View File

@ -59,3 +59,4 @@ service ppanel {
@handler CreateTicketFollow
post /follow (CreateTicketFollowRequest)
}

6
apis/admin/tool.api
View File

@ -1,7 +1,7 @@
syntax = "v1"
info(
title: "Tools Api"
info (
title: "Tools Api"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
@ -21,7 +21,6 @@ type (
group: admin/tool
middleware: AuthMiddleware
)
service ppanel {
@doc "Get System Log"
@handler GetSystemLog
@ -31,3 +30,4 @@ service ppanel {
@handler RestartSystem
get /restart
}

1
apis/admin/user.api
View File

@ -275,3 +275,4 @@ service ppanel {
@handler GetUserLoginLogs
get /login/logs (GetUserLoginLogsRequest) returns (GetUserLoginLogsResponse)
}

1
apis/app/announcement.api
View File

@ -20,3 +20,4 @@ service ppanel {
@handler QueryAnnouncement
get /list (QueryAnnouncementRequest) returns (QueryAnnouncementResponse)
}

13
apis/app/auth.api
View File

@ -1,10 +1,10 @@
syntax = "v1"
info(
title: "App Auth Api"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
info (
title: "App Auth Api"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)
@ -75,7 +75,7 @@ type (
}
)
@server(
@server (
prefix: v1/app/auth
group: app/auth
middleware: AppMiddleware
@ -101,3 +101,4 @@ service ppanel {
@handler GetAppConfig
post /config (AppConfigRequest) returns (AppConfigResponse)
}

4
apis/app/document.api
View File

@ -1,6 +1,6 @@
syntax = "v1"
info(
info (
title: "Document API"
desc: "API for ppanel"
author: "Tension"
@ -15,7 +15,6 @@ import "../types.api"
group: app/document
middleware: AppMiddleware,AuthMiddleware
)
service ppanel {
@doc "Get document list"
@handler QueryDocumentList
@ -25,3 +24,4 @@ service ppanel {
@handler QueryDocumentDetail
get /detail (QueryDocumentDetailRequest) returns (Document)
}

14
apis/app/node.api
View File

@ -1,7 +1,7 @@
syntax = "v1"
info(
title: "App Node Api"
info (
title: "App Node Api"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
@ -15,11 +15,9 @@ type (
Total int64 `json:"total"`
List []ServerRuleGroup `json:"list"`
}
AppUserSubscbribeNodeRequest {
Id int64 `form:"id" validate:"required"`
}
AppUserSubscbribeNodeResponse {
List []AppUserSubscbribeNode `json:"list"`
}
@ -30,15 +28,13 @@ type (
group: app/node
middleware: AppMiddleware,AuthMiddleware
)
service ppanel {
@doc "Get Node list"
@handler GetNodeList
get /list (AppUserSubscbribeNodeRequest) returns(AppUserSubscbribeNodeResponse)
get /list (AppUserSubscbribeNodeRequest) returns (AppUserSubscbribeNodeResponse)
@doc "Get rule group list"
@handler GetRuleGroupList
get /rule_group_list returns (AppRuleGroupListResponse)
get /rule_group_list returns (AppRuleGroupListResponse)
}

1
apis/app/order.api
View File

@ -54,3 +54,4 @@ service ppanel {
@handler QueryOrderList
get /list (QueryOrderListRequest) returns (QueryOrderListResponse)
}

1
apis/app/payment.api
View File

@ -20,3 +20,4 @@ service ppanel {
@handler GetAvailablePaymentMethods
get /methods returns (GetAvailablePaymentMethodsResponse)
}

19
apis/app/subscribe.api
View File

@ -1,10 +1,10 @@
syntax = "v1"
info(
title: "Subscribe API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
info (
title: "Subscribe API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)
@ -14,35 +14,29 @@ type (
QueryUserSubscribeResp {
Data []UserSubscribeData `json:"data"`
}
UserSubscribeData {
SubscribeId int64 `json:"subscribe_id"`
UserSubscribeId int64 `json:"user_subscribe_id"`
}
UserSubscribeResetPeriodRequest {
UserSubscribeId int64 `json:"user_subscribe_id"`
}
UserSubscribeResetPeriodResponse {
Status bool `json:"status"`
}
AppUserSubscribeRequest {
ContainsNodes *bool `form:"contains_nodes"`
}
AppUserSubscbribeResponse {
List []AppUserSubcbribe `json:"list"`
}
)
@server(
@server (
prefix: v1/app/subscribe
group: app/subscribe
middleware: AppMiddleware,AuthMiddleware
)
service ppanel {
@doc "Get subscribe list"
@handler QuerySubscribeList
@ -68,3 +62,4 @@ service ppanel {
@handler ResetUserSubscribePeriod
post /reset/period (UserSubscribeResetPeriodRequest) returns (UserSubscribeResetPeriodResponse)
}

4
apis/app/user.api
View File

@ -33,12 +33,10 @@ type (
Method string `json:"method" validate:"required" validate:"required,oneof=email telephone device"`
Code string `json:"code"`
}
GetUserOnlineTimeStatisticsResponse {
WeeklyStats []WeeklyStat `json:"weekly_stats"`
ConnectionRecords ConnectionRecords `json:"connection_records"`
}
WeeklyStat {
Day int `json:"day"`
DayName string `json:"day_name"`
@ -84,5 +82,5 @@ service ppanel {
@doc "Query User Affiliate Count"
@handler QueryUserAffiliate
get /affiliate/count returns (QueryUserAffiliateCountResponse)
}

8
apis/app/ws.api
View File

@ -1,21 +1,21 @@
syntax = "v1"
info(
title: "App Heartbeat Api"
info (
title: "App Heartbeat Api"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)
@server(
@server (
prefix: v1/app/ws
group: app/ws
middleware: AuthMiddleware
)
service ppanel {
@doc "App heartbeat"
@handler AppWs
get /:userid/:identifier
}

3
apis/auth/auth.api
View File

@ -54,12 +54,10 @@ type (
OAuthLoginResponse {
Redirect string `json:"redirect"`
}
OAuthLoginGetTokenRequest {
Method string `json:"method" validate:"required"` // google, facebook, apple, telegram, github etc.
Callback interface{} `json:"callback" validate:"required"`
}
// login request
TelephoneLoginRequest {
Telephone string `json:"telephone" validate:"required"`
@ -163,3 +161,4 @@ service ppanel {
@handler AppleLoginCallback
post /callback/apple (AppleLoginCallbackRequest)
}

2
apis/common.api
View File

@ -75,7 +75,6 @@ type (
Code string `json:"code" validate:"required"`
Type uint8 `json:"type" validate:"required"`
}
CheckVerificationCodeRespone {
Status bool `json:"status"`
}
@ -122,3 +121,4 @@ service ppanel {
@handler CheckVerificationCode
post /check_verification_code (CheckVerificationCodeRequest) returns (CheckVerificationCodeRespone)
}

6
apis/node/node.api
View File

@ -78,7 +78,6 @@ type (
ServerCommon
Traffic []UserTraffic `json:"traffic"`
}
ServerPushStatusRequest {
ServerCommon
Cpu float64 `json:"cpu"`
@ -93,8 +92,8 @@ type (
)
@server (
prefix: v1/server
group: server
prefix: v1/server
group: server
middleware: ServerMiddleware
)
service ppanel {
@ -118,3 +117,4 @@ service ppanel {
@handler PushOnlineUsers
post /online (OnlineUsersRequest)
}

1
apis/public/announcement.api
View File

@ -20,3 +20,4 @@ service ppanel {
@handler QueryAnnouncement
get /list (QueryAnnouncementRequest) returns (QueryAnnouncementResponse)
}

4
apis/public/document.api
View File

@ -1,6 +1,6 @@
syntax = "v1"
info(
info (
title: "Document API"
desc: "API for ppanel"
author: "Tension"
@ -15,7 +15,6 @@ import "../types.api"
group: public/document
middleware: AuthMiddleware
)
service ppanel {
@doc "Get document list"
@handler QueryDocumentList
@ -25,3 +24,4 @@ service ppanel {
@handler QueryDocumentDetail
get /detail (QueryDocumentDetailRequest) returns (Document)
}

1
apis/public/order.api
View File

@ -48,3 +48,4 @@ service ppanel {
@handler QueryOrderList
get /list (QueryOrderListRequest) returns (QueryOrderListResponse)
}

1
apis/public/payment.api
View File

@ -20,3 +20,4 @@ service ppanel {
@handler GetAvailablePaymentMethods
get /methods returns (GetAvailablePaymentMethodsResponse)
}

1
apis/public/portal.api
View File

@ -93,3 +93,4 @@ service ppanel {
@handler PurchaseCheckout
post /order/checkout (CheckoutOrderRequest) returns (CheckoutOrderResponse)
}

1
apis/public/subscribe.api
View File

@ -28,3 +28,4 @@ service ppanel {
@handler QueryApplicationConfig
get /application/config returns (ApplicationResponse)
}

1
apis/public/ticket.api
View File

@ -66,3 +66,4 @@ service ppanel {
@handler CreateUserTicket
post / (CreateUserTicketRequest)
}

9
apis/public/user.api
View File

@ -28,7 +28,6 @@ type (
List []UserBalanceLog `json:"list"`
Total int64 `json:"total"`
}
CommissionLog {
Id int64 `json:"id"`
UserId int64 `json:"user_id"`
@ -77,37 +76,30 @@ type (
ResetUserSubscribeTokenRequest {
UserSubscribeId int64 `json:"user_subscribe_id"`
}
GetLoginLogRequest {
Page int `form:"page"`
Size int `form:"size"`
}
GetLoginLogResponse {
List []UserLoginLog `json:"list"`
Total int64 `json:"total"`
}
GetSubscribeLogRequest {
Page int `form:"page"`
Size int `form:"size"`
}
GetSubscribeLogResponse {
List []UserSubscribeLog `json:"list"`
Total int64 `json:"total"`
}
UpdateBindMobileRequest {
AreaCode string `json:"area_code" validate:"required"`
Mobile string `json:"mobile" validate:"required"`
Code string `json:"code" validate:"required"`
}
UpdateBindEmailRequest {
Email string `json:"email" validate:"required"`
}
VerifyEmailRequest {
Email string `json:"email" validate:"required"`
Code string `json:"code" validate:"required"`
@ -208,3 +200,4 @@ service ppanel {
@handler UpdateBindEmail
put /bind_email (UpdateBindEmailRequest)
}

44
apis/swagger_admin.api
View File

@ -1,26 +1,28 @@
syntax = "v1"
info(
title: "admin API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
info (
title: "admin API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)
import (
"./admin/system.api"
"./admin/user.api"
"./admin/server.api"
"./admin/subscribe.api"
"./admin/payment.api"
"./admin/coupon.api"
"./admin/order.api"
"./admin/ticket.api"
"./admin/announcement.api"
"./admin/document.api"
"./admin/tool.api"
"./admin/console.api"
"./admin/auth.api"
"./admin/log.api"
"./admin/ads.api"
"./admin/system.api"
"./admin/user.api"
"./admin/server.api"
"./admin/subscribe.api"
"./admin/payment.api"
"./admin/coupon.api"
"./admin/order.api"
"./admin/ticket.api"
"./admin/announcement.api"
"./admin/document.api"
"./admin/tool.api"
"./admin/console.api"
"./admin/auth.api"
"./admin/log.api"
"./admin/ads.api"
)

3
apis/swagger_app.api
View File

@ -1,6 +1,6 @@
syntax = "v1"
info(
info (
title: "App API"
desc: "API for ppanel"
author: "Tension"
@ -19,3 +19,4 @@ import (
"./app/document.api"
"./app/subscribe.api"
)

3
apis/swagger_common.api
View File

@ -1,6 +1,6 @@
syntax = "v1"
info(
info (
title: "common API"
desc: "API for ppanel"
author: "Tension"
@ -12,3 +12,4 @@ import (
"./common.api"
"./auth/auth.api"
)

2
apis/swagger_node.api
View File

@ -1,6 +1,6 @@
syntax = "v1"
info(
info (
title: "Node API"
desc: "API for ppanel"
author: "Tension"

4
apis/swagger_user.api
View File

@ -1,12 +1,13 @@
syntax = "v1"
info(
info (
title: "User API"
desc: "API for ppanel"
author: "Tension"
email: "tension@ppanel.com"
version: "0.0.1"
)
import (
"./public/user.api"
"./public/subscribe.api"
@ -17,3 +18,4 @@ import (
"./public/document.api"
"./public/portal.api"
)

16
apis/types.api
View File

@ -246,11 +246,15 @@ type (
SecurityConfig SecurityConfig `json:"security_config"`
}
Tuic {
Port int `json:"port" validate:"required"`
DisableSNI bool `json:"disable_sni"`
ReduceRtt bool `json:"reduce_rtt"`
UDPRelayMode string `json:"udp_relay_mode"`
CongestionController string `json:"congestion_controller"`
SecurityConfig SecurityConfig `json:"security_config"`
}
AnyTLS {
Port int `json:"port" validate:"required"`
DisableSNI bool `json:"disable_sni"`
ReduceRtt bool `json:"reduce_rtt"`
UDPRelayMode string `json:"udp_relay_mode"`
CongestionController string `json:"congestion_controller"`
SecurityConfig SecurityConfig `json:"security_config"`
}
SecurityConfig {
@ -711,12 +715,10 @@ type (
Telephone string `json:"telephone"`
Address string `json:"address"`
}
QueryUserAffiliateCountResponse {
Registers int64 `json:"registers"`
TotalCommission int64 `json:"total_commission"`
}
AppUserSubcbribe {
Id int64 `json:"id"`
Name string `json:"name"`
@ -728,7 +730,6 @@ type (
ExpireTime string `json:"expire_time"`
List []AppUserSubscbribeNode `json:"list"`
}
AppUserSubscbribeNode {
Id int64 `json:"id"`
Name string `json:"name"`
@ -751,3 +752,4 @@ type (
Download int64 `json:"download"`
}
)