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/docs/swagger.yaml
+13 -12
View File
@@ -1,4 +1,3 @@
basePath: /
definitions:
bootstrap.HealthResponse:
properties:
@@ -1329,22 +1328,21 @@ definitions:
username:
type: string
type: object
host: localhost:8082
info:
contact:
email: api-support@tender-management.com
name: Tender Management API Support
url: https://tender-management.com/support
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.
email: info@opplens.com
name: Opplens API Support
url: https://opplens.com
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.
license:
name: MIT
url: https://opensource.org/licenses/MIT
termsOfService: https://tender-management.com/terms
title: Tender Management API
version: 2.0.0
termsOfService: https://opplens.com/terms
title: Opplens API
version: 1.0.0
paths:
/admin/v1/companies:
get:
@@ -5736,3 +5734,6 @@ tags:
- description: Public flag management operations for mobile application including
flag retrieval and listing
name: Flags
- description: Public notification management operations for mobile application including
notification listing and detailed notification information
name: Notification