fix: example validation for readOnly/writeOnly properties

[vadyvas]

What/Why/How?

TBD:

• release ajv
• add changeset

What

• Fixes false validation warnings/errors when OpenAPI schemas combine required with readOnly / writeOnly while validating request/response examples.
• Passes OAS request/response context into Ajv so validation can correctly interpret:
  • required + readOnly → required in responses, not allowed / not required in requests
  • required + writeOnly → required in requests, not allowed / not required in responses

Why

• Matches the behavior expected in: validation of sample : readOnly / writeOnly and required statement interaction  #1416
• Related previous work / context: fix: no-invalid-media-type-examples now respects readOnly and writeOnly properties #2412

How

• Integrates Ajv changes from fix: validation required warning with readonly writeonly props ajv#37 by:
  • Enabling passContext: true (so Ajv keywords can access this).
  • Calling Ajv validation with a this context containing apiContext?: 'request' | 'response' } so readOnly / writeOnly and required behave correctly per example location.

Reference

• Ajv change: fix: validation required warning with readonly writeonly props ajv#37
• Issue: validation of sample : readOnly / writeOnly and required statement interaction  #1416
• Related PR: fix: no-invalid-media-type-examples now respects readOnly and writeOnly properties #2412

Testing

• Added/updated unit tests to cover the new context-aware validation behavior.
• Verified request/response example validation for schemas using required + readOnly / writeOnly.
• Tested in Reunite (https://github.com/Redocly/redocly/pull/20934):
  • Pipeline: https://github.com/Redocly/redocly/actions/runs/21955207790?pr=20934 ✅
  • E2E: https://github.com/Redocly/redocly/actions/runs/21955243566?pr=20934 ✅

Screenshots (optional)

Check yourself

• Code changed? - Tested with Redoc/Realm/Reunite (internal)
• All new/updated code is covered by tests
• New package installed? - Tested in different environments (browser/node)
• Documentation update considered

Security

• The security impact of the change has been considered
• Code follows company security practices and guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: e0fc620

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@redocly/respect-core	Patch
@redocly/openapi-core	Patch
@redocly/cli	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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	79.42% (🎯 78%)	6319 / 7956
🔵	Statements	78.84% (🎯 78%)	6527 / 8278
🔵	Functions	83.33% (🎯 82%)	1295 / 1554
🔵	Branches	70.98% (🎯 70%)	4298 / 6055

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/rules/ajv.ts	90%	85.71%	85.71%	97.29%	35, 80, 100
packages/core/src/rules/utils.ts	91.17%	88.88%	100%	90.32%	47, 71, 80-83, 93, 105-108, 188
packages/core/src/rules/common/no-invalid-parameter-examples.ts	100%	100%	100%	100%
packages/core/src/rules/common/no-invalid-schema-examples.ts	100%	100%	100%	100%
packages/core/src/rules/oas3/no-invalid-media-type-examples.ts	95.23%	87.5%	100%	100%	39

Generated in workflow #8609 for commit e0fc620 by the Vitest Coverage Report Action

[github-actions]

CLI Version	Mean Time ± Std Dev (s)	Relative Performance (Lower is Faster)
cli-latest	3.565s ± 0.045s	▓ 1.01x
cli-next	3.525s ± 0.038s	▓ 1.00x (Fastest)

[vadyvas]

no idea why it started failing now, but it doesn't look valid

[tatomyr]

Could you investigate how your chages inpacted that?

[vadyvas]

it doesn't fail anymore, but left it like that
JSON schema allows to skip type

[tatomyr]

Could you add a test for Respect too?

[vadyvas]

i don't think it's necessary, respect filters out writeOnly / readOnly properties

[github-actions]

📦 A new experimental 🧪 version v0.0.0-snapshot.1770901767 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1770901767
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1770901767
# or
npm install @redocly/respect-core@0.0.0-snapshot.1770901767

⚠️ Note: This is a development build and may contain unstable features.

[vadyvas]

added redocly-ajv-8.17.4.tgz for generating snapshot, i will remove it later

[github-actions]

📦 A new experimental 🧪 version v0.0.0-snapshot.1770913558 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1770913558
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1770913558
# or
npm install @redocly/respect-core@0.0.0-snapshot.1770913558

⚠️ Note: This is a development build and may contain unstable features.