Skip to content

chore: generate web-api and types docs for ai apps#2392

Merged
lukegalbraithrussell merged 4 commits intoai-appsfrom
gen-docs-ai-apps
Oct 3, 2025
Merged

chore: generate web-api and types docs for ai apps#2392
lukegalbraithrussell merged 4 commits intoai-appsfrom
gen-docs-ai-apps

Conversation

@lukegalbraithrussell
Copy link
Copy Markdown
Contributor

Summary

see above

Requirements (place an x in each [ ])

@zimeg zimeg changed the base branch from main to ai-apps October 3, 2025 02:11
@zimeg zimeg added docs M-T: Documentation work only semver:patch pkg:web-api applies to `@slack/web-api` pkg:types applies to `@slack/types` labels Oct 3, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (ai-apps@b585b41). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             ai-apps    #2392   +/-   ##
==========================================
  Coverage           ?   93.01%           
==========================================
  Files              ?       40           
  Lines              ?    11112           
  Branches           ?      713           
==========================================
  Hits               ?    10336           
  Misses             ?      764           
  Partials           ?       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (?)
cli-test 94.80% <ø> (?)
oauth 77.39% <ø> (?)
socket-mode 61.87% <ø> (?)
web-api 98.07% <ø> (?)
webhook 96.66% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

@lukegalbraithrussell LGTM! We should look into autogernating this in CI and requiring it alongside PR changes to avoid confusion in later PRs IMHO 🤖

For now this is so appreciated following #2391 🚢 💨

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

@lukegalbraithrussell Double LGTM for good luck! 🍀

#### Description

The "chatStream" method starts a new chat stream in a coversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as "blocks" for gathering feedback.
The "chatStream" method starts a new chat stream in a conversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as "blocks" for gathering feedback.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👁️‍🗨️ note: I fear this change might also be needed in the Python implementation... Will check!

@lukegalbraithrussell lukegalbraithrussell merged commit 95a5258 into ai-apps Oct 3, 2025
57 checks passed
@lukegalbraithrussell lukegalbraithrussell deleted the gen-docs-ai-apps branch October 3, 2025 02:30
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 pkg:types applies to `@slack/types` pkg:web-api applies to `@slack/web-api` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants