spring-auto-restdocs icon indicating copy to clipboard operation
spring-auto-restdocs copied to clipboard

In response fields, link to Objects instead of flattening them

Open Bram9205 opened this issue 7 years ago • 1 comments

Currently, when the generated response fields contain an object, every field within that object will be included in the response fields as well (and any fields within objects within those objects as well etcetera).

I think it would be nice to have the possibility to have objects in response fields link to different sections in the asciidoc, which in turn contain the fields within that object. Do you agree this would be a useful feature?

For an example of the above, see my question on Stack Overflow: https://stackoverflow.com/questions/51247549/spring-auto-restdocs-have-response-fields-link-to-objects-instead-of-flattening

Bram9205 avatar Jul 11 '18 12:07 Bram9205

That would be great indeed. We might look into this in the future, or you can bring a proposal with PR.

jmisur avatar Jul 20 '18 09:07 jmisur