questdb / questdb/documentation
Minor typo in documentation (QuestDB REST API example)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 44
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 26
Description
To reproduce
- Go to the QuestDB REST API documentation.
- Scroll down to the curl example section.
- You’ll see a typo — "form" instead of "from" in the SQL query.
QuestDB version:
7.3.5
OS, in case of Docker specify Docker and the Host OS:
Windows 10
File System, in case of Docker specify Host File System:
NTFS
Full Name:
ANUBHAV GANHWAR
Affiliation:
Student / Independent Contributor
Have you followed Linux, MacOs kernel configuration steps to increase Maximum open files and Maximum virtual memory areas limit?
- Yes, I have
Additional context
Hi QuestDB team 👋
While checking the REST API documentation, I found a small typo in the example query.
The docs currently show:
curl -G "http://localhost:9000/exec?query=select * form trades"
But it should be:
curl -G "http://localhost:9000/exec?query=select * from trades"
This small correction will help new users avoid confusion while testing the API.
Thanks for maintaining such an awesome project!
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Open the QuestDB REST API documentation and find the curl example section containing the SQL query. Correct the typo in the query, changing "form" to "from", then verify that the rendered example shows the corrected command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100