Comments (6)
First implementation is available here: #553
from cli.
@paulRbr if I'm correct, this implementation doesn't follow the proposed args/options. I could review it, but I think it would be more efficient if I review something that matches the expectations. If you disagree with the proposed options/args, feel free to share your opinion, it was just a first proposal!
Also, would you have some time to answer the small questions at this end of this issue? Thanks a lot! π
from cli.
I think it would be more efficient if I review something that matches the expectations.
Sure think, I'll ping you when I have time to update the initial implemntation
- how do we handle $ref? is there any way to apply the overlay on external dependencies?
With the current implementation, we used an external lib which doesn't apply overlay on references data. It applies overlays on a target jsonpath of the input json/yaml document.
- do we want to allow applying an overlay on a components file? if yes, are there some consequencies?
That's a good question. For now I've limited the possibility to apply an overlay only on a βAPI documentβ (a document that looks like an AsyncAPI or OpenAPI). But we can discuss this further. I don't think there's a strong limitation for what you ask as the overlay is basically fetching a JSON path inside a simple JSON/YAML object.
from cli.
Thanks for the explanation. Let's talk about this next week, when you had some time to work on it!
from cli.
This is done! π
from cli.
This is done! π
from cli.
Related Issues (20)
- [Feature request] : Add the possibility to put an external url in the header of the documentation page (hub and spec) HOT 4
- Preview in the context of an existing documentation
- Diffs: add an optional `--expire` parameter to `diff` command HOT 1
- Dry-run sometimes fails with error HOT 3
- Be able to `deploy` a git history of a given file
- Possible integration for calculating diff using value from pandas df
- OAS schemas module not found HOT 1
- [Typo] Bump --help
- Add a new option to fail on breaking changes diff HOT 4
- Fully migrate to `@oclif/core` since `@oclif/command` is now deprecated
- Non backward compatible change not detected (removed content type result) HOT 1
- Default support of any error code HOT 1
- Using the `deploy` command with an URL as input doesn't work HOT 2
- βLiveβ previews doesn't follow changes of file system based external refs
- Timeout when trying to get diff of two files HOT 10
- Try to deploy all files from a directory deployment (Hub) even if there's an error
- TimeOut Questions HOT 1
- Bug: Diff of a valid file with itself is not empty HOT 4
- Improve error message when target directory doesn't exist
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 cli.