Skip to content

Fix 6 OpenAPI spec validation errors#1673

Open
mraible wants to merge 1 commit intookta:masterfrom
mraible:fix-openapi-spec-validation-errors
Open

Fix 6 OpenAPI spec validation errors#1673
mraible wants to merge 1 commit intookta:masterfrom
mraible:fix-openapi-spec-validation-errors

Conversation

@mraible
Copy link
Contributor

@mraible mraible commented Feb 3, 2026

The OpenAPI spec at src/swagger/api.yaml currently fails validation. Running npx @redocly/cli lint api.yaml reports 6 structural errors.

This is a follow-up to #1604 and fixes #1672.

Fixes Applied

  1. OAuth2ClientJsonSigningKeyRequest (lines 70190-70198): discriminator and required were incorrectly nested inside properties instead of at the schema level

  2. EnhancedDynamicNetworkZone (lines 64852-64855): include and exclude properties used array syntax (- $ref:) instead of direct reference syntax ($ref:)

  3. OAuth2ClientJsonWebKeyECRequest (line 70290): typo nullabe corrected to nullable

Validation Results

Before:

❌ Validation failed with 6 errors and 1218 warnings.

After:

Woohoo! Your API description is valid. 🎉
You have 1199 warnings.

Reproduction

curl -O https://raw.githubusercontent.com/okta/okta-sdk-java/refs/heads/master/src/swagger/api.yaml
npx @redocly/cli lint api.yaml

@mraible mraible requested a review from prachi-okta as a code owner February 3, 2026 21:06
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 mraible force-pushed the fix-openapi-spec-validation-errors branch from 7ce72b5 to e7caf4a Compare February 3, 2026 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI Spec has 6 structural errors and fails validation

1 participant