Update API documentation by removing obsolete customer-related fields and updating example values
- 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:
+2
-18
@@ -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"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user