feat: Add Swagger documentation models for API endpoints with comprehensive field annotations

- Add Subscriber model with IMSI/MSISDN/email/status/plan_id/profile_status fields and validation examples
- Add Service model with name/namespace/replicas/ready_replicas/available_replicas/creation_timestamp fields
- Add Deployment model with service/version/status/started_at/completed_at/metadata fields and status enum
- Add Plugin model with name/version/author/description/enabled/config fields
- Add Automation model with name/description/trigger/
This commit is contained in:
nutcas3
2026-04-20 20:06:37 +03:00
parent 14ca3d00e7
commit f42a753372
4 changed files with 722 additions and 0 deletions
+25
View File
@@ -0,0 +1,25 @@
package docs
import (
"github.com/swaggo/swag"
)
// @title Telecom Platform API
// @version 1.0.0
// @description A comprehensive telecom platform API for managing subscribers, services, monitoring, deployments, plugins, automation, and billing
// @termsOfService https://github.com/nutcas3/telecom-platform/blob/main/LICENSE
// @contact.name Telecom Platform Team
// @contact.url https://github.com/nutcas3/telecom-platform
// @contact.email [email protected]
// @license.name MIT
// @license.url https://opensource.org/licenses/MIT
// @host localhost:8000
// @BasePath /v1
// @securityDefinitions.apikey BearerAuth
// @in header
// @name Authorization
// @description Type "Bearer" followed by a space and JWT token.
func init() {
swag.Register(swag.Name, &s{})
}