[docs] Generated reference docs for ES helpers are incomplete
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- elasticsearch, typescript
- Domain
- cli, documentation
Research direction
Start with the generated ES helpers reference page and inspect how elastic cli-schema produces it. Trace why scroll-search, bulk-ingest, msearch, and watch are omitted, then regenerate the reference docs and confirm all four sub-commands appear.
Written by the indexing model from the issue text.
Description
Reference docs for ES helpers does not show the sub-commands we would expect to see: scroll-search, bulk-ingest, msearch and watch.
I presume this is due to them being generated incorrectly by elastic cli-schema.
- Dominant language
- TypeScript
- Stars
- 45
- Forks
- 26
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 67
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/cli
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
elastic/cli#707 · 1 assignee ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
A per-context command allowlist can be bypassed with `--use-context` (no way to lock an agent to its context)Possibly taken @margaretjgu claimed this today. Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
elastic/cli#700 · 1 assignee ·
Maintainers usually reply within 1 day
-
bug: malformed JSON passed to --document (and other body object flags) silently passes validationPossibly taken @margaretjgu claimed this today. Openbug
Difficulty 3/5 1-2 days Newbie friendliness 74/100
elastic/cli#699 · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Doist/todoist-cli#576 ·
Maintainers usually reply within 1 day
-
🐛 Bug supabase/cli
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
CopilotKit/aimock#491 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
agilepathway/label-checker#710 · 2 comments ·
Maintainers usually reply within 1 day