Comments (4)
this can be see as a corner case as the description 'The id of the user' is a description for the schema UserID
not for the parameter user_id
the parameter can have a different description
https://spec.openapis.org/oas/latest.html#fixed-fields-9
however looking on how redocly display such description, if both are defined it display the one of the parameter only , otherwise it is displaying the one of the schema
from vacuum.
Yer looks like an edge case, but definitely think it would be good to use the schema description if not overridden to avoid replicating strings unnecessarily, as duplicate strings also trigger lint warnings.
from vacuum.
This is accurate, the schema has a description, however the parameter does not. The parameter and the schema are two different entities and both need accurate descriptions. different parameters may re-use the same schema, but with different contexts, hence the need for descriptions on both.
from vacuum.
While they could require different descriptions, I would suggest its very common for them to not, hence resulting in unnecessary duplicates. Would it make sense to provide an option to allow fall though to avoid this?
from vacuum.
Related Issues (20)
- JUnit report's root attributes are always zero HOT 2
- Node lookup timeout exceeded when using custom rule with pattern function HOT 1
- Java regex support HOT 1
- Ambiguous paths that should not be 0.10.0 HOT 9
- Required statement management in case of complex structure (allOf ) HOT 2
- Path is truncated in output HOT 2
- `schema` function needs a `schema` property to be supplied at a minimum: minimum property number not met (1) HOT 2
- Vacuum not handling YAML anchors correctly HOT 6
- schemaTypeCheck ignores properties under allOf when checking for existence of required fields HOT 6
- Validate string regex pattern
- Rule idea: `no-unnecessary-combinator` HOT 1
- Rules for properties with no type defined
- Dashboard panics when there are no linting warnings or errors HOT 2
- Example is not validated against the schema
- Error "unable to open the rolodex file" on x extensions and code samples HOT 1
- Leading / is not detected as error
- OWASP ruleset doesn't seem to work with swagger 2 appspecs as of `v0.7.0` HOT 1
- Linting with `--ignore-file` doesn't have a deterministic output HOT 6
- Inconsistent Handling of JSONPath Results in core functions versus Built-in Rules HOT 9
- Creating html-report from Vacuum report does not support custom rules HOT 1
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 vacuum.