Redocly / Redocly/redoc

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

Open
#991 12 comments 0 reactions 1 assignee View on GitHub

@RomanHotsiy is already working on this.

Since Apr 6, 2020.

help wanted Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.