Skip to content

docs(api): correct description for /credentials endpoints #8659

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

docs(api): correct description for /credentials endpoints #8659

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions apps/api/src/app/subscribers/subscribersV1.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,9 @@ export class SubscribersV1Controller {
@RequireAuthentication()
@ApiResponse(SubscriberResponseDto)
@ApiOperation({
summary: 'Update provider credentials',
description: `Update credentials for a provider such as slack and push tokens.
**providerId** is required field. This API replaces the existing deviceTokens with the provided ones.`,
summary: 'Upsert provider credentials',
description: `Upsert credentials for a provider such as slack and push tokens.
**providerId** is required field. This API creates **deviceTokens** or replaces the existing with the provided ones.`,
})
@SdkGroupName('Subscribers.Credentials')
async updateSubscriberChannel(
Expand All @@ -323,9 +323,9 @@ export class SubscribersV1Controller {
@RequireAuthentication()
@ApiResponse(SubscriberResponseDto)
@ApiOperation({
summary: 'Upsert provider credentials',
description: `Update credentials for a provider such as **slack** and **FCM**.
**providerId** is required field. This API appends the **deviceTokens** to the existing ones.`,
summary: 'Create or Partially Update provider credentials',
description: `Create or Partially credentials for a provider such as **slack** and **FCM**.
**providerId** is required field. This API creates the **deviceTokens** or appends to the existing ones.`,
})
@SdkGroupName('Subscribers.Credentials')
@SdkMethodName('append')
Expand Down
Loading