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

Fix base url according to official documentation #1485

Merged
merged 2 commits into from
Jun 10, 2024

Conversation

AyumuKasuga
Copy link
Contributor

@AyumuKasuga AyumuKasuga commented Mar 13, 2024

Summary

In the official documentation there is only mention of the slack.com domain (not www.slack.com), for example here or here. I think we should have the same domain in the sdk as well for the consistency.

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.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

Copy link

Thanks for the contribution! Before we can merge this, we need @AyumuKasuga to sign the Salesforce Inc. Contributor License Agreement.

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @AyumuKasuga thanks for the contribution 💯

It does appear like our other SDKs also use https://slack.com/api/

  • here in the node sdk
  • I could not find a reference to www.slack.com in the java client

@seratch let me know if you have any idea why www. was used here

@seratch
Copy link
Member

seratch commented Mar 14, 2024

Thanks for the suggestion! Indeed, this can be consistent across the SDKs.

I am fine to have this change too, but I would like to hold off merging it until the timing we release a new "minor" version, not a patch one. Some existing users may have proxy rules etc. that relies on www. domain URL. Having this type of change in a patch version coul be a surprising behavior change.

Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.09%. Comparing base (5f941f4) to head (e98fa83).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1485   +/-   ##
=======================================
  Coverage   85.08%   85.09%           
=======================================
  Files         112      112           
  Lines       12320    12320           
=======================================
+ Hits        10483    10484    +1     
+ Misses       1837     1836    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@WilliamBergamin WilliamBergamin merged commit abdfc87 into slackapi:main Jun 10, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants