Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(api): get subscriber preference parameter swagger value #6696

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions apps/api/src/app/subscribers/subscribers.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import {
ApiRateLimitCostEnum,
ButtonTypeEnum,
ChatProviderIdEnum,
TriggerRecipientsTypeEnum,
UserSessionData,
} from '@novu/shared';
import { MessageEntity, PreferenceLevelEnum } from '@novu/dal';
Expand Down Expand Up @@ -421,9 +420,9 @@ export class SubscribersController {
@ApiParam({
name: 'parameter',
type: String,
enum: TriggerRecipientsTypeEnum,
enum: PreferenceLevelEnum,
required: true,
description: 'the preferences level to be retrieved( Subscriber / Topic) ',
description: 'the preferences level to be retrieved (template / global) ',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the parentheses mean?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

valid values can be template or global

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: 'the preferences level to be retrieved (template / global) ',
description: 'Retrieve global or workflow level subscriber preferences',

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix this in next PR, this PR got auto merged after approval

})
@SdkGroupName('Subscribers.Preferences')
@SdkMethodName('retrieveByLevel')
Expand Down
Loading