feat(block-kit): add composition object examples - #228
Draft
zimeg wants to merge 12 commits into
Draft
Conversation
Add example projects for the Block Kit composition objects documented on docs.slack.dev, each demonstrating the full reference payload for its object hosted inside a valid block, element, or view. Every example ships a test that asserts the complete serialized JSON. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Rewrite each existing example test's `expected` reference payload so every nested dict is exploded one key:value per line with a magic trailing comma, mirroring the docs' vertical layout and keeping ruff format from re-collapsing short dicts. Values stay native `dict`/`list` literals and the `json.dumps(..., sort_keys=True)` comparison is unchanged. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Renames the composition-object example directory from composition_objects/ (compositionobjects/ in Java) to compositions/, matching the shorter path. Directory + all references (test imports, README impl links, Java package declarations) updated together via git mv so history is preserved. Canonical docs.slack.dev/reference/block-kit/composition-objects/ URLs are left untouched (hyphenated, never the underscore token) — only local relative implementation-link paths changed. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…sition index Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…rose Match "a section block containing a text object" from the text-object reference page. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…aining' phrasing Drop 'hosting'/divergent wording; unify all langs on 'An image block containing a Slack file object referenced by url/id.' Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…image example Duplicate the canonical 'An image block using slack_file with a url/id.' phrasing rather than diverging — the composition example demonstrates the same payload as blocks/image, so the wording matches by design. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Match "a static select menu containing the option group object" from the option-group-object reference page; drop 'hosted'/divergent per-lang wording. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Use "A static select menu element with several option objects." (from the option-object reference page); drop 'hosted'/divergent per-lang wording. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The split-attribute restyle of test_plan/test_rich_text/test_table/ test_task_card (from f6ab6df) is out of scope for the composition-objects examples PR — those blocks tests were already merged (#4, #35, #100). Move the restyle to its own PR so this one is scoped to compositions/ + README. ruff accepts both the compact (main) and split forms, so CI stays green. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…amples # Conflicts: # block-kit/README.md
Match the Python secondary descriptions for confirmation_dialog, conversation_filter, dispatch_action_configuration, trigger, and workflow to the wording already used in the JS (standard) and Java example repos, so the same payload reads identically across languages. Python was the outlier using a different "...whose X does Y" phrasing; JS/Java use "...with an X carrying a Y". trigger/workflow have no JS counterpart, so they follow Java. Verified each description against the payload it builds (e.g. the dispatch input is multiline; the trigger carries customizable_input_parameters). Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds example projects for the Block Kit composition objects documented at docs.slack.dev. Composition objects never appear on their own, so each example reproduces the object's full reference payload hosted inside a valid block, element, or view — exactly as the docs page shows it. Every example ships a test asserting the complete serialized JSON.
Mirrors the conventions of the block element examples PR (#227): one
exampleNN()per docs reference payload undersrc/composition_objects/, matched by a test undertests/composition_objects/comparingto_dict()against the complete expected object.Coverage
slack_iconis documented but has no standalone reference payload (it is a sub-object of the card block, which the SDK does not yet expose), so it is not exemplified here.Checks
Run from
block-kit/, matching thepytest@python3.14CI job:ruff check— passedruff format --diff --check— passed (57 files)mypy .— passed (56 source files)pytest— 45 passed