redoc icon indicating copy to clipboard operation
redoc copied to clipboard

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

Open cmeeren opened this issue 6 years ago • 12 comments
trafficstars

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.

cmeeren avatar Jul 31 '19 07:07 cmeeren

I'm no JS dev, but might this be so simple to implement that I could make a PR with some light guidance?

cmeeren avatar Sep 06 '19 20:09 cmeeren

Are you thinking it would display here:

image

adamaltman avatar Oct 13 '19 10:10 adamaltman

Yes, exactly. That would be perfect IMHO. Similar to the current required.

image

cmeeren avatar Oct 13 '19 11:10 cmeeren

And if it is required and write-only, for example?

adamaltman avatar Oct 13 '19 14:10 adamaltman

Display both required and write-only?

cmeeren avatar Oct 13 '19 14:10 cmeeren

With a line break? or space? or an and as the separator?

adamaltman avatar Oct 13 '19 18:10 adamaltman

I think I'd prefer line break or space rather than and, but I don't care that much.

cmeeren avatar Oct 13 '19 18:10 cmeeren

Any progress on this? Anything I can do to help? (As previously said, I'm no JS dev, but might this be so simple to implement that I could make a PR with some light guidance?)

cmeeren avatar Nov 27 '19 09:11 cmeeren

Hi! Hope everyone's fine. It's been a while since the last update here, which seemed promising. Any chance to get this through the door? 😄

cmeeren avatar Apr 06 '20 08:04 cmeeren

Hey @cmeeren, unfortunately, no progress on this yet.

But thanks for the reminder. I will prfioritize this as I find it useful and easy-to-add.

RomanHotsiy avatar Apr 06 '20 09:04 RomanHotsiy

Very happy to hear that! As previously said, I'm not really a JS dev, but let me know if I can help. The lack of this feature is itching me something awful at the moment 😅

cmeeren avatar Apr 24 '20 21:04 cmeeren

Hi Redoc team, is there any update on this?

potatolianyi avatar Aug 04 '23 14:08 potatolianyi