avo-hq/avo

Key Value schema

Open

#3.884 geöffnet am 26. Mai 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Ruby (1.778 Stars) (308 Forks)user submission
EnhancementFieldHelp wantedStale exempt

Beschreibung

Feature

It would be nice to have some kind of schema or guidance for the key value. For example, if the record is a request and the field is field :headers, as: :key_value, it would be nice to specify that a few common keys might be Content-Type and maybe (second iteration) the value is application/json.

A few thoughts. The schema should probably be optional, meaning that when you save the record, it shouldn't be applied automatically. So for our example, if the user doesn't fill it in, the field value should not be {"Content-Type": ""}, so it should be suggested in the UI.

Current workarounds

Add a help option or maybe a default (but that would be a bit intrusive).

Contributor Guide

Tech Stack
rubyrails
Domain
backendfull stack
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Familiarity with Avo field typesRuby on RailsBasic understanding of key value data
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35
Research-Richtung
Investigate the current key value field implementation in Avo, likely in app/fields or lib/avo/fields. Review how other fields implement schemas or validation. Propose an optional schema that suggests common keys like 'Content Type' in the UI, without enforcing upon save. Consider adding a 'help' or 'default' option as a workaround, but aim for a dedicated schema attribute. Check for any existing discussions or PRs related to field schemas.