Enhance API Documentation for Notification Target Audience

- Added "target" field reference to the notification request and response structures in Swagger documentation, improving clarity for API consumers.
- Introduced "notification.TargetAudienceType" definition with enumerated values for target audience options, enhancing the API's usability and understanding.
- Updated related documentation files (YAML and JSON) to reflect these changes, ensuring consistency across all API documentation formats.
This commit is contained in:
n.nakhostin
2025-09-17 16:05:33 +03:30
parent a06dc5097e
commit 00ad7e136d
4 changed files with 83 additions and 1 deletions
+29
View File
@@ -7426,6 +7426,9 @@
"schedule": {
"$ref": "#/definitions/notification.ScheduleRequest"
},
"target": {
"$ref": "#/definitions/notification.TargetAudienceType"
},
"tender": {
"type": "string"
},
@@ -7461,6 +7464,9 @@
"schedule": {
"$ref": "#/definitions/notification.ScheduleResponse"
},
"target": {
"$ref": "#/definitions/notification.TargetAudienceType"
},
"tender": {
"type": "string"
},
@@ -7538,6 +7544,29 @@
}
}
},
"notification.TargetAudienceType": {
"type": "string",
"enum": [
"all_users",
"specific_users",
"all_role",
"specific_role",
"all_companies",
"specific_company",
"all_customers",
"specific_customer"
],
"x-enum-varnames": [
"TargetAudienceAllUsers",
"TargetAudienceSpecificUsers",
"TargetAudienceAllRole",
"TargetAudienceSpecificRole",
"TargetAudienceAllCompanies",
"TargetAudienceSpecificCompany",
"TargetAudienceAllCustomers",
"TargetAudienceSpecificCustomer"
]
},
"response.APIError": {
"type": "object",
"properties": {