Refactor API documentation and update endpoint tags for clarity
- Updated README.md to reflect changes in endpoint categories, renaming "Customers-Admin" to "Admin-Customers" and "Companies-Admin" to "Admin-Companies" for consistency. - Modified health check endpoint tags from "Health" to "Admin-Health" to align with the new naming convention. - Adjusted Swagger documentation to replace outdated tags and ensure accurate representation of the API structure. - Enhanced user and customer handler documentation to reflect the new "Admin-Authorization" and "Admin-Users" tags, improving clarity in the API documentation.
This commit is contained in:
n.nakhostin
+106
-113
@@ -39,7 +39,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "List companies with filters and pagination",
|
||||
"parameters": [
|
||||
@@ -251,7 +251,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Create a new company",
|
||||
"parameters": [
|
||||
@@ -326,7 +326,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Get companies by industry",
|
||||
"parameters": [
|
||||
@@ -410,7 +410,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Advanced search for companies",
|
||||
"parameters": [
|
||||
@@ -562,7 +562,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Get company statistics",
|
||||
"responses": {
|
||||
@@ -608,7 +608,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Get companies by status",
|
||||
"parameters": [
|
||||
@@ -698,7 +698,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Get companies by type",
|
||||
"parameters": [
|
||||
@@ -789,7 +789,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Get company by ID",
|
||||
"parameters": [
|
||||
@@ -854,7 +854,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Update company information",
|
||||
"parameters": [
|
||||
@@ -940,7 +940,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Delete company",
|
||||
"parameters": [
|
||||
@@ -995,7 +995,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Activate company",
|
||||
"parameters": [
|
||||
@@ -1050,7 +1050,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Update company status",
|
||||
"parameters": [
|
||||
@@ -1120,7 +1120,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Suspend company",
|
||||
"parameters": [
|
||||
@@ -1190,7 +1190,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Update company tags",
|
||||
"parameters": [
|
||||
@@ -1260,7 +1260,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Add tags to company",
|
||||
"parameters": [
|
||||
@@ -1330,7 +1330,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Remove tags from company",
|
||||
"parameters": [
|
||||
@@ -1400,7 +1400,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Update company verification status",
|
||||
"parameters": [
|
||||
@@ -1470,7 +1470,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Companies-Admin"
|
||||
"Admin-Companies"
|
||||
],
|
||||
"summary": "Verify company",
|
||||
"parameters": [
|
||||
@@ -1525,7 +1525,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "List customers with filters and pagination",
|
||||
"parameters": [
|
||||
@@ -1691,7 +1691,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Create a new customer",
|
||||
"parameters": [
|
||||
@@ -1766,7 +1766,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Get customers by company ID",
|
||||
"parameters": [
|
||||
@@ -1842,7 +1842,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Get customers by status",
|
||||
"parameters": [
|
||||
@@ -1932,7 +1932,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Get customers by type",
|
||||
"parameters": [
|
||||
@@ -2021,7 +2021,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "List customers with companies and filters",
|
||||
"parameters": [
|
||||
@@ -2189,7 +2189,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Get customer by ID",
|
||||
"parameters": [
|
||||
@@ -2254,7 +2254,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Update customer information",
|
||||
"parameters": [
|
||||
@@ -2340,7 +2340,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Delete customer",
|
||||
"parameters": [
|
||||
@@ -2395,7 +2395,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Activate customer",
|
||||
"parameters": [
|
||||
@@ -2450,7 +2450,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Assign companies to a customer",
|
||||
"parameters": [
|
||||
@@ -2520,7 +2520,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Remove companies from a customer",
|
||||
"parameters": [
|
||||
@@ -2590,7 +2590,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Update customer status",
|
||||
"parameters": [
|
||||
@@ -2660,7 +2660,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Suspend customer",
|
||||
"parameters": [
|
||||
@@ -2730,7 +2730,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Update customer verification status",
|
||||
"parameters": [
|
||||
@@ -2800,7 +2800,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Verify customer",
|
||||
"parameters": [
|
||||
@@ -2855,7 +2855,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Admin"
|
||||
"Admin-Customers"
|
||||
],
|
||||
"summary": "Get customer by ID with companies",
|
||||
"parameters": [
|
||||
@@ -2917,7 +2917,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Health"
|
||||
"Admin-Health"
|
||||
],
|
||||
"summary": "Health check endpoint",
|
||||
"responses": {
|
||||
@@ -2951,7 +2951,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Get authenticated user profile",
|
||||
"responses": {
|
||||
@@ -3007,7 +3007,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Update authenticated user profile",
|
||||
"parameters": [
|
||||
@@ -3088,7 +3088,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Change user password",
|
||||
"parameters": [
|
||||
@@ -3146,7 +3146,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Authorization"
|
||||
"Admin-Authorization"
|
||||
],
|
||||
"summary": "Authenticate user login",
|
||||
"parameters": [
|
||||
@@ -3227,7 +3227,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Authorization"
|
||||
"Admin-Authorization"
|
||||
],
|
||||
"summary": "Logout authenticated user",
|
||||
"responses": {
|
||||
@@ -3262,7 +3262,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Authorization"
|
||||
"Admin-Authorization"
|
||||
],
|
||||
"summary": "Refresh access token",
|
||||
"parameters": [
|
||||
@@ -3332,7 +3332,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Authorization"
|
||||
"Admin-Authorization"
|
||||
],
|
||||
"summary": "Initiate password reset process",
|
||||
"parameters": [
|
||||
@@ -3401,7 +3401,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "List users",
|
||||
"parameters": [
|
||||
@@ -3513,7 +3513,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Create new user account",
|
||||
"parameters": [
|
||||
@@ -3600,7 +3600,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Get users by company ID",
|
||||
"parameters": [
|
||||
@@ -3686,7 +3686,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Get users by role",
|
||||
"parameters": [
|
||||
@@ -3772,7 +3772,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Get user by ID",
|
||||
"parameters": [
|
||||
@@ -3849,7 +3849,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Update user",
|
||||
"parameters": [
|
||||
@@ -3935,7 +3935,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Delete user",
|
||||
"parameters": [
|
||||
@@ -4002,7 +4002,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Update user role",
|
||||
"parameters": [
|
||||
@@ -4078,7 +4078,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Users"
|
||||
"Admin-Users"
|
||||
],
|
||||
"summary": "Update user status",
|
||||
"parameters": [
|
||||
@@ -4139,7 +4139,7 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/": {
|
||||
"/api/v1/profile": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
@@ -4154,7 +4154,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Authorization"
|
||||
"Authorization"
|
||||
],
|
||||
"summary": "Get customer profile",
|
||||
"responses": {
|
||||
@@ -4197,46 +4197,6 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/logout": {
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Logout customer and invalidate access token",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Authorization"
|
||||
],
|
||||
"summary": "Customer logout",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Logout successful",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized - Invalid or missing token",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/profile/login": {
|
||||
"post": {
|
||||
"description": "Authenticate customer with username (email) and password. Returns access token, refresh token, and customer information upon successful authentication.",
|
||||
@@ -4247,7 +4207,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Authorization"
|
||||
"Authorization"
|
||||
],
|
||||
"summary": "Customer login",
|
||||
"parameters": [
|
||||
@@ -4307,6 +4267,46 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/profile/logout": {
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Logout customer and invalidate access token",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Authorization"
|
||||
],
|
||||
"summary": "Customer logout",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Logout successful",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized - Invalid or missing token",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.APIResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/profile/refresh-token": {
|
||||
"post": {
|
||||
"description": "Refresh access token using a valid refresh token. This allows customers to maintain their session without re-authentication.",
|
||||
@@ -4317,7 +4317,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Authorization"
|
||||
"Authorization"
|
||||
],
|
||||
"summary": "Refresh customer access token",
|
||||
"parameters": [
|
||||
@@ -4377,7 +4377,7 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/with-companies": {
|
||||
"/api/v1/profile/with-companies": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
@@ -4392,7 +4392,7 @@ const docTemplate = `{
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Customers-Authorization"
|
||||
"Authorization"
|
||||
],
|
||||
"summary": "Get customer profile with companies",
|
||||
"responses": {
|
||||
@@ -5223,10 +5223,6 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"company_name": {
|
||||
"description": "Company customer fields",
|
||||
"type": "string"
|
||||
},
|
||||
"contact_person": {
|
||||
"description": "Contact person (for company customers)",
|
||||
"allOf": [
|
||||
@@ -5274,6 +5270,7 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
},
|
||||
"registration_number": {
|
||||
"description": "Company customer fields",
|
||||
"type": "string"
|
||||
},
|
||||
"tax_id": {
|
||||
@@ -5928,31 +5925,27 @@ const docTemplate = `{
|
||||
"tags": [
|
||||
{
|
||||
"description": "System health check operations for monitoring application status and dependencies",
|
||||
"name": "Health"
|
||||
"name": "Admin-Health"
|
||||
},
|
||||
{
|
||||
"description": "User authentication and authorization operations including login, logout, token refresh, and password management for web panel administration",
|
||||
"name": "Authorization"
|
||||
"name": "Admin-Authorization"
|
||||
},
|
||||
{
|
||||
"description": "Administrative user management operations including CRUD operations, role management, status updates, and profile management for web panel administrators",
|
||||
"name": "Users"
|
||||
"name": "Admin-Users"
|
||||
},
|
||||
{
|
||||
"description": "Administrative customer management operations for web panel including CRUD operations, company assignment, verification, status management, and comprehensive filtering with pagination",
|
||||
"name": "Customers-Admin"
|
||||
},
|
||||
{
|
||||
"description": "Customer authentication and authorization operations for mobile application including login, logout, token refresh, and profile access",
|
||||
"name": "Customers-Authorization"
|
||||
"name": "Admin-Customers"
|
||||
},
|
||||
{
|
||||
"description": "Administrative company management operations for web panel including CRUD operations, tag management, verification, status updates, comprehensive search and filtering, and statistical reporting",
|
||||
"name": "Companies-Admin"
|
||||
"name": "Admin-Companies"
|
||||
},
|
||||
{
|
||||
"description": "Company-related operations for mobile application including company lookup, search, and basic information retrieval",
|
||||
"name": "Companies-Mobile"
|
||||
"description": "Customer authentication and authorization operations for mobile application including login, logout, token refresh, and profile access",
|
||||
"name": "Authorization"
|
||||
}
|
||||
]
|
||||
}`
|
||||
|
||||
Reference in New Issue
Block a user