avo-hq/avo

Key Value schema

Open

#3,884 opened on May 26, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (1,778 stars) (308 forks)user submission
EnhancementFieldHelp wantedStale exempt

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Avo field typesRuby on RailsBasic understanding of key value data
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
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.
Key Value schema · avo-hq/avo#3884 | Good First Issue