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.