Expose note.tags as list of strings

The tags field is currently exposed as a string field through the API. I think we should change it to be a list of strings even if the underlying ORM implementation still uses a CharField. This way, clients using the API don’t have to share a common delimiter when splitting the string into a list of strings.

If we want to change the ORM field that is used I suggest we use a JSONField, which is included in Django, has widespread database support and can be queried if that need should arise.

added discuss label

assigned to @eigenwijsje

changed the description

changed milestone to %1.0-alpha3 — Playful Platypus

added P2 label

added 1 deleted label

added To Do label

removed 1 deleted label

removed To Do label

See: https://gitlab.servus.at/aura/aura/-/wikis/Anforderungen-und-Spezifikationen/AEP05-Erweiterung-Datenmodell#letzte-erweiterungen

The changes are fine.

---

Please do not edit finalized spec anymore, as discussed in the last Team Meeting. AEP05 got shipped with alpha-2 and should not change it's Done state anymore. Please compare the Roadmap for reference. Why not describing the changes here in the ticket? It's also confusing, when we discuss changes in the tickets, while the actual implementation suggestion is mixed with other stuff somewhere else.

I'm gonna remove any additions from AEP05 now. Here is a backup of your suggestion:

Note

• Das Feld tags (TextField) wird in ein JSONField umgewandelt.

added To Do label

added Blocked label and removed To Do label

removed discuss label

added 1 deleted label

added Doing label and removed Blocked label

tag is now a JSONField and the serializer has tags.

For now, there is no validation.

removed Doing label

added Blocked label

The associated migration breaks on my system. I think it’s because it simply converts the existing tags TEXT column to JSON without doing any data migration beforehand. This fails because the old tags column contains arbitrary strings like "foo, bar, baz" that are not valid JSON.

IMHO it should:

1. rename the tags column to tags_old (migrations.RenameField)
2. add the new JSON tags column (migrations.AddField)
3. for each note: set tags to tags_old.split(',') (migrations.RunPython)
4. remove tags_old column (migrations.RemoveField)

added To Do label and removed Blocked label

I spent more time testing than actually writing the operations but this should work now.

added Blocked label and removed To Do label

added 1 deleted label and removed Blocked label

marked this issue as related to dashboard#197 (closed)

The implementation in steering is done in the develop branch and there is API: Update usage of note.tags (dashboard#197 - closed), therefore I'm closing this issue.

closed

removed 1 deleted label