feat: Add --category flag to docs search command#603
Open
lukegalbraithrussell wants to merge 1 commit into
Open
feat: Add --category flag to docs search command#603lukegalbraithrussell wants to merge 1 commit into
lukegalbraithrussell wants to merge 1 commit into
Conversation
Add a --category flag to `slack docs search` so results can be filtered by category, matching the filters offered by the docs site search modal: guides, reference, changelog, python, javascript, java, slack_cli, slack_github_action, deno_slack_sdk. - internal/api: thread category through DocsSearch, the DocsClient interface, the URL builder (appends &category= when set), and the mock. Add DocsSearchCategories as the shared source of valid values. - cmd/docs: add the --category flag, validate it against DocsSearchCategories (like --output), and pass it to the API for text and json output. For browser output, append &filter= to the search page URL for parity with the site. An empty category preserves the existing search-everything behavior. Docs reference regeneration (slack docgen) happens at release, not here. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #603 +/- ##
==========================================
+ Coverage 71.64% 71.67% +0.03%
==========================================
Files 226 226
Lines 19176 19191 +15
==========================================
+ Hits 13739 13756 +17
- Misses 4222 4223 +1
+ Partials 1215 1212 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
What
Adds a
--categoryflag toslack docs searchso results can be filtered by category:The docs site search modal lets you filter by category (Guides, Reference, Changelog, the SDK/library docs, etc.), and the
/api/v1/searchendpoint the CLI calls now supports acategoryparam (see slackapi/docs#634). This brings the CLI to parity with both.Categories
The 9 valid categories match the docs search endpoint / site modal:
guides,reference,changelog,python,javascript,java,slack_cli,slack_github_action,deno_slack_sdkChanges
internal/api/docs.go— threadcategorythroughDocsSearch, theDocsClientinterface, andbuildDocsSearchURL(appends&category=only when set). AddedDocsSearchCategoriesas the single source of truth for valid values.internal/api/api_mock.go— updated mock signature.cmd/docs/search.go— added the--categoryflag, validated againstDocsSearchCategories(same pattern as--output), passed to the API fortext/jsonoutput. Forbrowseroutput, appends&filter=<category>to the search page URL so the opened page matches.An empty
--category(the default) preserves the current search-everything behavior, so this is backward-compatible.Note
The generated command reference (
docs/reference/commands/slack_docs_search.md) is intentionally not included —slack docgenruns at release time, not per-PR.🤖 Generated with Claude Code