Redocly / redocly-cli

βš’οΈ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
https://redocly.com/docs/cli/
MIT License
912 stars 139 forks source link

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

Closed tatomyr closed 3 months ago

tatomyr commented 6 months ago

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

Security

changeset-bot[bot] commented 6 months ago

πŸ¦‹ Changeset detected

Latest commit: d8d903ca4f7b1313e77f8436e0ec387d30e5b42e

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

github-actions[bot] commented 6 months ago
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
github-actions[bot] commented 6 months ago

Coverage report

St.:grey_question:
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.:grey_question:
| 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 d8d903ca4f7b1313e77f8436e0ec387d30e5b42e