zero-rails_openapi icon indicating copy to clipboard operation
zero-rails_openapi copied to clipboard

Published 20 hours ago • verified publisher icon zhandao

Fix examples generation

Open bopm opened this issue 3 years ago • 1 comments

Examples should have different location and format according to OAS 3.0.

bopm avatar Aug 16 '21 19:08 bopm

During generating examples for query param, I stepped on the fact, that while example should be sitting in the schema, examples should be one level higher. And they are supposed to be a single object, not an array of single key objects. https://swagger.io/docs/specification/adding-examples/ While I was able to fix the issue and get Swagger UI to show me examples with extended properties like summary fixing specs is a way more complicated issue with RSpec DSL present. Looking forward to some guidance @zhandao.

bopm avatar Aug 16 '21 19:08 bopm