Comments (3)
Swagger 2.0 and OpenAPI 3.0 don't allow $ref
to be used on the same object as other properties. So this is invalid:
in: query
name: bar
required: false
$ref: "#/definitions/mytype"
If you choose to use $ref
alongside other properties, then you opting-in to nonstandard behavior that swgger-cli provides due to popular demand. Since it's nonstandard behavior, it does not need to comply with the Swagger spec or any other tooling implementation. But you can opt-out by only using $ref
as allowed by the spec.
It's also worth noting that due to the popularity of this nonstandard feature, it is being added to the OpenAPI 3.1 spec as an official standard.
from swagger-cli.
In validate
mode, I would like to validate in the strictest possible sense according to the relevant spec -- the point of validation being ensuring validity and thus likely broadest possible interoperability. IMHO that's how it should work by default, and opt-in confirmed by passing a flag to swagger-cli validate signifying the desire to opt in to nonstandard behavior. Failing that, an option to explicitly opt out of it would be the next best thing.
from swagger-cli.
Good point. I was thinking in terms of the dereference
method, not the validate
method. I agree that for validate
(and maybe dereference
too) it makes sense to default to spec-compliant mode.
from swagger-cli.
Related Issues (20)
- swagger-cli validation returns errors one by one
- invalid examples should not fail validation
- Dependabot warning for validator
- $ref bug resolving an existing folder HOT 1
- swagger-cli validate does not ensure unique operationIds
- Validate security keys against securitySchemes HOT 1
- Error: Token "Components" Does Not Exist HOT 6
- Combining multiple files can create circular references HOT 1
- Ref incorrect if path contains "{" or "}" HOT 1
- Bad error message on incorrect path provided
- Latest version of the CLI I'm getting the following error HOT 5
- bundle and validate commands are failing due to swagger-parser HOT 3
- Validation of composite keywords (anyOf, oneOf, allOf) HOT 1
- False positive: #/servers/0/variables/someParameter must NOT have unevaluated properties
- Undeclared parameters in server url should not validate
- Property examples are converted to the wrong date format
- The order of the directive changes between versions of the dependent package
- Combining multiple files into one keeps references to some api files HOT 1
- [BUG] String enum of '08' and '09 ' are wrong bundled HOT 1
- bundle removes quotes
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 swagger-cli.