Proposal for adding support for map notes tags

[nenad-vujicic]

Problem

Do you have some key-value meta-data you would like to store with map notes? Would you like to do it like with tags in nodes / ways / relations / changesets / .. instead of writing in description / comments? Note tags have already been mentioned / requested several times in #385 , #801 , #3932 and similar. Here we expose our plan about how we could add them.

Description

Here is a list of PRs (steps) we would like to work on with rough description of what they will do. We would highly appreciate your feedback and suggestions on how we could improve the plan:

1. Create migration script for creating note-tags table, appropriate model file and setting up associations:
   • Create new table note_tags with note_id (bigint(8)), k (string, default “”, not-null) and v (string, default(“”), not-null) attributes
   • (note_id, k) will be set as private key and note_id will be foreign key referring id attribute from note table
   • Create new model NoteTag which will model row of note_tags table and add associations between NoteTag and Note
   • Add / improve new / existing unit tests for testing new functionalities
2. Add loading and displaying note tags using browse/tag_details partial
   • Add displaying of note tags using browse/tag_details partial between Description (currently "special first comment") and Comments (remaining comments / status messages / ..)
   • Add / improve new / existing unit tests for testing new functionalities
3. Update Notes API to include retrieving note tags
   • Update (j)builder files to include note tags in generated files, by inserting <tag k="" v=""/> pairs between status and comments like in this example
   • Add / improve new / existing unit tests for testing new functionalities
4. Update Notes API to include creating Note instances with tags
   • Update API::NoteController to create Note instances with tags
   • Update new_note.js to pass created_by:OpenStreetMaps-Website tag to newly created note when created from OSM website
   • Add / improve new / existing unit tests for testing new functionalities
5. Update Wiki documentation about OSM API v0.6 section Map Notes (this will be more of a side task than a PR)

Screenshots

[simonpoole]

It isn't clear from the description if this is intended or not, but to be really useful (for example to document with which client an operation is being performed) they need to be "per interaction" so not just for the original note creation but at least for every comment, and maybe for opening and closing too.

[nenad-vujicic]

It isn't clear from the description if this is intended or not, but to be really useful (for example to document with which client an operation is being performed) they need to be "per interaction" so not just for the original note creation but at least for every comment, and maybe for opening and closing too.

At the moment, tags are added only at creation time and are per-note. For example, if created from OpenStreetMap, only pair (created_by, OpenStreetMaps-Website) will be created. If note is created from editor, editor defines number and tags which will be created.

But, it will not be hard to add tags for comments / actions (open, close, ..) .. We can add it without disrupting current implementation as next steps, if others agree.

Thanks for great idea!

[AntonKhorev]

but to be really useful they need to be "per interaction"

Do you want versioned notes with sets of tags for every version, like elements?

[simonpoole]

No, I don't think that would be an appropriate model.

Just as comments extend the conversation around the original note and do not replace it, tags associated with comments should not replace the original ones.