avo-hq/avo

Key Value schema

Open

#3,884 建立於 2025年5月26日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Ruby (1,778 star) (308 fork)user submission
EnhancementFieldHelp wantedStale exempt

描述

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).

貢獻者指南

技術棧
rubyrails
領域
backendfull stack
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Familiarity with Avo field typesRuby on RailsBasic understanding of key value data
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
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.