feat(api): Add endpoints for notification channels #2030
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces API endpoints for managing user notification channels, addressing the initial scope outlined in issue #1844. The following endpoints have been added under the `/v1/users/me/` prefix, requiring user authentication: - `GET /notification-channels`: Lists all notification channels for the authenticated user. - `GET /notification-channels/{channel_id}`: Retrieves a single notification channel by its ID. - `DELETE /notification-channels/{channel_id}`: Deletes a specific notification channel. Key changes include: - Updating the OpenAPI specification to define the new endpoints. - Implementing the corresponding HTTP handlers in `backend/pkg/httpserver`. - Adding the necessary methods to the `WPTMetricsStorer` interface and its mock implementation. - Including unit tests for the new handlers to ensure correctness and error handling. This implementation lays the groundwork for future enhancements, such as creating and updating notification channels. Fixes #1844
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduces API endpoints for managing user notification channels, addressing the initial scope outlined in issue #1844.
The following endpoints have been added under the
/v1/users/me/prefix, requiring user authentication:GET /notification-channels: Lists all notification channels for the authenticated user.GET /notification-channels/{channel_id}: Retrieves a single notification channel by its ID.DELETE /notification-channels/{channel_id}: Deletes a specific notification channel.Key changes include:
backend/pkg/httpserver.WPTMetricsStorerinterface and its mock implementation.This implementation lays the groundwork for future enhancements, such as creating and updating notification channels.
Fixes #1844