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

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -85,6 +85,4 @@ service ppanel {
@handler QueryUserAffiliate @handler QueryUserAffiliate
get /affiliate/count returns (QueryUserAffiliateCountResponse) get /affiliate/count returns (QueryUserAffiliateCountResponse)
} }

View File

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

View File

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

View File

@ -122,4 +122,3 @@ service ppanel {
@handler CheckVerificationCode @handler CheckVerificationCode
post /check_verification_code (CheckVerificationCodeRequest) returns (CheckVerificationCodeRespone) post /check_verification_code (CheckVerificationCodeRequest) returns (CheckVerificationCodeRespone)
} }

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -208,4 +208,3 @@ service ppanel {
@handler UpdateBindEmail @handler UpdateBindEmail
put /bind_email (UpdateBindEmailRequest) put /bind_email (UpdateBindEmailRequest)
} }

View File

@ -747,4 +747,3 @@ type (
Download int64 `json:"download"` Download int64 `json:"download"`
} }
) )