rspec-openapi
rspec-openapi copied to clipboard
parameter type: :request is required
trafficstars
Hi guys!
LOVE this tool! thank you for maintaining it!
Quick note that might be worth adding to your documentation. In the clause:
RSpec.describe MyApp, type: :request do
it is worth noting that the type: :request parameter is absolutely required to trigger your openapi documentation. It is NOT required to get rspec to work correctly, so it took a while for me to discover that was why I was not getting any openapi schema output!
Now that I have learned this, I am a very happy camper! Just submitting this in case others have the same problem. Your tool doesn't complain, it just fails silently, so it was hard to troubleshoot my error.
Best wishes to you all!