docs: document global api.settings in generators.yml #2189
+13
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR documents the new global
api.settingsconfiguration feature introduced in PR #10521. This feature allows users to define API settings globally ingenerators.ymlthat apply to all specifications, with a precedence hierarchy where generator-level settings override spec-level settings, which in turn override global settings.The documentation includes:
settingsparameter under theapisectionReview & Testing Checklist for Human
coerce-enums-to-literals,inline-path-parameters) can actually be used at the global level, or if there are any restrictionsTest Plan
apisection and verify the newsettingsparameter appearsNotes