redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Provide option to display readOnly properties

Open jmalin-splunk opened this issue 5 years ago • 6 comments

When I mark a property in a request body with readOnly: true, redoc-cli doesn't display the property at all in the HTML output. This is at odds with the behavior of other documentation generators, which display the property with distinctive treatment that shows that the property is read-only. SwaggerHub is an example of this.

jmalin-splunk avatar Jun 21 '19 18:06 jmalin-splunk

It is only displayed in the response object and not the request body.

g-ongenae avatar Aug 26 '19 13:08 g-ongenae

yet interesting to have an option to display it in the UI...

aspich avatar Sep 21 '21 12:09 aspich

+1 We use the JSON Patch in our API. If a user doesn't see which properties are readOnly they don't see which properties hi can change.

V0v1kkk avatar Sep 24 '21 20:09 V0v1kkk

+1 Please can we have this, as it is part of openapi spec

lordplagus02 avatar Nov 17 '21 08:11 lordplagus02

+1

seregagl avatar Nov 30 '21 09:11 seregagl

I'm curious why people are asking for this. If it's "read only", then they can't update it, and why have it as part of the incoming (POST or PATCH) defined payload?

crizo23 avatar Jan 29 '24 20:01 crizo23