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

Extend contribution type information within docs #134

Closed
FabiKo117 opened this issue Feb 18, 2021 · 2 comments · Fixed by #147
Closed

Extend contribution type information within docs #134

FabiKo117 opened this issue Feb 18, 2021 · 2 comments · Fixed by #147
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@FabiKo117
Copy link
Contributor

Out of a recent discussion with @Zia- we found out that the descriptions regarding the contribution type within our docs are a bit insufficient. Here is an example explanation about valuable info that is partially missing:

a) if a new feature gets created OR moved into your requested area of interest OR is now fitting to your defined filter parameter it should have the "@creation":"true" parameter
b) if a feature gets deleted OR moved outside of your requested area of interest OR is not fitting anymore to your defined filter parameter it should have the "@deletion":"true" parameter
c) if the geometry of a feature is modified, it gets the "@geometryChange":"true" parameter

@FabiKo117 FabiKo117 added the documentation Improvements or additions to documentation label Feb 18, 2021
@FabiKo117 FabiKo117 added this to the 1.4 milestone Feb 18, 2021
@FabiKo117
Copy link
Contributor Author

Additional info regarding geometry changes:

a geometryChange for on osm-way can happen when

  • a certain tag changed (e.g. highway=yes to building=yes)
  • the order or member get deleted/added
  • a member (node) moved/deleted

for an osm-relation geometry change can happen when

  • a certain tag changed
  • the order of the members (also del/add)
  • a member geometry changed, see osme-way geometry change

@tyrasd
Copy link
Member

tyrasd commented Feb 18, 2021

I could imagine that the additional info regarding geometry changes could be confusing if a user isn't super proficient about the OSM data modes. Also, for example, the order of members is not actually what determines if a contribution is a geometry change or not. When, for example an outer way member of a multipolygon relation is split into two parts, but otherwise left unchanged including its node coordinates, there would be a change of the member list of the multipolygon relation (i.e. an addition of a new outer way and a member geometry changed), but (the OSHDB and) the ohsome API would not report this as a contribution with "@geometryChange" : true, since the geometry of the resulting (multi)polygon feature stayed the same during this operation.

c) if the geometry of a feature is modified, it gets the "@geometryChange":"true" parameter

IMHO, think this definition is short, comprehensive and sufficient.

@FabiKo117 FabiKo117 self-assigned this Mar 5, 2021
FabiKo117 added a commit that referenced this issue Mar 8, 2021
FabiKo117 added a commit that referenced this issue Mar 9, 2021
to better explain the usage and meaning of the contribution types contained in the JSON response
fixes #134
Co-authored-by: Martin Raifer <[email protected]>
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