Add client callback for API warning messages#913
Open
ghost wants to merge 2 commits intoslack-go:masterfrom
Open
Add client callback for API warning messages#913ghost wants to merge 2 commits intoslack-go:masterfrom
ghost wants to merge 2 commits intoslack-go:masterfrom
Conversation
added 2 commits
February 26, 2021 03:12
The Slack web api returns a "warning" property on response objects. The requests succeed, but this field will return a comma-separated list of warning codes that range from "superfluous_charset" to "method_deprecated", as well as extra messages in the .response_metadata.warnings property. This option allows applications to get notified when these warnings exist.
Member
|
@ryannjohnson-range |
Author
|
Warnings still look inaccessible if the response succeeds. The use case I'm concerned about for warnings is logging, specifically to alert me when an API I'm using is being scheduled for deprecation. It makes sense to me to have this occur at the client-level since I don't expect my application logic to fork based on warnings. |
Member
Ah,I missed this case. Thanks! |
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
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.
Dupe of #905, except that it doesn't contain all the changes to our forked master branch anymore.
Problem: There's no way to surface Slack's API warnings in application code from the library.
This PR exposes a new client
Optionthat registers a callback for every response that comes back with warning information. This suits the use case for logging/tracking warnings as they appear, without affecting the request/response interface of each endpoint. The nodejs sdk seems to take a similar approach.An easy way to test this and see warnings is to update outgoing headers to have
; charset=utf-8at the end.Relevant docs/reading: