slackapi / slackapi/java-slack-sdk

Support description of mrkdwn type in OptionObject

Open
#1,471 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

auto-triage-skip enhancement
Dominant language
Java
Stars
602
Forks
232
Avg merge
4d 9h
Merged PRs (30d)
7

Description

Need to read options in a checkbox from Slack using the Java SDK. Currently, description text objects inside an option are always coerced into a PlainTextObject even if their type property is set to mrkdwn.

Category (place an x in each of the [ ])
  • bolt (Bolt for Java)
  • bolt-{sub modules} (Bolt for Java - optional modules)
  • slack-api-client (Slack API Clients)
  • slack-api-model (Slack API Data Models)
  • slack-api-*-kotlin-extension (Kotlin Extensions for Slack API Clients)
  • slack-app-backend (The primitive layer of Bolt for Java)
Requirements

Slack supports options with description text objects that use mrkdwn type. The SDK coerces them into a PlainTextObject, resulting in a lossy translation.

Consider changing the description field in the com.slack.api.model.block.composition.OptionObject to a com.slack.api.model.block.composition.TextObject so it can support either plain text or markdown.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with com.slack.api.model.block.composition.OptionObject and inspect how its description is represented and deserialized. Verify the model behavior for option descriptions whose type is mrkdwn as well as plain_text, with completion shown by preserving both forms without lossy coercion.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.