chore: add documentation links for sdk3rd clients

pkg/sdk3rd/1panel/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for 1Panel v1.
+// API documentation: https://1panel.cn/docs/v1/dev_manual/api_manual/
 package onepanel
 
 import (

pkg/sdk3rd/1panel/v2/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for 1Panel v2.
+// API documentation: https://1panel.cn/docs/v2/dev_manual/api_manual/
 package v2
 
 import (

pkg/sdk3rd/alibabacloud/oss/client.go

@@ -1,4 +1,6 @@
-package oss
+// A simple SDK client for AliababaCloud OSS.
+// API documentation: https://www.alibabacloud.com/help/en/oss/developer-reference/list-of-operations-by-function
+package oss
 
 import (
 	"crypto/md5"

pkg/sdk3rd/apisix/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for APISIX.
+// API documentation: https://apisix.apache.org/zh/docs/apisix/admin-api/
 package apisix
 
 import (

pkg/sdk3rd/baiducloud/cert/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for BaiduCloud SSL service.
+// Based on github.com/baidubce/bce-sdk-go.
 package cert
 
 import (

pkg/sdk3rd/baishan/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for BaishanCloud.
+// API documentation: https://portal.baishancloud.com/track/document/api/1/1249
 package baishan
 
 import (

pkg/sdk3rd/btpanel/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for aaPanel.
+// API documentation: https://www.aapanel.com/docs/api/api-list.html
 package btpanel
 
 import (
@@ -162,5 +164,6 @@ func generateSignature(timestamp string, apiKey string) string {
 
 	signMd5 := md5.Sum([]byte(timestamp + keyMd5Hex))
 	signMd5Hex := strings.ToLower(hex.EncodeToString(signMd5[:]))
+
 	return signMd5Hex
 }

pkg/sdk3rd/btpanelgo/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for aaPanel Windows Go version.
+// API documentation: https://www.aapanel.com/docs/api/api-list.html
 package btpanelgo
 
 import (
@@ -213,5 +215,6 @@ func generateSignature(timestamp string, apiKey string) string {
 
 	signMd5 := md5.Sum([]byte(timestamp + keyMd5Hex))
 	signMd5Hex := strings.ToLower(hex.EncodeToString(signMd5[:]))
+
 	return signMd5Hex
 }

pkg/sdk3rd/btwaf/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for aaWAF.
+// API documentation: https://github.com/aaPanel/aaWAF/blob/main/API.md
 package btwaf
 
 import (

pkg/sdk3rd/bunny/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Bunny.
+// API documentation: https://docs.bunny.net/api-reference
 package bunny
 
 import (

pkg/sdk3rd/cachefly/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for CacheFly.
+// API documentation: https://api.cachefly.com/api/v2/docs/api/
 package cachefly
 
 import (

pkg/sdk3rd/cdnfly/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Cdnfly.
+// API documentation: http://doc.cdnfly.com/shiyongjieshao.html
 package cdnfly
 
 import (

pkg/sdk3rd/cloudflare/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Cloudflare.
+// API documentation: https://developers.cloudflare.com/api/
 package cloudflare
 
 import (

pkg/sdk3rd/conoha/vps/v3/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for ConoHa VPS v3.
+// API documentation: https://doc.conoha.jp/reference/api-vps3/
 package v3
 
 import (

pkg/sdk3rd/cpanel/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for cPanel.
+// API documentation: https://api.docs.cpanel.net/
 package cpanel
 
 import (

pkg/sdk3rd/ctyun/ao/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud AccessOne.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=113&vid=167
 package ao
 
 import (

pkg/sdk3rd/ctyun/cdn/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud CDN.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=108&vid=154
 package cdn
 
 import (

pkg/sdk3rd/ctyun/cms/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud CMS.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=152&vid=283
 package cms
 
 import (

pkg/sdk3rd/ctyun/dns/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud DNS.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=122&vid=259
 package dns
 
 import (

pkg/sdk3rd/ctyun/elb/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud ELB.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=24&vid=82
 package elb
 
 import (

pkg/sdk3rd/ctyun/faas/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud FaaS.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=53&vid=40
 package faas
 
 import (

pkg/sdk3rd/ctyun/icdn/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud ICDN.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=112&vid=166
 package icdn
 
 import (

pkg/sdk3rd/ctyun/lvdn/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for StateCloud LVDN.
+// API documentation: https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=125&vid=261
 package lvdn
 
 import (

pkg/sdk3rd/dcloud/unicloud/client.go

@@ -1,3 +1,4 @@
+// A mock HTTP client for uniCloud.
 package unicloud
 
 import (

pkg/sdk3rd/digitalocean/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for DigitalOcean.
+// API documentation: https://docs.digitalocean.com/reference/api/
 package digitalocean
 
 import (

pkg/sdk3rd/dogecloud/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for DogeCloud.
+// API documentation: https://docs.dogecloud.com/
 package dogecloud
 
 import (

pkg/sdk3rd/dokploy/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Dokploy.
+// API documentation: https://docs.dokploy.com/docs/api
 package dokploy
 
 import (

pkg/sdk3rd/dynv6/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Dynv6.
+// API documentation: https://dynv6.com/docs/apis
 package dynv6
 
 import (

pkg/sdk3rd/flexcdn/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for FlexCDN.
+// API documentation: https://flexcdn.cn/docs/api/list
 package flexcdn
 
 import (

pkg/sdk3rd/flyio/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Fly.io.
+// API documentation: https://fly.io/docs/machines/api/
 package flyio
 
 import (

pkg/sdk3rd/goedge/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for GoEdge.
+// API documentation: https://goedge.cloud/docs/API/List.md
 package goedge
 
 import (

pkg/sdk3rd/huaweicloud/obs/client.go

@@ -1,4 +1,6 @@
-package obs
+// A simple SDK client for HuaweiCloud OBS.
+// API documentation: https://support.huaweicloud.com/api-obs/obs_04_0005.html
+package obs
 
 import (
 	"crypto/md5"

pkg/sdk3rd/kong/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Kong.
+// API documentation: https://developer.konghq.com/api/
 package kong
 
 import (

pkg/sdk3rd/lecdn/v3/client/client.go

@@ -1,3 +1,4 @@
+// A simple SDK client for LeCDN v3 as user.
 package client
 
 import (

pkg/sdk3rd/lecdn/v3/master/client.go

@@ -1,3 +1,4 @@
+// A simple SDK client for LeCDN v3 as admin.
 package master
 
 import (

pkg/sdk3rd/linode/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Linode.
+// API documentation: https://techdocs.akamai.com/linode-api/reference/api
 package linode
 
 import (

pkg/sdk3rd/mohua/client.go

@@ -1,3 +1,4 @@
+// A simple SDK client for MohuaTech.
 package mohua
 
 import (

pkg/sdk3rd/netlify/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Netlify.
+// API documentation: https://open-api.netlify.com/
 package netlify
 
 import (

pkg/sdk3rd/nginxproxymanager/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for NginxProxyManager.
+// API documentation: https://github.com/NginxProxyManager/nginx-proxy-manager/discussions/3265
 package nginxproxymanager
 
 import (

pkg/sdk3rd/proxmoxve/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Proxmox VE.
+// API documentation: https://pve.proxmox.com/pve-docs/api-viewer/index.html
 package proxmoxve
 
 import (

pkg/sdk3rd/qingcloud/dns/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for QingCloud DNS.
+// API documentation: https://docsv4.qingcloud.com/user_guide/development_docs/api/api_list/dns/api_intro/
 package dns
 
 import (

pkg/sdk3rd/qingcloud/lb/service.go

@@ -1,4 +1,6 @@
-package lb
+// An extension SDK client for QingCloud LB service.
+// Based on github.com/yunify/qingcloud-sdk-go.
+package lb
 
 import (
 	"fmt"

pkg/sdk3rd/qiniu/doc.go

@@ -0,0 +1,3 @@
+// An extension SDK client for Qiniu.
+// Based on github.com/qiniu/go-sdk.
+package qiniu

pkg/sdk3rd/rainyun/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Rainyun.
+// API documentation: https://api.rainyun.com/
 package rainyun
 
 import (

pkg/sdk3rd/ratpanel/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for AcePanel.
+// API documentation: https://acepanel.net/en/advanced/api
 package ratpanel
 
 import (

pkg/sdk3rd/ratpanel/signer.go

@@ -20,6 +20,7 @@ type signer struct {
 func (s *signer) Sign(req *http.Request) error {
 	// API 签名机制：
 	// https://ratpanel.github.io/advanced/api#authentication-mechanism
+	// https://acepanel.net/en/advanced/api
 
 	payloadStr := ""
 	if req.Body != nil {

pkg/sdk3rd/safeline/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for SafeLine.
+// API documentation: https://help.waf-ce.chaitin.cn/node/01973fc6-e25e-7eda-8ea8-dae97bdd4213
 package safeline
 
 import (

pkg/sdk3rd/samwaf/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for SamWAF.
+// API documentation: https://doc.samwaf.com/api/
 package samwaf
 
 import (

pkg/sdk3rd/synologydsm/client.go

@@ -1,3 +1,4 @@
+// A mock HTTP client for Synology DSM.
 package synologydsm
 
 import (

pkg/sdk3rd/ucloud/ucdn/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud CDN service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package ucdn
 
 import (

pkg/sdk3rd/ucloud/uewaf/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud WAF service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package uewaf
 
 import (

pkg/sdk3rd/ucloud/ufile/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud OS service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package ufile
 
 import (

pkg/sdk3rd/ucloud/ulb/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud LB service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package ulb
 
 import (

pkg/sdk3rd/ucloud/upathx/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud PathX service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package upathx
 
 import (

pkg/sdk3rd/ucloud/ussl/client.go

@@ -1,3 +1,5 @@
+// An extension SDK client for UCloud SSL service.
+// Based on github.com/ucloud/ucloud-sdk-go.
 package ussl
 
 import (

pkg/sdk3rd/upyun/console/client.go

@@ -1,3 +1,4 @@
+// A mock HTTP client for Upyun Console.
 package console
 
 import (

pkg/sdk3rd/vercel/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for Vercel.
+// API documentation: https://vercel.com/docs/rest-api
 package vercel
 
 import (

pkg/sdk3rd/volcengine/tos/client.go

@@ -1,4 +1,6 @@
-package tos
+// A simple SDK client for VolcEngine TOS.
+// API documentation: https://www.volcengine.com/docs/6349/74837
+package tos
 
 import (
 	"crypto/md5"

pkg/sdk3rd/wangsu/cdn/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for WangsuCloud CDN.
+// API documentation: https://www.wangsu.com/document/api-doc/product
 package cdn
 
 import (

pkg/sdk3rd/wangsu/cdnpro/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for WangsuCloud CDN.
+// API documentation: https://www.wangsu.com/document/api-doc/product
 package cdnpro
 
 import (

pkg/sdk3rd/wangsu/certificate/client.go

@@ -1,3 +1,5 @@
+// A simple SDK client for WangsuCloud CDN.
+// API documentation: https://www.wangsu.com/document/api-doc/product
 package certificate
 
 import (

pkg/sdk3rd/zenlayer/cdn/client.go

@@ -1,4 +1,6 @@
-package cdn
+// An extension SDK client for ZenlayerCloud CDN service.
+// Based on github.com/zenlayer/zenlayercloud-sdk-go.
+package cdn
 
 import (
 	"github.com/zenlayer/zenlayercloud-sdk-go/zenlayercloud/common"

pkg/sdk3rd/zenlayer/zga/client.go

@@ -1,4 +1,6 @@
-package zga
+// An extension SDK client for ZenlayerCloud CDN service.
+// Based on github.com/zenlayer/zenlayercloud-sdk-go.
+package zga
 
 import (
 	"github.com/zenlayer/zenlayercloud-sdk-go/zenlayercloud/common"