nextcloud / nextcloud/lookup-server
Fully document the API
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 25
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
While there is some documentation regarding the endpoints exposed by the API here, I think that it lacks some relevant information:
/statusendpoint is not documented. Are there other non documented endpoints?- the meaning of each field in the JSON files and whether they are compulsory is not documented
- an example call with a widespread client (like
curl) would make it easier for the reader to use the API
Contributor 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.
Research direction
Start with the REST section of doc/architecture.md and inspect the API's exposed endpoints, including /status. Document each endpoint, explain every JSON field and whether it is required, and add a curl example; done means the API documentation covers the reported gaps and any other exposed endpoints found.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100