changeset-bot[bot]
commented
6 months ago 🦋 Changeset detected
Latest commit: f3ae8ef13afc52f4c6b33b0c5adddfea1b5bcf3a
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 2 packages
| Name | Type | | --------------------- | ----- | | @redocly/cli | Patch | | @redocly/openapi-core | Patch |Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
xeptore
tatomyr
What/Why/How?
Currently, when an example object has
externalValuepropertyno-invalid-media-type-exampleslint rule fails as it is validating the example object (the parent object) against the schema definition.I could assume there are couple of ways to handle this case. However, as there is already another lint rule (
no-example-value-and-externalValue), which is kind of related to this one, and its default severity level causes either one ofvalue, orexternalValueproperties to exist for a specific example object, I decided to go with the simple exclusion condition, which basically deactivates the validation for example objects that hasexternalValueset. I also intentionally didn't implement the logic to verify the specified URL set forexternalValueto check whether the target resource actually matches the schema definition or not (by issuing HTTP request for example) as it's both complex to implement properly due to various cases including relative URLs, and for external resources being unpredictable by nature, e.g., the server might be unavailable at the time of linting, or returing a temporary failure due to network issues.Reference
I faced the issue while I was trying to add file examples for request, and response bodies of an API according to the official documentation (here).
Testing
Relevant tests are updated to cover this scenario.
Screenshots (optional)
It can be tested by disabling the condition I added to the lint rule.
Check yourself
Security