Fix 6 OpenAPI spec validation errors #1673
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The spec fails validation with Redocly CLI due to structural issues: 1. OAuth2ClientJsonSigningKeyRequest: `discriminator` and `required` were incorrectly nested inside `properties` instead of at the schema level 2. EnhancedDynamicNetworkZone: `include` and `exclude` properties used array syntax (`- $ref:`) instead of direct reference syntax (`$ref:`) 3. OAuth2ClientJsonWebKeyECRequest: typo `nullabe` corrected to `nullable` Validation command: `npx @redocly/cli lint api.yaml` Before: 6 errors, 1218 warnings After: 0 errors, 1199 warnings Fixes okta#1672
mraible
force-pushed
the
fix-openapi-spec-validation-errors
branch
from
7ce72b5 to
e7caf4a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The OpenAPI spec at
src/swagger/api.yamlcurrently fails validation. Runningnpx @redocly/cli lint api.yamlreports 6 structural errors.This is a follow-up to #1604 and fixes #1672.
Fixes Applied
OAuth2ClientJsonSigningKeyRequest (lines 70190-70198):
discriminatorandrequiredwere incorrectly nested insidepropertiesinstead of at the schema levelEnhancedDynamicNetworkZone (lines 64852-64855):
includeandexcludeproperties used array syntax (- $ref:) instead of direct reference syntax ($ref:)OAuth2ClientJsonWebKeyECRequest (line 70290): typo
nullabecorrected tonullableValidation Results
Before:
After:
Reproduction