slackapi/python-slack-sdk

Standardize method parameters (channel vs channel_id, user vs user_id)

Keanro opened this issue · 1 comments

Standardize the method convention across the SDK. It's somewhat annoying having to use channel for one method and then use channel_id for another.

conversations_kick uses both channel and user, whereas a lot of admin methods (such as admin_conversations_archive) use channel_id or even views_publish uses user_id.

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.

Hi @Keanro, thanks for taking the time to write in. I understand that this inconsistency is indeed frustrating, but we don't add extra argument names beyond the ones available on the API endpoint side to this API client SDK. It'd be appreciated if you could understand this.