Skip to content

Make Web API response headers accessible #378

@jmanian

Description

@jmanian

The response headers in Slack's Web API contain information that is sometimes useful. For example x-oauth-scopes is a list of scopes that the token has. This is the only way (that I know of) to check the scopes on an existing token through the API. My use case is I'd like to be able to use auth.test to check the scopes on a token via x-oauth-scopes.

The current implementation doesn't give a way to access the response headers on a successful request, since it returns only the body:

The headers are accessible on the error object raised on failed requests since the entire response object is on the error:

slack_error.response.headers

I'm trying to think how we could make the headers accessible on successful responses. Some bad ideas:

  1. Shove them into the body object under the key response_headers. This object is then wrapped in Slack::Messages::Message and returned. I don't like this because it pollutes the body.
  2. An option that can be passed to any request (possibly also set on a client) that causes it to return something different:
    1. The entire raw response object, giving access to the body as well as the headers (and much else).
    2. [body, response_headers]
    3. etc.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions