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

Enhance API Documentation for Notification Target Audience

Browse Source 
- 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
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+29
View File
@@ -7432,6 +7432,9 @@ const docTemplate = `{
"schedule": {
"$ref": "#/definitions/notification.ScheduleRequest"
},
"target": {
"$ref": "#/definitions/notification.TargetAudienceType"
},
"tender": {
"type": "string"
},
@@ -7467,6 +7470,9 @@ const docTemplate = `{
"schedule": {
"$ref": "#/definitions/notification.ScheduleResponse"
},
"target": {
"$ref": "#/definitions/notification.TargetAudienceType"
},
"tender": {
"type": "string"
},
@@ -7544,6 +7550,29 @@ const docTemplate = `{
}
}
},
"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": {
cmd/web/docs/swagger.json
+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": {
cmd/web/docs/swagger.yaml
+24
View File
@@ -666,6 +666,8 @@ definitions:
type: array
schedule:
$ref: '#/definitions/notification.ScheduleRequest'
target:
$ref: '#/definitions/notification.TargetAudienceType'
tender:
type: string
title:
@@ -689,6 +691,8 @@ definitions:
$ref: '#/definitions/notification.NotificationPriority'
schedule:
$ref: '#/definitions/notification.ScheduleResponse'
target:
$ref: '#/definitions/notification.TargetAudienceType'
tender:
type: string
title:
@@ -743,6 +747,26 @@ definitions:
time:
type: integer
type: object
notification.TargetAudienceType:
enum:
- all_users
- specific_users
- all_role
- specific_role
- all_companies
- specific_company
- all_customers
- specific_customer
type: string
x-enum-varnames:
- TargetAudienceAllUsers
- TargetAudienceSpecificUsers
- TargetAudienceAllRole
- TargetAudienceSpecificRole
- TargetAudienceAllCompanies
- TargetAudienceSpecificCompany
- TargetAudienceAllCustomers
- TargetAudienceSpecificCustomer
response.APIError:
properties:
code: