Improve error message for unknown fields in semantic_model config#12766
Merged
Improve error message for unknown fields in semantic_model config#12766
Conversation
Contributor
|
Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #12766 +/- ##
==========================================
+ Coverage 91.41% 91.43% +0.01%
==========================================
Files 203 203
Lines 25844 25853 +9
==========================================
+ Hits 23626 23639 +13
+ Misses 2218 2214 -4
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
When a user adds an unknown field (e.g. description) inside the semantic_model: config object, replace the opaque JSON Schema error "is not valid under any of the given schemas" with a clear message naming the offending field and listing the valid ones. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ebd3c67 to
937554d
Compare
theyostalservice
commented
Apr 1, 2026
QMalcolm
approved these changes
Apr 1, 2026
Contributor
QMalcolm
left a comment
There was a problem hiding this comment.
LGTM! Thank you for doing this work!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
When a user adds an unsupported field inside the `semantic_model:` config object (e.g. `description:`, which the docs incorrectly showed as valid), dbt produces an unhelpful error:
```
at path ['semantic_model']: {'enabled': True, 'name': 'purchases', 'description': '...'} is not valid under any of the given schemas
```
The `anyOf` JSON Schema failure gives no indication of which field is wrong or what is allowed.
What
After this change the error reads:
```
Unknown field(s) in semantic_model config: description. Valid fields are: config, enabled, group, name.
```
Tests:
Refs
Drafted by claude-sonnet-4-6 under the direction of @theyostalservice