Comments (5)
Interesting. I did not know examples
that can contain multiple examples https://swagger.io/docs/specification/adding-examples/
I am happy to accept pull request.
I prefer it defaults to single example
and add a feature dlag for new behavior (examples
)
from rspec-openapi.
Ok great. I'm in the middle of a project with a deadline and I haven't looked at the code yet.
So I'm not sure when I'll be able to get started but I will notify here if and when I do.
Please let me know if you have any recommendations on how you would architect / implement this.
Thanks again!
from rspec-openapi.
Hey--I'm realizing that this may be a killer bug for me... The issue effects not only outputs but inputs.
I need to test that the API gives a 200 for good input and 400 for bad input--a very common use case.
Unfortunately, the requestBody
example will randomly generate the OAI schema using the bad input from time to time.
Let me know if there are any workarounds or if you think this might be a quick fix.
Thank you
from rspec-openapi.
Let me know if there are any workarounds or if you think this might be a quick fix.
Test cases can be excluded from OpenAPI generation with openapi: false
argument.
So you can include only valid inputs.
RSpec.describe '/resources', type: :request do
it 'returns a resource', openapi: false do
# ...
end
end
from rspec-openapi.
The thing is, I'd like to document 400 responses as well.
I think this will tide me over for now actually:
# Disable generating `example`
RSpec::OpenAPI.enable_example = false
Thanks !
from rspec-openapi.
Related Issues (20)
- Getting invalid byte sequence in UTF-8 when the response is a pdf HOT 3
- Difference in Empty Values Handling in Examples HOT 3
- Dealing with responses with different possible bodies for the same status code HOT 1
- requestBody should not merge examples for error HOT 2
- Setting additionalProperties = false HOT 1
- Include property descriptions in response schema? HOT 1
- Regenerating (remove file and run rspec) the schema without changing the code, generates different file. HOT 1
- Authorization HTTP header is inserted as parameter even though there is securityScheme defined HOT 2
- Using `RSpec::OpenAPI.path = ->` but for different audiences HOT 1
- Evaluate proc for RSpec::OpenAPI.title HOT 2
- Manually edited oneOf in response schema is overridden HOT 4
- Hanami framework support HOT 10
- preserve comment in openapi yaml HOT 1
- Rails 7.1 transforms request.response_body to Nokogiri class if it is HTML
- Can we remove required parameters for request body? HOT 6
- If parameter has symbol, it will be error HOT 6
- [BUG] NotImplementedError: type detection is not implemented for: :json when ID not found HOT 2
- hanami: non-integer path variable is not supported HOT 2
- Is there a way to name `[]` in parameters? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rspec-openapi.