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

Update RTM docs #1290

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Update RTM docs #1290

merged 1 commit into from
Oct 31, 2022

Conversation

ryan-aldaz
Copy link
Contributor

@ryan-aldaz ryan-aldaz commented Oct 28, 2022

Summary

Fix #1145

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.

@CLAassistant
Copy link

CLAassistant commented Oct 28, 2022

CLA assistant check
All committers have signed the CLA.

@srajiang srajiang changed the title Fix issue 1145 Update RTM docs Oct 28, 2022
@srajiang srajiang added the docs M-T: Documentation work only label Oct 28, 2022
@srajiang
Copy link
Member

@ryan-aldaz - Woot, thanks for the contribution Ryan! Mind signing the CLA?

@srajiang srajiang self-requested a review October 28, 2022 22:21
@srajiang srajiang added this to the 3.20.0 milestone Oct 28, 2022
@srajiang srajiang requested a review from seratch October 28, 2022 22:26
@codecov
Copy link

codecov bot commented Oct 28, 2022

Codecov Report

Merging #1290 (e258db2) into main (2f926a6) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head e258db2 differs from pull request most recent head 180a0e1. Consider uploading reports for the commit 180a0e1 to get more accurate results

@@            Coverage Diff             @@
##             main    #1290      +/-   ##
==========================================
- Coverage   85.63%   85.62%   -0.02%     
==========================================
  Files          84       84              
  Lines        7827     7827              
==========================================
- Hits         6703     6702       -1     
- Misses       1124     1125       +1     
Impacted Files Coverage Δ
slack_sdk/socket_mode/builtin/internals.py 72.10% <0.00%> (-0.43%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

thread_ts=thread_ts
)
.. parsed-literal ::
**rtm.start method deprecation after Nov 30th, 2021.** see details `here <https://api.slack.com/changelog/2021-10-rtm-start-to-stop>`_
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**rtm.start method deprecation after Nov 30th, 2021.** see details `here <https://api.slack.com/changelog/2021-10-rtm-start-to-stop>`_
**rtm.start method has been deprecated for apps created after Nov 30th, 2021.** see details `here <https://api.slack.com/changelog/2021-10-rtm-start-to-stop>`_

Copy link
Contributor Author

Choose a reason for hiding this comment

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

isn't it fully deprecated?

Copy link
Member

Choose a reason for hiding this comment

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

The announcement has this caveat:

For apps created before November 30, 2021, making API calls to https://slack.com/api/rtm.start will still technically succeed and return successful, but highly truncated responses even after September 27, 2022.

Seems like newly created apps after the date must use rtm.connect, and older apps will receive responses from rtm.start that are identical to rtm.connect. Is that your reading as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ahh i see Thank you!
I signed the CLA

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Thank you very much for improving this document!

@seratch seratch merged commit 54f05e6 into slackapi:main Oct 31, 2022
@seratch seratch modified the milestones: 3.20.0, 3.19.3 Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update RTM docs to reflect rtm.start deprecation for certain apps
4 participants