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

docs(all): clarifies what is overridden on a per-api basis #1882

Merged
merged 9 commits into from
Feb 9, 2025

Conversation

HCloward
Copy link
Contributor

@HCloward HCloward commented Feb 4, 2025

What/Why/How?

There is some confusion with users about how per-API rules, decorators, and preprocessors merge with root settings. When there are per-API rules, decorators, and preprocessors, we merge with the top-level root properties. This merging does not include parameters specific to the rules, decorators, or preprocessors.

Reference

Relates to #1871

Security

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

@HCloward HCloward requested a review from a team as a code owner February 4, 2025 22:12
Copy link

changeset-bot bot commented Feb 4, 2025

⚠️ No Changeset found

Latest commit: 0e531ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@HCloward HCloward requested a review from tatomyr February 4, 2025 22:13
@HCloward HCloward self-assigned this Feb 4, 2025
Copy link
Contributor

github-actions bot commented Feb 4, 2025

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 954.4 ± 17.5 941.0 1000.1 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 960.2 ± 14.9 936.0 989.8 1.01 ± 0.02

Copy link
Contributor

github-actions bot commented Feb 4, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.6% 5053/6429
🟡 Branches 67.18% 2059/3065
🟡 Functions 73.16% 834/1140
🟡 Lines 78.88% 4767/6043

Test suite run success

836 tests passing in 120 suites.

Report generated by 🧪jest coverage report action from 0e531ec

docs/configuration/apis.md Outdated Show resolved Hide resolved
docs/configuration/apis.md Outdated Show resolved Hide resolved
docs/configuration/apis.md Outdated Show resolved Hide resolved
docs/configuration/apis.md Outdated Show resolved Hide resolved
@HCloward HCloward requested a review from tatomyr February 6, 2025 13:08
Copy link
Contributor

@tatomyr tatomyr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there. Left a couple of comments.

docs/configuration/apis.md Outdated Show resolved Hide resolved
docs/configuration/apis.md Show resolved Hide resolved
docs/configuration/apis.md Outdated Show resolved Hide resolved
@HCloward HCloward requested a review from tatomyr February 8, 2025 15:59
Copy link
Contributor

@tatomyr tatomyr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@HCloward HCloward merged commit f0446c7 into main Feb 9, 2025
42 checks passed
@HCloward HCloward deleted the docs/1871-clarify-behavior branch February 9, 2025 22:21
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.

3 participants