fix: prevent object properties from showing as separate parameters (#810)

[kajal-jotwani]

Fixes: #810

This PR fixes the issue where object properties were incorrectly showing up as separate parameters in the reference documentation.

[davepagurek]

Thanks @kajal-jotwani! Do you think there would be a way to still see a way to display the properties and their descriptions below the object itself in this example, but just not show it in the Syntax section as separate items? e.g. keeping this, which looks great:

...but below, showing the properties still? maybe something like this? (just a mockup, open to other designs!)

[kajal-jotwani]

I think we can do that I'll try to do it and share the updates

[kajal-jotwani]

Hello @davepagurek!
I wanted to get your review on this whenever you get the chance.

[ksen0]

Hi @davepagurek , it's been noted that the original issue #810 has been resolved - do you think this PR can still be useful?

Apologies for the long wait @kajal-jotwani , and thanks for your work on this.

[davepagurek]

I think this is only partially resolved, as we don't show the properties of objects anywhere in the reference section of a docs page anymore, they're just hidden. So I think something like this is still worth doing.

@kajal-jotwani this is definitely a step in the right direction, but as it is all the properties are getting squished into one line. I think to be mergeable, we'd want each property on its own line, indented in for readability.

[kajal-jotwani]

@davepagurek Thanks for the feedback! I'll work on displaying each property on its own line and will share an update soon.