feat(api): add search, describe, and intelligent suggestions#1128
feat(api): add search, describe, and intelligent suggestions#1128l2ysho wants to merge 5 commits into
Conversation
Adds `--search` to filter listed endpoints, `--describe` for detailed info, and intelligent 404 suggestions.
|
Sry guys I forgot to move this to ready to review state :| moving now |
| <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 |
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
I tried it, it looks good. I would only fix suggestions by @szaganek. Thanks, good job!
vladfrangu
left a comment
There was a problem hiding this comment.
LGTM after the suggestions from other reviews
closes #1094