Skip to content

feat(api): add search, describe, and intelligent suggestions#1128

Open
l2ysho wants to merge 5 commits into
masterfrom
1094-improve-api-subcommand-experience
Open

feat(api): add search, describe, and intelligent suggestions#1128
l2ysho wants to merge 5 commits into
masterfrom
1094-improve-api-subcommand-experience

Conversation

@l2ysho
Copy link
Copy Markdown
Contributor

@l2ysho l2ysho commented May 7, 2026

closes #1094

l2ysho added 2 commits May 5, 2026 13:48
Adds `--search` to filter listed endpoints, `--describe` for detailed info, and intelligent 404 suggestions.
@l2ysho l2ysho linked an issue May 7, 2026 that may be closed by this pull request
@l2ysho l2ysho self-assigned this May 7, 2026
@github-actions github-actions Bot added this to the 140th sprint - Tooling team milestone May 7, 2026
@github-actions github-actions Bot added t-tooling Issues with this label are in the ownership of the tooling team. tested Temporary label used only programatically for some analytics. labels May 7, 2026
@l2ysho l2ysho marked this pull request as ready for review May 11, 2026 11:18
@l2ysho
Copy link
Copy Markdown
Contributor Author

l2ysho commented May 11, 2026

Sry guys I forgot to move this to ready to review state :| moving now

Comment thread docs/reference.md
<options: GET|POST|PUT|PATCH|DELETE>
-p, --params=<value> Query parameters as a JSON object,
e.g. '{"limit": 1, "desc": true}'.
-s, --search=<value> Filter --list-endpoints by a
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.

How about making it a little more descriptive, like:

Filter results returned by --list-endpoints. The query is case-insensitive and split into tokens by spaces. For an endpoint to be returned, every token must appear in that endpoint's method, path, or summary.

Comment thread docs/reference.md
e.g. '{"limit": 1, "desc": true}'.
-d, --body=<value> The request body (JSON string).
Use "-" to read from stdin.
--describe=<value> Describe an endpoint: print every HTTP
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.

How about this:

Print a reference for an endpoint path: its HTTP methods, summary, and path parameters. Leading slashes and a version prefix in the path are optional. For example, "actor-runs/{runId}" and "/v2/actor-runs/{runId}" are both accepted.

@patrikbraborec patrikbraborec added the t-dx Issues owned by the DX team. label May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-dx Issues owned by the DX team. t-tooling Issues with this label are in the ownership of the tooling team. tested Temporary label used only programatically for some analytics.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve API subcommand experience

4 participants