Discussions
Is there a depth limit to API documentation of nested objects in a response?
over 3 years ago by Kyle Pollina
Hello,
Is there a depth limit to what the documentation displays as nested fields in a response schema? We seem to only be able to get a certain depth for our response schemas and our clients are not able to access information on our entire schema response.
Example
We have a response that follows this structure:
{
"foo": {
"bar": {
"baz": [
{
"hello": "world"
}
]
}
}
}
yet in our API reference our clients can only see foo.bar.baz
with its description but we can not see foo.bar.baz[].hello
or any other fields within this list. Is this a limitation? Are we doing something wrong? Would like feedback.
Thank you!
Kyle