Skip to content

Repository navigation

[ENHANCEMENT](schema) Remove the non-null defaults from the schema models #697

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.

Sign up for GitHub

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

Merged
Victor Schappert (vcschapp) merged 2 commits into from
Sep 2, 2026
Merged

[ENHANCEMENT](schema) Remove the non-null defaults from the schema models #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4afa9c3
feat(schema)!: remove the non-null defaults from level, land and water
sethfitz Aug 26, 2026
df65004
feat(schema)!: remove the is_max_speed_variable default
sethfitz Aug 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/overture-schema-common/changelog.d/696.breaking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed the `level` default of `0`; a feature parsed without a level now yields `None` instead of `0`, and the field description states that absence means visual level.
10 changes: 9 additions & 1 deletion packages/overture-schema-common/src/overture/schema/common/level.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,12 @@
class Stacked(BaseModel):
"""Properties defining feature Z-order, i.e., stacking order."""

level: Level | None = 0 # type: ignore[assignment]
level: Annotated[
Level | None,
Field(
description=(
"Z-order of the feature where 0 is visual level. A feature "
"without a level is at visual level."
)
),
] = None
1 change: 1 addition & 0 deletions packages/overture-schema-theme-base/changelog.d/696.breaking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Made `class` and `subtype` required on `Land` and `Water`, matching `Infrastructure` and `LandUse`; constructing either without them now raises instead of falling back to `land`/`water`.
6 changes: 2 additions & 4 deletions packages/overture-schema-theme-base/src/overture/schema/base/land.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,8 @@ class Land(

# Required

class_: Annotated[LandClass, Field(default=LandClass.LAND, alias="class")] = (
LandClass.LAND
)
subtype: Annotated[LandSubtype, Field(default=LandSubtype.LAND)] = LandSubtype.LAND
class_: Annotated[LandClass, Field(alias="class")]
subtype: LandSubtype

# Optional

Expand Down
15 changes: 2 additions & 13 deletions packages/overture-schema-theme-base/src/overture/schema/base/water.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,19 +138,8 @@ class Water(

# Required

class_: Annotated[
WaterClass,
Field(
default=WaterClass.WATER,
alias="class",
),
] = WaterClass.WATER
subtype: Annotated[
WaterSubtype,
Field(
default=WaterSubtype.WATER,
),
] = WaterSubtype.WATER
class_: Annotated[WaterClass, Field(alias="class")]
subtype: WaterSubtype

# Optional

Expand Down
3 changes: 1 addition & 2 deletions packages/overture-schema-theme-base/tests/infrastructure_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,8 +643,7 @@
"type": "number"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand Down
13 changes: 6 additions & 7 deletions packages/overture-schema-theme-base/tests/land_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,8 +507,7 @@
},
"properties": {
"class": {
"$ref": "#/$defs/LandClass",
"default": "land"
"$ref": "#/$defs/LandClass"
},
"elevation": {
"description": "Elevation above sea level of the feature in meters.",
Expand All @@ -518,8 +517,7 @@
"type": "integer"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand All @@ -546,8 +544,7 @@
"uniqueItems": true
},
"subtype": {
"$ref": "#/$defs/LandSubtype",
"default": "land"
"$ref": "#/$defs/LandSubtype"
},
"surface": {
"$ref": "#/$defs/SurfaceMaterial"
Expand Down Expand Up @@ -579,7 +576,9 @@
"required": [
"theme",
"type",
"version"
"version",
"class",
"subtype"
],
"type": "object"
},
Expand Down
3 changes: 1 addition & 2 deletions packages/overture-schema-theme-base/tests/land_use_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,8 +595,7 @@
"type": "integer"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand Down
13 changes: 6 additions & 7 deletions packages/overture-schema-theme-base/tests/water_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,8 +468,7 @@
},
"properties": {
"class": {
"$ref": "#/$defs/WaterClass",
"default": "water"
"$ref": "#/$defs/WaterClass"
},
"is_intermittent": {
"description": "Whether the water body exists intermittently, not permanently",
Expand All @@ -482,8 +481,7 @@
"type": "boolean"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand All @@ -510,8 +508,7 @@
"uniqueItems": true
},
"subtype": {
"$ref": "#/$defs/WaterSubtype",
"default": "water"
"$ref": "#/$defs/WaterSubtype"
},
"theme": {
"const": "base",
Expand Down Expand Up @@ -540,7 +537,9 @@
"required": [
"theme",
"type",
"version"
"version",
"class",
"subtype"
],
"type": "object"
},
Expand Down
1 change: 1 addition & 0 deletions packages/overture-schema-theme-buildings/changelog.d/696.breaking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Buildings and building parts parsed without a `level` now yield `None` instead of `0`, following the removal of the `Stacked.level` default.
3 changes: 1 addition & 2 deletions packages/overture-schema-theme-buildings/tests/building_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,8 +561,7 @@
"type": "boolean"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand Down
3 changes: 1 addition & 2 deletions packages/overture-schema-theme-buildings/tests/building_part_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,8 +444,7 @@
"type": "boolean"
},
"level": {
"default": 0,
"description": "Z-order of the feature where 0 is visual level",
"description": "Z-order of the feature where 0 is visual level. A feature without a level is at visual level.",
"maximum": 2147483647,
"minimum": -2147483648,
"title": "Level",
Expand Down
1 change: 1 addition & 0 deletions packages/overture-schema-theme-transportation/changelog.d/696.breaking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed the `is_max_speed_variable` default of `False`; a rule parsed without the flag now yields `None` instead of `False`.
2 changes: 1 addition & 1 deletion ...verture-schema-theme-transportation/src/overture/schema/transportation/segment/_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ class SpeedLimitRule(BaseModel):
description="Indicates a variable speed corridor",
strict=True,
),
] = False
] = None


SpeedLimits = NewType(
Expand Down
1 change: 0 additions & 1 deletion packages/overture-schema-theme-transportation/tests/segment_baseline_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,6 @@
"type": "array"
},
"is_max_speed_variable": {
"default": false,
"description": "Indicates a variable speed corridor",
"title": "Is Max Speed Variable",
"type": "boolean"
Expand Down
Loading