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",
|
"name": "is_compliant",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Filter by customer assignment status",
|
|
||||||
"name": "has_customer",
|
|
||||||
"in": "query"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"description": "Filter by CPV codes",
|
"description": "Filter by CPV codes",
|
||||||
@@ -4617,9 +4611,6 @@ const docTemplate = `{
|
|||||||
"name": {
|
"name": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"owner_customer_id": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"phone": {
|
"phone": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
@@ -4679,9 +4670,6 @@ const docTemplate = `{
|
|||||||
"format": "int64"
|
"format": "int64"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"companies_with_customer": {
|
|
||||||
"type": "integer"
|
|
||||||
},
|
|
||||||
"top_categories": {
|
"top_categories": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@@ -4860,10 +4848,6 @@ const docTemplate = `{
|
|||||||
"currency": {
|
"currency": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"customer_id": {
|
|
||||||
"description": "Customer assignment (for login credentials)",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": {
|
"description": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
@@ -5753,12 +5737,12 @@ const docTemplate = `{
|
|||||||
"password": {
|
"password": {
|
||||||
"description": "User password",
|
"description": "User password",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"example": "SecurePass123!"
|
"example": "Nima.1998"
|
||||||
},
|
},
|
||||||
"username": {
|
"username": {
|
||||||
"description": "Username or email address",
|
"description": "Username or email address",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"example": "johnsmith"
|
"example": "nakhostin"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -86,12 +86,6 @@
|
|||||||
"name": "is_compliant",
|
"name": "is_compliant",
|
||||||
"in": "query"
|
"in": "query"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Filter by customer assignment status",
|
|
||||||
"name": "has_customer",
|
|
||||||
"in": "query"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"description": "Filter by CPV codes",
|
"description": "Filter by CPV codes",
|
||||||
@@ -4611,9 +4605,6 @@
|
|||||||
"name": {
|
"name": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"owner_customer_id": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"phone": {
|
"phone": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
@@ -4673,9 +4664,6 @@
|
|||||||
"format": "int64"
|
"format": "int64"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"companies_with_customer": {
|
|
||||||
"type": "integer"
|
|
||||||
},
|
|
||||||
"top_categories": {
|
"top_categories": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@@ -4854,10 +4842,6 @@
|
|||||||
"currency": {
|
"currency": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"customer_id": {
|
|
||||||
"description": "Customer assignment (for login credentials)",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": {
|
"description": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
@@ -5747,12 +5731,12 @@
|
|||||||
"password": {
|
"password": {
|
||||||
"description": "User password",
|
"description": "User password",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"example": "SecurePass123!"
|
"example": "Nima.1998"
|
||||||
},
|
},
|
||||||
"username": {
|
"username": {
|
||||||
"description": "Username or email address",
|
"description": "Username or email address",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"example": "johnsmith"
|
"example": "nakhostin"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -114,8 +114,6 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
owner_customer_id:
|
|
||||||
type: string
|
|
||||||
phone:
|
phone:
|
||||||
type: string
|
type: string
|
||||||
registration_number:
|
registration_number:
|
||||||
@@ -156,8 +154,6 @@ definitions:
|
|||||||
format: int64
|
format: int64
|
||||||
type: integer
|
type: integer
|
||||||
type: object
|
type: object
|
||||||
companies_with_customer:
|
|
||||||
type: integer
|
|
||||||
top_categories:
|
top_categories:
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/company.CategoryCount'
|
$ref: '#/definitions/company.CategoryCount'
|
||||||
@@ -274,9 +270,6 @@ definitions:
|
|||||||
description: Contact information
|
description: Contact information
|
||||||
currency:
|
currency:
|
||||||
type: string
|
type: string
|
||||||
customer_id:
|
|
||||||
description: Customer assignment (for login credentials)
|
|
||||||
type: string
|
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
email:
|
email:
|
||||||
@@ -866,11 +859,11 @@ definitions:
|
|||||||
properties:
|
properties:
|
||||||
password:
|
password:
|
||||||
description: User password
|
description: User password
|
||||||
example: SecurePass123!
|
example: Nima.1998
|
||||||
type: string
|
type: string
|
||||||
username:
|
username:
|
||||||
description: Username or email address
|
description: Username or email address
|
||||||
example: johnsmith
|
example: nakhostin
|
||||||
type: string
|
type: string
|
||||||
type: object
|
type: object
|
||||||
user.RefreshTokenForm:
|
user.RefreshTokenForm:
|
||||||
@@ -1052,10 +1045,6 @@ paths:
|
|||||||
in: query
|
in: query
|
||||||
name: is_compliant
|
name: is_compliant
|
||||||
type: boolean
|
type: boolean
|
||||||
- description: Filter by customer assignment status
|
|
||||||
in: query
|
|
||||||
name: has_customer
|
|
||||||
type: boolean
|
|
||||||
- description: Filter by CPV codes
|
- description: Filter by CPV codes
|
||||||
in: query
|
in: query
|
||||||
name: cpv_codes
|
name: cpv_codes
|
||||||
|
|||||||
Reference in New Issue
Block a user