Redocly/redoc

Display read-only and write-only labels when using SchemaDefinition

Open

#991 建立於 2019年7月31日

在 GitHub 查看
 (12 留言) (0 反應) (1 負責人)TypeScript (21,877 star) (2,272 fork)batch import
Type: Enhancementhelp wanted

描述

It's great to have the new SchemaDefinition! Thanks for all your hard work @nanov and @RomanHotsiy! 🙏

It would be fantastic to have it display "read-only" and "write-only" labels for relevant properties. Currently there is no way to signify that, except duplicating the information by writing it by hand in the property descriptions.

貢獻者指南

技術棧
typescriptreacthtmlcss
領域
frontenddocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of ReactUnderstanding of Redoc component structureFamiliarity with OpenAPI spec properties
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
Start by examining the SchemaDefinition component in the Redoc codebase, likely located in a file like `src/components/Schema/SchemaDefinition.tsx`. Look for how properties are rendered, and check if there are existing label patterns (e.g., 'required') that can be reused. The issue requests adding visual labels for read only and write only properties. Investigate the OpenAPI spec handling to see if 'readOnly' and 'writeOnly' fields are already accessible. Consider how to style these labels and ensure they integrate with the existing design. Check the issue comments for any prior discussion or attempts.