Comments (10)
Widdershins v3.0.0 has just been released.
from widdershins.
Thanks a lot for the update Mike!
from widdershins.
This is an artifact of the way the formData
parameters are internally converted into the requestBody
structure used by OpenAPI 3.0.
I'll add an option to omit the enclosing (fake) body
parameter.
from widdershins.
Is there any way that I could prevent the enclosing from my side?
from widdershins.
You can patch openapix.js
in function fakeBodyParameter
and comment-out the first instance of the following line:
bodyParams.push(param);
It should be line 275.
from widdershins.
Perfect ! Thanks for the patch. Works seamlessly. You are awesome Mike, saving us a lots of time.
A quick question, why is that am getting the symbol >> before the parameters? Not a pressing issues, just for getting a deeper understanding of how the parser works.
from widdershins.
That's because it's showing a nested properties under the object that we've just hidden.
If you change the offset 0 to -1 on the following line, they should go away:
let props = common.schemaToArray(data.bodyParameter.schema,0,{trim:true},data);
Line 278. Thanks for testing my changes I haven't even written yet!
from widdershins.
Awesome! Thanks for that :)
Mike, am also facing an issue with the required field as said above. If you take a look at the first screen shot, the parameter password is mentioned as required in the Swagger JSON but in the markdown, the field is set to false. And in the screenshot that I have added in the subsequent comment, every field is a required one. But only the email field is set as required.
Is this an issue or am I doing anything wrong?
from widdershins.
Mike, am also facing an issue with the required field as said above.
This was a bug in the OpenAPI 2.0 to 3.0 converter. When the next beta of widdershins is released (hopefully later today) it will have the updated converter dependency.
Thanks again for the testing and the bug reports!
from widdershins.
Apologies for the delay, [email protected] has just been released.
from widdershins.
Related Issues (20)
- OpenAPI3 response parsing discards schema format
- Getting all enum values into one table
- Servers/Base URL not being overridden at path or operation level HOT 1
- Support custom media type HOT 6
- Add option "--header-offset"
- Add support for OpenRPC
- Support for AsyncAPI version 2.2
- headingLevel is getting overriden to default value i.e 2.
- Vulnerability for package [email protected] in widdershins
- Upgrade to [email protected] to fix yargs-parser vulnerability
- CODE SAMPLES ERROR WIDDERSHINS + SLATE
- node can't find widdershins module after npm install is run HOT 2
- Any programmable API? HOT 1
- shins dependency is including vulnerable jquery version 3.2.1
- Missing body parameter code for API languages other than JavaScript HOT 2
- User defined data fields to be used in templates
- user_template is not well defined HOT 1
- Could not get ToC to generate
- Generate Markdown with no html headers
- Bump version of httpsnippet
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 widdershins.