Configurable depth of properties in "Response Schema"
See original GitHub issueIn the “Response Schema” section of an API call, the whole response (including nested entities) is shown, e.g. like this:
Response Schema
Status Code 200
Name | Type | Required | Description
-- | -- | -- | --
anonymous | [Animals] | false | No description
» comment | string | false | Optional note
» kittens | [Kitten] | false | A list of kittens
-- | -- | -- | --
»» name | string | false | e.g. "Mr Meowz"
The UI correctly shows clickable links to the entitites (Animals and Kitten). If interested, a user can jump to the schema description if additional details are required. In the response schema section the nested properties may be unnecessary though. The link to the schema should be enough, as the information is duplicated here.
It would be great if the depth in the response schema was configurable, i.e. show every property (as this is done right now) or only expand nested entities to depth one (only show property “comment” and “kittens”) or depth two (show “comment”, “kittens” and “name”), etc.
Can this already be achieved? There are other depth related options, but none of them seem to have an effect on this. If its not already possible, can this be extended?
Issue Analytics
- State:
- Created 5 years ago
- Reactions:1
- Comments:14 (8 by maintainers)

Top Related StackOverflow Question
Sounds great, I’ll try this out!
@rssteffey thanks for testing! It seems my nervousness about those commits was justified. Reverted. Really going to have to write some tests for the
schemaToArrayfunction… 😢