mazyar/tm_back
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update API Documentation and Swagger Configuration for Opplens

Browse Source 
- Changed API title and version in Swagger documentation from "Tender Management API" to "Opplens API" with version 1.0.0.
- Updated contact information and terms of service URLs to reflect the new branding for Opplens.
- Added a new "Notification" tag in the Swagger documentation for public notification management operations.
- Adjusted the Swagger endpoint path for documentation to improve routing consistency.
- Enhanced response structure in notification handlers to include metadata, improving clarity in API responses.
This commit is contained in:
n.nakhostin
2025-09-27 10:57:30 +03:30
parent 939f940499
commit 7110e55cf5
6 changed files with 51 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/main.go
+10 -10
View File
@@ -1,20 +1,17 @@
package main
// @title Tender Management API
// @version 2.0.0
// @description This is a comprehensive API for the Tender Management System built with Clean Architecture principles and Domain-Driven Design (DDD) patterns. The API provides endpoints for user management, customer management, company management, and authentication for both web panel administration and mobile application access.
// @termsOfService https://tender-management.com/terms
// @title Opplens API
// @version 1.0.0
// @description This is a comprehensive API for the Opplens built with Clean Architecture principles and Domain-Driven Design (DDD) patterns. The API provides endpoints for user management, customer management, company management, and authentication for both web panel administration and mobile application access.
// @termsOfService https://opplens.com/terms
// @contact.name Tender Management API Support
// @contact.url https://tender-management.com/support
// @contact.email api-support@tender-management.com
// @contact.name Opplens API Support
// @contact.url https://opplens.com
// @contact.email info@opplens.com
// @license.name MIT
// @license.url https://opensource.org/licenses/MIT
// @host localhost:8082
// @BasePath /
// @securityDefinitions.apikey BearerAuth
// @in header
// @name Authorization
@@ -77,6 +74,9 @@ package main
// @tag.name Flags
// @tag.description Public flag management operations for mobile application including flag retrieval and listing
// @tag.name Notification
// @tag.description Public notification management operations for mobile application including notification listing and detailed notification information
import (
"context"
"fmt"