Comments (8)
Although this is a good idea, and we can consider it further, in the Unix spirit of "doing one thing and doing it well", have you looked at https://github.com/Typeform/openapi-micro-merge ? It might suit your needs as a pre-processing step before calling widdershins?
from widdershins.
Also some more work is necessary to get more / variable levels of header support in the TOC.
from widdershins.
Thanks for pointing out to openapi-micro-merge.
Unfortunately it does not suits my needs as it merge all swagger files into one file - resulting in duplicate entries.
Tweaking around widdershins would work. I think manually generating the header and only the markdown for each of the swagger files would be fine.
from widdershins.
If openapi-micro-merge
creates duplicate entries, it might be worth raising an issue there?
It won't be trivial to adapt Widdershins to output multiple definitions with all the h1
s, h2
s etc shifted down by one level (if that's what you want), though I will bear it in mind for the upcoming rewrite of the OpenAPI templates.
from widdershins.
Is this any better for your use-case with Widdershins v3.0.x?
from widdershins.
I am not sure.
How 3.0.x improve my use case ? Can you provide a quick example ?
from widdershins.
It should be easier to amend the stock templates to increase the heading levels by one in v3.0.x and combine using a version of your script. Other than that, there is no additional support yet.
from widdershins.
A note that @shreyas-agnihotri had the same issue/request. Mentioned https://github.com/maxdome/swagger-combine, though https://github.com/Typeform/openapi-micro-merge also worth looking at. Both OpenAPI 2.0 only as far as I can see.
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.