Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancing docs with description on parameters returned in the response #58

Closed
FabiKo117 opened this issue Oct 8, 2020 · 0 comments · Fixed by #34
Closed

Enhancing docs with description on parameters returned in the response #58

FabiKo117 opened this issue Oct 8, 2020 · 0 comments · Fixed by #34
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@FabiKo117
Copy link
Contributor

What is missing in the docs is a list of which parameters are to expect to be included in the response and a short explanation of them. This particularly applies to the data-extraction endpoints, where we return information about the time of validity (@validfrom and @validto), the id of the OSM feature in the format of -osmType-/-id-, or for the new /contributions endpoint the information on the type of the contribution (@tagChange, @geometryChange, etc.).

We should also add the info on which parameters are to expect for which request parameters, e.g.:
Which reponse parameters are included when I set properties=metadata in the request?

@FabiKo117 FabiKo117 added the documentation Improvements or additions to documentation label Oct 8, 2020
@bonaparten bonaparten self-assigned this Oct 27, 2020
@bonaparten bonaparten linked a pull request Oct 27, 2020 that will close this issue
4 tasks
bonaparten pushed a commit that referenced this issue Oct 27, 2020
adding http response status codes, solves #64
FabiKo117 pushed a commit that referenced this issue Nov 2, 2020
adding http response status codes, solves #64
FabiKo117 pushed a commit that referenced this issue Nov 4, 2020
adding http response status codes, solves #64
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants