Skip to content
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

Bug in OpenApi formatter with multiple examples for same HTTP action? #493

Open
bf4 opened this issue Mar 22, 2021 · 2 comments
Open

Bug in OpenApi formatter with multiple examples for same HTTP action? #493

bf4 opened this issue Mar 22, 2021 · 2 comments

Comments

@bf4
Copy link
Contributor

bf4 commented Mar 22, 2021

  • With config.format = "JSON" (and apitome) I see multiple docs for each example, e.g.

Screen Shot 2021-03-22 at 12 59 54 PM

  • With config.format = "open_api" (and redoc) I see ONE doc for each example action e.g. Screen Shot 2021-03-22 at 1 00 00 PM.
    (In addition, the 'summary' and 'description' are always empty in the generated open_api.json)

I looked into the code at how route_summary and friends are used and have looked through the issues. I can't imagine I'm the first person to encounter this but I haven't found anything. We don't use a fresh context for every example which I see in the readme example, but aside from that, perhaps there's just an unreported bug in the formatter?

@jakehow
Copy link
Member

jakehow commented Mar 30, 2021

@bf4 it's creating multiple examples per action when there is only one spec? Or you have two specs that are both being documented? Do you have a minimal example?

@bf4
Copy link
Contributor Author

bf4 commented Mar 30, 2021

I'm using the word example to mean dsl methods example and example_request. I'll see if I can write a failing test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants