S-VPN/server
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style(api): standardize formatting and remove trailing newlines in API definitions

Browse Source
This commit is contained in:
Chang lue Tsen 2025-05-31 09:29:31 -04:00
parent 56f6bd2542
commit 77f55f8708
40 changed files with 437 additions and 492 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apis/admin/ads.api
View File

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

1
apis/admin/announcement.api
View File

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

4
apis/admin/auth.api
View File

@ -26,7 +26,6 @@ type (
List []AuthMethodConfig `json:"list"`
}
TestSmsSendRequest {
AreaCode string `json:"area_code" validate:"required"`
Telephone string `json:"telephone" validate:"required"`
@ -35,7 +34,6 @@ type (
TestEmailSendRequest {
Email string `json:"email" validate:"required"`
}
)
@server (
@ -56,7 +54,6 @@ service ppanel {
@handler UpdateAuthMethodConfig
put /config (UpdateAuthMethodConfigRequest) returns (AuthMethodConfig)
@doc "Test sms send"
@handler TestSmsSend
post /test_sms_send (TestSmsSendRequest)
@ -73,4 +70,3 @@ service ppanel {
@handler GetEmailPlatform
get /email_platform returns (PlatformResponse)
}

1
apis/admin/console.api
View File

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

1
apis/admin/coupon.api
View File

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

4
apis/admin/device.api
View File

@ -7,7 +7,3 @@ info(
email: "tension@ppanel.com"
version: "0.0.1"
)
type (
)

1
apis/admin/log.api
View File

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

1
apis/admin/order.api
View File

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

1
apis/admin/payment.api
View File

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

1
apis/admin/server.api
View File

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

1
apis/admin/subscribe.api
View File

@ -161,4 +161,3 @@ service ppanel {
@handler SubscribeSort
post /sort (SubscribeSortRequest)
}

1
apis/admin/system.api
View File

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

1
apis/admin/ticket.api
View File

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

1
apis/admin/user.api
View File

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

2
apis/app/announcement.api
View File

@ -10,7 +10,6 @@ info (
import "../types.api"
@server (
prefix: v1/app/announcement
group: app/announcement
@ -21,4 +20,3 @@ service ppanel {
@handler QueryAnnouncement
get /list (QueryAnnouncementRequest) returns (QueryAnnouncementResponse)
}

1
apis/app/auth.api
View File

@ -101,4 +101,3 @@ service ppanel {
@handler GetAppConfig
post /config (AppConfigRequest) returns (AppConfigResponse)
}

9
apis/app/node.api
View File

@ -1,6 +1,5 @@
syntax = "v1"
info(
title: "App Node Api"
desc: "API for ppanel"
@ -11,9 +10,7 @@ info(
import "../types.api"
type(
type (
AppRuleGroupListResponse {
Total int64 `json:"total"`
List []ServerRuleGroup `json:"list"`
@ -23,7 +20,7 @@ type(
Id int64 `form:"id" validate:"required"`
}
AppUserSubscbribeNodeResponse{
AppUserSubscbribeNodeResponse {
List []AppUserSubscbribeNode `json:"list"`
}
)
@ -36,8 +33,6 @@ type(
service ppanel {
@doc "Get Node list"
@handler GetNodeList
get /list (AppUserSubscbribeNodeRequest) returns(AppUserSubscbribeNodeResponse)

2
apis/app/order.api
View File

@ -12,7 +12,6 @@ import (
"../types.api"
)
@server (
prefix: v1/app/order
group: app/order
@ -55,4 +54,3 @@ service ppanel {
@handler QueryOrderList
get /list (QueryOrderListRequest) returns (QueryOrderListResponse)
}

1
apis/app/payment.api
View File

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

5
apis/app/subscribe.api
View File

@ -10,7 +10,6 @@ info(
import "../types.api"
type (
QueryUserSubscribeResp {
Data []UserSubscribeData `json:"data"`
@ -21,7 +20,6 @@ type (
UserSubscribeId int64 `json:"user_subscribe_id"`
}
UserSubscribeResetPeriodRequest {
UserSubscribeId int64 `json:"user_subscribe_id"`
}
@ -45,7 +43,6 @@ type (
middleware: AppMiddleware,AuthMiddleware
)
service ppanel {
@doc "Get subscribe list"
@handler QuerySubscribeList
@ -63,7 +60,6 @@ service ppanel {
@handler QueryUserAlreadySubscribe
get /user/already_subscribe returns (QueryUserSubscribeResp)
@doc "Get Available subscriptions for users"
@handler QueryUserAvailableUserSubscribe
get /user/available_subscribe (AppUserSubscribeRequest) returns (AppUserSubscbribeResponse)
@ -72,4 +68,3 @@ service ppanel {
@handler ResetUserSubscribePeriod
post /reset/period (UserSubscribeResetPeriodRequest) returns (UserSubscribeResetPeriodResponse)
}

12
apis/app/user.api
View File

@ -34,17 +34,17 @@ type (
Code string `json:"code"`
}
GetUserOnlineTimeStatisticsResponse{
WeeklyStats []WeeklyStat`json:"weekly_stats"`
ConnectionRecords ConnectionRecords`json:"connection_records"`
GetUserOnlineTimeStatisticsResponse {
WeeklyStats []WeeklyStat `json:"weekly_stats"`
ConnectionRecords ConnectionRecords `json:"connection_records"`
}
WeeklyStat{
WeeklyStat {
Day int `json:"day"`
DayName string `json:"day_name"`
Hours float64 `json:"hours"`
}
ConnectionRecords{
ConnectionRecords {
CurrentContinuousDays int64 `json:"current_continuous_days"`
HistoryContinuousDays int64 `json:"history_continuous_days"`
LongestSingleConnection int64 `json:"longest_single_connection"`
@ -85,6 +85,4 @@ service ppanel {
@handler QueryUserAffiliate
get /affiliate/count returns (QueryUserAffiliateCountResponse)
}

2
apis/app/ws.api
View File

@ -8,14 +8,12 @@ info(
version: "0.0.1"
)
@server(
prefix: v1/app/ws
group: app/ws
middleware: AuthMiddleware
)
service ppanel {
@doc "App heartbeat"
@handler AppWs

5
apis/auth/auth.api
View File

@ -23,7 +23,7 @@ type (
}
// User login response
CheckUserResponse {
exist bool `json:"exist"`
Exist bool `json:"exist"`
}
// User login response
UserRegisterRequest {
@ -76,7 +76,7 @@ type (
}
// User login response
TelephoneCheckUserResponse {
exist bool `json:"exist"`
Exist bool `json:"exist"`
}
// User login response
TelephoneRegisterRequest {
@ -163,4 +163,3 @@ service ppanel {
@handler AppleLoginCallback
post /callback/apple (AppleLoginCallbackRequest)
}

3
apis/common.api
View File

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

1
apis/node/node.api
View File

@ -118,4 +118,3 @@ service ppanel {
@handler PushOnlineUsers
post /online (OnlineUsersRequest)
}

2
apis/public/announcement.api
View File

@ -10,7 +10,6 @@ info (
import "../types.api"
@server (
prefix: v1/public/announcement
group: public/announcement
@ -21,4 +20,3 @@ service ppanel {
@handler QueryAnnouncement
get /list (QueryAnnouncementRequest) returns (QueryAnnouncementResponse)
}

1
apis/public/document.api
View File

@ -10,7 +10,6 @@ info(
import "../types.api"
@server (
prefix: v1/public/document
group: public/document

1
apis/public/order.api
View File

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

2
apis/public/payment.api
View File

@ -10,7 +10,6 @@ info (
import "../types.api"
@server (
prefix: v1/public/payment
group: public/payment
@ -21,4 +20,3 @@ service ppanel {
@handler GetAvailablePaymentMethods
get /methods returns (GetAvailablePaymentMethodsResponse)
}

1
apis/public/portal.api
View File

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

1
apis/public/subscribe.api
View File

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

2
apis/public/ticket.api
View File

@ -11,7 +11,6 @@ info (
import "../types.api"
type (
GetUserTicketListResponse {
Total int64 `json:"total"`
List []Ticket `json:"list"`
@ -67,4 +66,3 @@ service ppanel {
@handler CreateUserTicket
post / (CreateUserTicketRequest)
}

5
apis/public/user.api
View File

@ -98,13 +98,13 @@ type (
Total int64 `json:"total"`
}
UpdateBindMobileRequest{
UpdateBindMobileRequest {
AreaCode string `json:"area_code" validate:"required"`
Mobile string `json:"mobile" validate:"required"`
Code string `json:"code" validate:"required"`
}
UpdateBindEmailRequest{
UpdateBindEmailRequest {
Email string `json:"email" validate:"required"`
}
@ -208,4 +208,3 @@ service ppanel {
@handler UpdateBindEmail
put /bind_email (UpdateBindEmailRequest)
}

5
apis/types.api
View File

@ -713,7 +713,7 @@ type (
TotalCommission int64 `json:"total_commission"`
}
AppUserSubcbribe{
AppUserSubcbribe {
Id int64 `json:"id"`
Name string `json:"name"`
Upload int64 `json:"upload"`
@ -725,7 +725,7 @@ type (
List []AppUserSubscbribeNode `json:"list"`
}
AppUserSubscbribeNode{
AppUserSubscbribeNode {
Id int64 `json:"id"`
Name string `json:"name"`
Uuid string `json:"uuid"`
@ -747,4 +747,3 @@ type (
Download int64 `json:"download"`
}
)