Skip to content

Fix OpenAPI spec validation typo#1673

Open
mraible wants to merge 2 commits intookta:masterfrom
mraible:fix-openapi-spec-validation-errors
Open

Fix OpenAPI spec validation typo#1673
mraible wants to merge 2 commits 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 has a typo that causes a validation error.

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

Fix

OAuth2ClientJsonWebKeyECRequest (line 70291): typo nullabe corrected to nullable

Validation Results

Before:

❌ Validation failed with 1 error and 1227 warnings.

After:

Woohoo! Your API description is valid. 🎉
You have 1227 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
@prachi-okta
Copy link
Contributor

prachi-okta commented Mar 2, 2026

Hi @mraible, thanks for your PR! Could you please complete the CLA and share it with us? Once that’s done, we can go ahead and merge it.
https://developer.okta.com/cla/

@mraible
Copy link
Contributor Author

mraible commented Mar 5, 2026

@prachi-okta I worked at Okta for 7 years, does that help bypass the CLA? If not, can I do it online? I don't have access to a printer right now.

Upstream fixed the EnhancedDynamicNetworkZone include/exclude properties
using allOf with descriptions. Took upstream's version as it's more
complete and also resolves the structural issue.
@mraible mraible changed the title Fix 6 OpenAPI spec validation errors Fix OpenAPI spec validation typo Mar 6, 2026
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

2 participants