Skip to content

chore: fix x-example node type in oas2#1977

Merged
tatomyr merged 3 commits intomainfrom
fix/x-example-node-type
Mar 3, 2025
Merged

chore: fix x-example node type in oas2#1977
tatomyr merged 3 commits intomainfrom
fix/x-example-node-type

Conversation

@tatomyr
Copy link
Collaborator

@tatomyr tatomyr commented Mar 3, 2025

What/Why/How?

Made the x-example property in oas2 accept any data. Although it should be a primitive, it looks like Redoc supports also objects, so I decided not to restrict it too much.

Also, updated the CODEOWNERS file to require approval from all owners.

Reference

Partially resolves Redocly/redocly-vs-code#75

Testing

Tested manually.

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

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

@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2025

🦋 Changeset detected

Latest commit: 3c286eb

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

This PR includes changesets to release 3 packages
Name Type
@redocly/openapi-core Patch
@redocly/cli Patch
@redocly/respect-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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2025

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 945.7 ± 16.2 916.8 972.2 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 964.6 ± 19.5 945.9 1000.2 1.02 ± 0.03

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 79.29% 6982/8806
🟡 Branches 68.2% 2891/4239
🟡 Functions 75.03% 1145/1526
🟡 Lines 79.66% 6656/8355

Test suite run success

1326 tests passing in 190 suites.

Report generated by 🧪jest coverage report action from 3c286eb

@tatomyr tatomyr force-pushed the fix/x-example-node-type branch from 1edacce to ae27c2b Compare March 3, 2025 14:58
@tatomyr tatomyr marked this pull request as ready for review March 3, 2025 14:58
@tatomyr tatomyr requested review from a team as code owners March 3, 2025 14:58
@tatomyr tatomyr merged commit 8b4816a into main Mar 3, 2025
42 checks passed
@tatomyr tatomyr deleted the fix/x-example-node-type branch March 3, 2025 15:44
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.

Problem with x-example in headers parameters with swagger 2.0

3 participants