Skip to content
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.

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

Export types for the objects returned from making requests #1543

Open
1 of 9 tasks
intercepted16 opened this issue Aug 25, 2024 · 1 comment
Open
1 of 9 tasks

Export types for the objects returned from making requests #1543

intercepted16 opened this issue Aug 25, 2024 · 1 comment
Labels
auto-triage-skip discussion M-T: An issue where more input is needed to reach a decision Version: 3x web-client

Comments

@intercepted16
Copy link

The export of types of the objects returned when making requests would be incredibly useful. This would significantly enhance the developer experience by:

  • preventing incorrect key accesses
  • and other invalid operations on the type of an object or value inside the object
  • enhancing IDE intellisense
  • integration with linters and static type checkers

I guess you could implement this manually, though it would be amazing if the Slack API did this for you.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

@seratch seratch added discussion M-T: An issue where more input is needed to reach a decision web-client Version: 3x auto-triage-skip and removed untriaged labels Aug 25, 2024
@seratch
Copy link
Member

seratch commented Aug 25, 2024

Hi @intercepted16, thanks for the suggestion!

Indeed, enhancing the response data types would be greatly helpful for developers. However, the Slack API does not provide open API specs or something similar, so manually crafting response types could be challenging (considering our team capacity and priorities).

I'll keep this issue open for receiving feedback from others; however, we won't be able to take action in the foreseeable future. It'd be appreciated if you could understand this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-triage-skip discussion M-T: An issue where more input is needed to reach a decision Version: 3x web-client
Projects
None yet
Development

No branches or pull requests

2 participants