Skip to content

Fix #1218 - Reduce minimum number of overflow options#1219

Merged
seratch merged 1 commit intoslackapi:mainfrom
misscoded:1218-overflow-options
May 25, 2022
Merged

Fix #1218 - Reduce minimum number of overflow options#1219
seratch merged 1 commit intoslackapi:mainfrom
misscoded:1218-overflow-options

Conversation

@misscoded
Copy link
Copy Markdown
Contributor

@misscoded misscoded commented May 25, 2022

Summary

Fixes #1218.

Though API documentation says a minimum of two options are required for the overflow menu, one is acceptable and works without issue. This PR updates the SDK's minimum number to match that.

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.

@misscoded misscoded added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented semver:patch labels May 25, 2022
@misscoded misscoded requested a review from seratch May 25, 2022 19:12
Maximum length for this field is 255 characters.
options (required): An array of option objects to display in the menu.
Maximum number of options is 5, minimum is 2.
Maximum number of options is 5, minimum is 1.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@seratch I ran both of the documentation steps and it resulted in a ton of changes. Happy to include those here, but wanted to be sure before I pushed them all up.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@misscoded Thanks for checking that! More fixes would be appreciated 👍

@misscoded misscoded self-assigned this May 25, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented May 25, 2022

Codecov Report

Merging #1219 (acf9789) into main (6d410da) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1219   +/-   ##
=======================================
  Coverage   86.58%   86.58%           
=======================================
  Files         111      111           
  Lines       10943    10943           
=======================================
  Hits         9475     9475           
  Misses       1468     1468           
Impacted Files Coverage Δ
slack_sdk/models/blocks/block_elements.py 92.87% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d410da...acf9789. Read the comment docs.

@seratch seratch added this to the 3.16.3 milestone May 25, 2022
@seratch
Copy link
Copy Markdown
Contributor

seratch commented May 25, 2022

Thanks for fixing this issue! Let me merge this one as the first step now.

@seratch seratch merged commit 830b517 into slackapi:main May 25, 2022
@seratch seratch modified the milestones: 3.16.3, 3.17.0 May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented semver:patch Version: 3x web-client

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SlackObjectFormationError: options attribute must have between 2 and 5 items whereas API allows a single option

2 participants