Comments (5)
🎉 This issue has been resolved in version 0.33.2 🎉
The release is available on:
Your semantic-release bot 📦🚀
from openapi-validator.
At IBM, we use OpenAPI definitions to generate SDKs. One of our primary use-cases for this tool is to ensure that an API definition is fit for SDK Generation (the higher quality the API definition, the higher quality the generated SDK).
This warning you've run into is one that we've added specifically for that purpose. Using a $ref
for a response provides us with a meaningful name we can use for a response model in the generated SDK. Without it, the name is automatically generated and is less-than-ideal for the UX of the SDK.
Since you are not likely generating SDKs, then I agree - in this scenario you don't really need to use a named reference. To remove the warning, you can turn off this rule in your configuration file.
Let me know if you have any other questions!
from openapi-validator.
Thanks @dpopp07 for detailed clarification, this totally makes sense to me. It would be great if this could be documented, to mention that the usage of $ref
is to achieve a better data model naming when generating SDKs instead of definition reusability.
from openapi-validator.
That's a fair request, I will update the README to reflect this.
from openapi-validator.
@dpopp07 ^^
from openapi-validator.
Related Issues (20)
- collections missing from the openapi-ruleset in version 0.45.3 HOT 5
- Outdated info in ruleset doc HOT 5
- Support for authenticated additional Openapi definitions HOT 1
- missing-required-property rule failed at anyOf required options HOT 1
- v1.0 Community Feedback HOT 3
- Error when I use a customized rule HOT 7
- feature request: Find a way to extend the spectral default ruleset without installing it local HOT 1
- A dependency of this repository contains a critical VM escape vulnerability HOT 5
- Incorrect validation results for the ibm-parameter-casing-convention rule with camelCase HOT 3
- Support Request: how can a rule ignore parameters with a specific name? HOT 3
- ibm-etag-header crashes linter on incorrect specification HOT 4
- Failed to resolve entry for package "ibm-openapi-validator HOT 2
- Rule "ibm-success-response-example" fails for some operations but not others HOT 3
- support for RPC style HTTP calls HOT 4
- Update documentation to reflect latest recommendations HOT 4
- ibm-parameter-description rule should skip responses.links.{name}.parameters HOT 3
- Runtime error for SCIM-compliant schema (object containing $ref attribute) HOT 4
- Fix test failures with Node 20 HOT 3
- BUG: 'Enum values must be snake case' on enums like '400', '500' HOT 4
- Error running lint-openapi since v1.18.1 HOT 4
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 openapi-validator.