Comments (3)
We're unlikely to add another configuration option because it's so easy to end up with a huge and bewildering number of them, but I'm curious to hear more about your use case. Could you say something about why either splitting the API description, or maintaining a schema with an alternative manual structure, aren't working well for you?
from redocly-cli.
Hi @lornajane
First, let me thank you for your prompt response.
Initially, our development process involved using the OpenAPI spec without organizing it into multiple files. This approach was followed across more than 25 services. Essentially, we utilized the open-api-generator Maven plugin to generate server code and model classes. However, we've now recognized the need to separate schemas for easier maintenance. I experimented with Redocly Split, which effectively splits schemas and paths. However, upon splitting, the OpenAPI generator fails to generate server code and models correctly. It attempts to create a separate model class for one of the properties, which is incorrect. Therefore, I aim to split only the schemas, not the paths, across all services without manual intervention. In my search for a solution, I came across your tool and identified it as potentially aiding in this schema-splitting task."
from redocly-cli.
I think I understand. It's a common use case to split the OpenAPI descriptions to make easier maintanance, but as you have already discovered, not all tools support that structure. I suggest that you use the split structure as the source of truth, but try bundling the API description back to a single file before passing it to the code generator tools.
from redocly-cli.
Related Issues (20)
- Review guide for replacing servers list HOT 1
- redocly lint format html or markdown HOT 6
- better error handling when $ref references an external file in asyncapi HOT 7
- asyncapi lint support custom rules HOT 8
- Can't resolve remote $ref with query parameter HOT 3
- OAS 3.1 - arbitrary schema keywords are classified as lint errors HOT 3
- Missing const typing support HOT 2
- bug: inconsistent types for OAS3_1 schemas HOT 1
- Add some type of plugin to allow dynamic definition of extensions or config files HOT 2
- Support better means to set environment variables HOT 3
- dependentRequired is valid json schema but does not pass linting and prevents component from being available in UI. HOT 3
- Api HOT 2
- Add the `--ext` parameter to the `split` command HOT 1
- Running out of CPU inside of containers HOT 3
- join fails on commonly referenced components HOT 4
- Redocly removing string for enums if there's non-numbers mixed in HOT 3
- Ability to exclude some operations from security-defined rule HOT 4
- `remove-unused-components` removes used `securityDefinitions` from `Swagger 2.0` specifications HOT 1
- "join" remove extension properties under path property HOT 3
- Add option `--prefix-components-with-filepath` to `join` HOT 2
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 redocly-cli.