widdershins
widdershins copied to clipboard
shallowSchemas behavior complaint
shallowSchemas
seems to be exactly what I needed in that when viewing the Response Schema of a particular endpoint, i want to defer "learning" about the properties of an object to down in the schemas section, so it's nice to have a link from ResponseObject
down to schemas. that much of it is cool.
Unfortunately, now that i click on ResponseObject
and am viewing its details in the schemas section, it is shallow there also. in THIS spot, i would expect to be able to have further links to other properties of the object.
for instance, here is how the endpoint looks:
now, i click on the response object: and am taken to just this:
i would expect here to be able to navigate further down the tree and at least see the other properties of the object, like lineitems
for instance
now with shallow schemas off, the first example is a big pile of chevrons, and the schema definition in bottom section is correct:
personally, my expectation is that shallowSchemas should only cause the top section to collapse to the ref, not the bottom schemas.
One further question that should probably be its own issue: i'm having trouble making descriptions populate in the tables for items that are complex objects (i guess these are refs?). so for example, is there a way to make the response object in my first screenshot have a description without getting in to template file modifications?
hopefully this is all clear enough, let me know if i can elaborate further.
I think your second point is a dupe of #156