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:
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user