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

Update API documentation by removing obsolete customer-related fields and updating example values

Browse Source 
- Removed references to customer assignment fields such as has_customer, owner_customer_id, and customer_id from Swagger documentation to streamline API clarity.
- Updated example values for password and username in the documentation to reflect current standards.
- Enhanced overall documentation consistency by eliminating outdated parameters and ensuring accurate representation of the API structure.
This commit is contained in:
n.nakhostin
2025-08-11 18:31:50 +03:30
parent f5407abbf0
commit 318f3b7878
3 changed files with 6 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+2 -18
View File
@@ -92,12 +92,6 @@ const docTemplate = `{
"name": "is_compliant",
"in": "query"
},
{
"type": "boolean",
"description": "Filter by customer assignment status",
"name": "has_customer",
"in": "query"
},
{
"type": "array",
"description": "Filter by CPV codes",
@@ -4617,9 +4611,6 @@ const docTemplate = `{
"name": {
"type": "string"
},
"owner_customer_id": {
"type": "string"
},
"phone": {
"type": "string"
},
@@ -4679,9 +4670,6 @@ const docTemplate = `{
"format": "int64"
}
},
"companies_with_customer": {
"type": "integer"
},
"top_categories": {
"type": "array",
"items": {
@@ -4860,10 +4848,6 @@ const docTemplate = `{
"currency": {
"type": "string"
},
"customer_id": {
"description": "Customer assignment (for login credentials)",
"type": "string"
},
"description": {
"type": "string"
},
@@ -5753,12 +5737,12 @@ const docTemplate = `{
"password": {
"description": "User password",
"type": "string",
"example": "SecurePass123!"
"example": "Nima.1998"
},
"username": {
"description": "Username or email address",
"type": "string",
"example": "johnsmith"
"example": "nakhostin"
}
}
},
cmd/web/docs/swagger.json
+2 -18
View File
@@ -86,12 +86,6 @@
"name": "is_compliant",
"in": "query"
},
{
"type": "boolean",
"description": "Filter by customer assignment status",
"name": "has_customer",
"in": "query"
},
{
"type": "array",
"description": "Filter by CPV codes",
@@ -4611,9 +4605,6 @@
"name": {
"type": "string"
},
"owner_customer_id": {
"type": "string"
},
"phone": {
"type": "string"
},
@@ -4673,9 +4664,6 @@
"format": "int64"
}
},
"companies_with_customer": {
"type": "integer"
},
"top_categories": {
"type": "array",
"items": {
@@ -4854,10 +4842,6 @@
"currency": {
"type": "string"
},
"customer_id": {
"description": "Customer assignment (for login credentials)",
"type": "string"
},
"description": {
"type": "string"
},
@@ -5747,12 +5731,12 @@
"password": {
"description": "User password",
"type": "string",
"example": "SecurePass123!"
"example": "Nima.1998"
},
"username": {
"description": "Username or email address",
"type": "string",
"example": "johnsmith"
"example": "nakhostin"
}
}
},
cmd/web/docs/swagger.yaml
+2 -13
View File
@@ -114,8 +114,6 @@ definitions:
type: string
name:
type: string
owner_customer_id:
type: string
phone:
type: string
registration_number:
@@ -156,8 +154,6 @@ definitions:
format: int64
type: integer
type: object
companies_with_customer:
type: integer
top_categories:
items:
$ref: '#/definitions/company.CategoryCount'
@@ -274,9 +270,6 @@ definitions:
description: Contact information
currency:
type: string
customer_id:
description: Customer assignment (for login credentials)
type: string
description:
type: string
email:
@@ -866,11 +859,11 @@ definitions:
properties:
password:
description: User password
example: SecurePass123!
example: Nima.1998
type: string
username:
description: Username or email address
example: johnsmith
example: nakhostin
type: string
type: object
user.RefreshTokenForm:
@@ -1052,10 +1045,6 @@ paths:
in: query
name: is_compliant
type: boolean
- description: Filter by customer assignment status
in: query
name: has_customer
type: boolean
- description: Filter by CPV codes
in: query
name: cpv_codes