unioslo / unioslo/tsd-api-docs
Update documentation for data selection in survey_api
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 2
- Forks
- 7
- Avg merge
- 5m
- Merged PRs (30d)
- 1
Description
In the survey_api documentation https://github.com/unioslo/tsd-api-docs/blob/master/integration/survey-api.md , under "Key filtering", the
following is written:
""""
Only data:
?select=data
""""
This ends up returning "null". If switching data with answers, a JSON response with just the answer ("data") is returned.
I.e. switch ?select=data with ?select=answers
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 integration/survey-api.md and find the “Key filtering” section. Verify the documented select parameter against the described survey_api response, then update the example from ?select=data to ?select=answers; done means the documentation returns the answer data described in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100