Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: do not override theme.openapi with ConfigReferenceDocs node type #1495

Conversation

tatomyr
Copy link
Contributor

@tatomyr tatomyr commented Mar 20, 2024

What/Why/How?

Getting rid of overwriting theme.openapi with the ConfigReferenceDocs node type as it's going to come from the Redocly config package soon.
Essentially, it removes the Reference Docs highlighting in redocly.yaml's theme.openapi (after these changes to the Redocly config package released it is restricted to the new syntax).
The validation still be present inside the deprecated features.openapi field though.

Reference

Related changes in the Redocly config package: https://github.com/Redocly/redocly/pull/8628

Testing

Screenshots (optional)

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

@tatomyr tatomyr self-assigned this Mar 20, 2024
Copy link

changeset-bot bot commented Mar 20, 2024

🦋 Changeset detected

Latest commit: d8d903c

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

This PR includes changesets to release 2 packages
Name Type
@redocly/openapi-core Minor
@redocly/cli Minor

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

Copy link
Contributor

github-actions bot commented Mar 20, 2024

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 973.6 ± 45.4 938.2 1082.4 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 974.6 ± 16.3 949.4 1005.4 1.00 ± 0.05

Copy link
Contributor

github-actions bot commented Mar 20, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 77.12% 4475/5803
🟡 Branches 67.45% 2472/3665
🟡 Functions 70.53% 742/1052
🟡 Lines 77.3% 4209/5445
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / redocly-yaml.ts
83.06% (-6.62% 🔻)
52.78% (-12.22% 🔻)
66.67% (-33.33% 🔻)
82.5% (-6.76% 🔻)

Test suite run success

738 tests passing in 102 suites.

Report generated by 🧪jest coverage report action from d8d903c

@tatomyr tatomyr force-pushed the chore/do-not-override-theme-openapi-with-config-reference-docs-type branch from fc37b3d to fd30e15 Compare May 30, 2024 15:38
@tatomyr tatomyr marked this pull request as ready for review May 31, 2024 12:09
@tatomyr tatomyr requested review from a team as code owners May 31, 2024 12:09
@tatomyr tatomyr requested a review from Oprysk May 31, 2024 14:29
@tatomyr tatomyr force-pushed the chore/do-not-override-theme-openapi-with-config-reference-docs-type branch from 39ca852 to d8d903c Compare June 5, 2024 22:21
@RomanHotsiy RomanHotsiy merged commit 8d1f710 into main Jun 10, 2024
34 checks passed
@RomanHotsiy RomanHotsiy deleted the chore/do-not-override-theme-openapi-with-config-reference-docs-type branch June 10, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants