-
Notifications
You must be signed in to change notification settings - Fork 362
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for context blocks in HTML index #486
Comments
@greggroth sounds good to me, even better if it can be flipped on via a flag to preserve existing behavior for now. |
👍 I'll try to find time to hack on this in the coming weeks and will keep a configuration option in mind. Thank you! |
I've hit this issue as well and there's actually even more to this. Example requests with the same description get overwritten in the generated files.
Outputs 2 identically named files called |
Right now, all examples under a resource are flattened to a single list, so tests that have the same example name across different contexts to highlight different behaviors lose this organization. For example, given a test like:
Would generate docs structured like
So the request detail
GET /blog/:client
and the context of each example are left out.This can be worked around with more verbose example descriptions, but would y'all be open to considering an update to the HTML doc writer to include the structure of the tests so the index output is more like
The text was updated successfully, but these errors were encountered: