Change the SendTestMessage API to be a POST call #506
Merged
Conversation
This file contains 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
Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
…major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
qreshi
force-pushed
the
test-message-to-post
branch
from
f7d30f3
to
176ff1b
Compare
lezzago
reviewed
Sep 6, 2022
...tions/src/main/kotlin/org/opensearch/notifications/resthandler/SendTestMessageRestHandler.kt
Show resolved
Hide resolved
Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
lezzago
approved these changes
Sep 6, 2022
rishabhmaurya
approved these changes
Sep 6, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971)
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971)
This was referenced Sep 7, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971)
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971)
qreshi
added a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971) Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
qreshi
added a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971) Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
qreshi
added a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971) Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
qreshi
added a commit
that referenced
this pull request
Sep 7, 2022
* Change the SendTestMessage API to be a POST call Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Include GET send test message path as a depricated option until next major version Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update documentation comment for SendTestMessage replaced route Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> (cherry picked from commit 1017971) Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Mohammad Qureshi 47198598+qreshi@users.noreply.github.com
Description
The SendTestMessage API (
/_plugins/_notifications/feature/test) can potentially invoke POST webhook HTTP calls and from the user's perspective even if it is a test message this can be considered a mutating operation (messages accumulating at some destination that the webhook publishes to). As such, it seems more fitting to change the SendTestMessage API to be a POST call to adhere to HTTP best practices.The GET API path will still be available until the next major version but will be considered deprecated now. The frontend routes for the Notifications Dashboards plugin will be using the POST method though.
Issues Resolved
[List any issues this PR will resolve]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.