Redoc: Supply custom "property name" for additionalProperties

[dbeacham]

Would be nice to better describe/document the keys within additionalProperties where appropriate. I often have mappings where the key isn't completely free form (e.g. a named unique identifier or an integer with some meaning) and would be nice to have the docs relfect that, e.g:

• players (object)
  
  
  
  • player-id* : object (Player)
  
  

rather than

• players (object)
  
  
  
  • property name* : object (Player)
  
  

Will also suggest such a change in the OpenAPI specification but is it possible/desirable to add the ability to override the "property name*" value?

Would also be useful in the generated examples where the keys are "property1", "property2" but could be tied to the name in the docs, e.g. "player-id-1", "player-id-2"

[RomanHotsiy]

@dbeacham thanks for the feature request!
This looks like a nice feature.

It requires using vendor extension but I can't come up with a better name than x-additionalPropertiesName.
Does anyone have better suggestions?

[raubel]

I'm eagerly waiting for this feature to be implemented (property1/2 has absolutely no meaning in my documentation).
Is there a any plan to include it in an upcoming release?

[kzhou57]

Is there any progress on this feature request ?

[RomanHotsiy]

@kzhou57 not really. PR would be appreciated

[dbeacham]

Where would you expect x-additionalPropertiesName to sit in the schema?

Under or at the same level ofaddtionalProperties?

[raubel]

x-additionalPropertiesName is great (thanks for that).
Could it be used also to generate property names in examples ("player-id-1", "player-id-2" instead of "property1", "property2")?

[josephjang]

x-additionalpropertiesname proposed here is documented and working fine. (Thanks)
https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-additionalpropertiesname

I think this issue can be closed.

[RomanHotsiy]

Oh, I forgot to close it. But I think I will first resolve https://github.com/Redocly/redoc/issues/622#issuecomment-539057231 and close it then.

[theoephraim]

Just came across this after opening a similar ticket on the OpenAPI spec repo. I also suggested being able to specify a description and schema as well as the label. Probably not worth implementing those until its part of the spec, but thought I'd post here for anyone else interested in this feature.

[easterncoder]

I see that this is now partially supported in a way.

The name that shows up in the schema has changed from "property name*" to whatever x-additionalPropertiesName is set to. However the responses samples output still shows property1... and it looks like it's hardcoded. Would love to see this be applied to the response samples too.

Thanks.

[hverlin]

Same question as @easterncoder, not sure how this should be handled:

Should I create new issue for it?