infiniflow / infiniflow/ragflow
[Question]: The API documentation lacks parameter annotations, making it nearly inconvenient to call the backend API interfaces.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 91k
- Forks
- 10.8k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 705
Description
### Self Checks
- [x] I have searched for existing issues [search for existing issues](https://github.com/infiniflow/ragflow/issues), including closed ones.
- [x] I confirm that I am using English to submit this report ([Language Policy](https://github.com/infiniflow/ragflow/issues/5910)).
- [x] Non-english title submitions will be closed directly ( 非英文标题的提交将会被直接关闭 ) ([Language Policy](https://github.com/infiniflow/ragflow/issues/5910)).
- [x] Please do not modify this template :) and fill in all the required fields.
### Describe your problem
The API documentation lacks parameter annotations, making it nearly inconvenient to call the backend API interfaces.
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
Start by reviewing the backend API documentation and the interfaces it describes, focusing on where parameter annotations are missing. Identify the affected endpoints and confirm the expected annotation format before updating the documentation; done means callers can understand each endpoint's parameters without needing to inspect unrelated code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100