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

Recommend using the files_upload_v2 method for uploading files #1402

Merged
merged 1 commit into from
Sep 16, 2023

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Sep 15, 2023

Summary

This PR updates the example in the README to recommend using files_upload_v2 for uploading files to avoid warnings raised by the current files_upload method.

Notes

Unsure if linking to the release notes for files_upload_v2 is alright (instead of API documentation) since there are multiple API methods being called now. These release notes do a great job of documenting this method though, so I think this might be helpful!

Category

  • 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

  • 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.

@zimeg zimeg added docs M-T: Documentation work only semver:patch web-client labels Sep 15, 2023
@zimeg zimeg added this to the 3.22.1 milestone Sep 15, 2023
@zimeg zimeg self-assigned this Sep 15, 2023
@codecov
Copy link

codecov bot commented Sep 15, 2023

Codecov Report

Merging #1402 (997eb3b) into main (91c22ea) will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1402      +/-   ##
==========================================
+ Coverage   85.37%   85.40%   +0.03%     
==========================================
  Files         111      111              
  Lines       11860    11860              
==========================================
+ Hits        10125    10129       +4     
+ Misses       1735     1731       -4     

see 1 file with indirect coverage changes

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

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.

Thanks! LGTM

@seratch seratch merged commit f5b39e0 into slackapi:main Sep 16, 2023
9 checks passed
@zimeg zimeg deleted the readme-files-upload-v2 branch September 16, 2023 01:57
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 semver:patch web-client
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants