Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion GLOSSARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ A Feature Type is a type of entities with common properties as described in the
Instance is a synonym for "Feature". The preferred term is "Feature".

# Object
Object is a synonym for "Instance" or "Feature". The prefered term is "Feature".
Object is a synonym for "Instance" or "Feature". The preferred term is "Feature".

2 changes: 1 addition & 1 deletion SCHEMA_CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Overture Features Types are strongly-typed. Feature Types are defined by three c
All measurements are expressed in SI units. The exact unit is confirmed in the specification of the property but is not repeated in the data

### Regulations and restrictions
All quantities that related to posted or ordenance regulations and restrictions are expressed in the same units as as used in the regulation. The unit is explicitly included with the property in the data.
All quantities that relate to posted or ordinance regulations and restrictions are expressed in the same units as used in the regulation. The unit is explicitly included with the property in the data.

### Opening hours/validity Periods
Opening Hours and the time frame during which time dependent properties are applicable are indicated following the [OSM Opening Hours specification] (https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification)
Expand Down
4 changes: 2 additions & 2 deletions docs/schema/concepts/by-theme/buildings/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The buildings theme has two feature types:

## Theme concepts

Both building and building_part types may have many **shape** related properties. These are useful for expressing the physical shape characteristics of the buidling including `roof_height`, `roof_shape`, `roof_material`, `facade_material`, etc.
Both building and building_part types may have many **shape** related properties. These are useful for expressing the physical shape characteristics of the building including `roof_height`, `roof_shape`, `roof_material`, `facade_material`, etc.

### Properties derived from OpenStreetMap tags

Expand Down Expand Up @@ -114,7 +114,7 @@ There are a handful of common formatting issues that we generally allow when par
```sql
^\s*\d+(\.\d*)?\s*(m|meter|metre)s?\s*$
```
Height strings with a number follwed by a metric unit that matches the singular
Height strings with a number followed by a metric unit that matches the singular
or plural version form of `m`, `meter`, and `metre` strings after the number are
also treated as meters and the units are stripped. These values are not rounded.
Examples:
Expand Down
2 changes: 1 addition & 1 deletion docs/schema/concepts/by-theme/transportation/roads.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import ExampleTurnRestriction2Connector1 from '!!raw-loader!@site/docs/_examples
import ExampleTurnRestriction2Connector2 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-connector2.yaml';

In the Overture transportation theme, a road is any kind of road,
street, or path, including a dedicated paths for walking or cycling. (Railways and waterways are separate subtypes in the transportation schema.) Road segments comprise the majority of ground-based transportation segments. Roads are modeled using [segment](/schema/reference/transportation/segment) features with the `subtype` property value set to the value `road`.
street, or path, including dedicated paths for walking or cycling. (Railways and waterways are separate subtypes in the transportation schema.) Road segments comprise the majority of ground-based transportation segments. Roads are modeled using [segment](/schema/reference/transportation/segment) features with the `subtype` property value set to the value `road`.

This document describes properties specific to the `road` subtype. For more general information regarding segments, please refer to the [segments concept overview](/schema/concepts/by-theme/transportation/segments).

Expand Down
4 changes: 2 additions & 2 deletions docs/schema/concepts/by-theme/transportation/travel-modes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ unique, but order is not important.

#### Vehicle attribute scoping: `vehicle`

Because travel modes are an fuzzy concept, there are inevitably areas
Because travel modes are a fuzzy concept, there are inevitably areas
of overlap between with the more precise, but more limited, `vehicle`
scoping property which is used for [vehicle attributes scoping](/schema/concepts/scoping-rules#vehicle-attributes-scoping). Where there is potential overlap, the method of scoping used in Overture data releases will depend on how the upstream data source has expressed the equivalent concept. Where there is choice, it is preferable to select the scoping method that most accurately reflects the intention expressed on local signage.

Expand Down Expand Up @@ -151,7 +151,7 @@ diagram below.
As many of the above travel modes draw on the body of knowledge
accumulated in relation to OpenStreetMap
[transport mode access restrictions](https://wiki.openstreetmap.org/wiki/Key:access#Transport_mode_restrictions),
Overture Maps would like acknowledge a intellectual debt to the OSM community in
Overture Maps would like to acknowledge an intellectual debt to the OSM community in
relation to travel modes as well as to other aspects of the transportation schema.

## Open questions
Expand Down
5 changes: 2 additions & 3 deletions docs/schema/concepts/scoping-rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,16 @@ detail.

A travel mode is a way of moving about the transportation network, for example driving in a motor vehicle, or, more specifically, driving in a high-occupancy vehicle.

The property construct `when: { mode: [...] }` limits the scope its parent value to apply only to people or things travelling using the listed travel modes.
The property construct `when: { mode: [...] }` limits the scope of its parent value to apply only to people or things travelling using the listed travel modes.

To dive deeper into this topic, see the page on [travel modes](https://docs.overturemaps.org/guides/transportation/travel-modes).

#### Heading
#### Heading

<Tabs>
<TabItem value="description" label="Description" default>

Heading scoping limits the the scope of a parent value to apply only when the traveller is proceeding along the segment geometry in the named direction, either `forward` or `backward`.
Heading scoping limits the scope of a parent value to apply only when the traveller is proceeding along the segment geometry in the named direction, either `forward` or `backward`.
(*The directions `forward` and `backward` are defined on the [shape and connectivity](https://docs.overturemaps.org/guides/transportation/shape-connectivity) page.*)

The property construct `when: { heading: forward|backward }` applies heading scoping to a parent value.
Expand Down
2 changes: 1 addition & 1 deletion docs/schema/reference/divisions/division.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ A division is a recognized official or non-official organization of people as se

## Subtypes

While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today.

Currently, the following subtypes are available in the `division` feature type:

Expand Down
4 changes: 2 additions & 2 deletions docs/schema/reference/divisions/division_area.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ A division area is a polygon that represents the land or maritime area associate

## Subtypes

While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today.

Currently, the following subtypes are available in the `division_area` feature type:

Expand All @@ -63,7 +63,7 @@ Currently, the following subtypes are available in the `division_area` feature t
</table>


A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States
A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States

</TabItem>

Expand Down
4 changes: 2 additions & 2 deletions docs/schema/reference/divisions/division_boundary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ of a division.

## Subtypes

While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today.

Currently, the following subtypes are available in the `division_boundary` feature type:

Expand All @@ -63,7 +63,7 @@ Currently, the following subtypes are available in the `division_boundary` featu
</table>


A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States
A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States

</TabItem>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ class Infrastructure(
SourcedFromOpenStreetMap,
):
"""
Infrastructure features provide basic information about real-world infrastructure entitites
Infrastructure features provide basic information about real-world infrastructure entities
such as bridges, airports, runways, aerialways, communication towers, and power lines.
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ class LandUse(
activity, recreation, farming, housing, education, or military use.

Land use features relate to `LandCover` features in the following way: land use is the human
human activity being done with the land, while land cover is the physical thing that covers it.
activity being done with the land, while land cover is the physical thing that covers it.

TODO: Explain relationship to `Land` features.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@
}
},
"additionalProperties": false,
"description": "Infrastructure features provide basic information about real-world infrastructure entitites\nsuch as bridges, airports, runways, aerialways, communication towers, and power lines.",
"description": "Infrastructure features provide basic information about real-world infrastructure entities\nsuch as bridges, airports, runways, aerialways, communication towers, and power lines.",
"properties": {
"bbox": {
"description": "An optional bounding box for the feature",
Expand Down Expand Up @@ -629,7 +629,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@
}
},
"additionalProperties": false,
"description": "Land use features specify the predominant human use of an area of land, for example commercial\nactivity, recreation, farming, housing, education, or military use.\n\nLand use features relate to `LandCover` features in the following way: land use is the human\nhuman activity being done with the land, while land cover is the physical thing that covers it.\n\nTODO: Explain relationship to `Land` features.",
"description": "Land use features specify the predominant human use of an area of land, for example commercial\nactivity, recreation, farming, housing, education, or military use.\n\nLand use features relate to `LandCover` features in the following way: land use is the human\nactivity being done with the land, while land cover is the physical thing that covers it.\n\nTODO: Explain relationship to `Land` features.",
"properties": {
"bbox": {
"description": "An optional bounding box for the feature",
Expand Down Expand Up @@ -580,7 +580,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@
},
"patternProperties": {
"^ext_.*$": {
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
"description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic."
}
},
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
class OvertureFeature(Identified, Feature, Generic[ThemeT, TypeT]):
"""Base class for all Overture features."""

# Only used to suport `ext_*` fields, which are on a deprecation path.
# Only used to support `ext_*` fields, which are on a deprecation path.
model_config = ConfigDict(extra="allow")

# Required
Expand Down Expand Up @@ -89,7 +89,7 @@ def __get_pydantic_json_schema__(
"description": textwrap.dedent("""
Additional top-level properties are allowed if prefixed by `ext_`.

This feature is a on a deprecation path and will be removed once the schema is
This feature is on a deprecation path and will be removed once the schema is
fully migrated to Pydantic.
""").strip(),
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
Perhaps a tunnel is 10 meters deep for the first 100 meters, then rises a bit to only 7 meters deep
for the next 100 meters. These depth observations would be modeled in the Overture schema using
geometric range scoping (linear referencing): you would give your tunnel model an array of depth
obervations, and each observation would contain a linearly-referenced depth value.
observations, and each observation would contain a linearly-referenced depth value.

>>> from typing import Annotated, Literal
>>> from pydantic import BaseModel
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class Scope(str, Enum):
In order to add `when.heading`, this scope will place it into a containing `when` field in the
model it decorates. The type of the `when` field will be a new model class named `When` that
will be added as a nested class of the decorated model. Consequently, the decorated model must
not aready have a `when` field or a nested class named `When`.
not already have a `when` field or a nested class named `When`.
"""

TEMPORAL = "temporal"
Expand All @@ -78,7 +78,7 @@ class Scope(str, Enum):
In order to add `when.during`, this scope will place it into a containing `when` field in the
model it decorates. The type of the `when` field will be a new model class named `When` that
will be added as a nested class of the decorated model. Consequently, the decorated model must
not aready have a `when` field or a nested class named `When`.
not already have a `when` field or a nested class named `When`.
"""

TRAVEL_MODE = "travel_mode"
Expand All @@ -104,7 +104,7 @@ class Scope(str, Enum):
In order to add `when.using`, this scope will place it into a containing `when` field in the
model it decorates. The type of the `when` field will be a new model class named `When` that
will be added as a nested class of the decorated model. Consequently, the decorated model must
not aready have a `when` field or a nested class named `When`.
not already have a `when` field or a nested class named `When`.
"""

RECOGNIZED_STATUS = "recognized_status"
Expand All @@ -118,7 +118,7 @@ class Scope(str, Enum):
In order to add `when.recognized`, this scope will place it into a containing `when` field in
the model it decorates. The type of the `when` field will be a new model class named `When` that
will be added as a nested class of the decorated model. Consequently, the decorated model must
not aready have a `when` field or a nested class named `When`.
not already have a `when` field or a nested class named `When`.
"""

SIDE = "side"
Expand All @@ -144,7 +144,7 @@ class Scope(str, Enum):
In order to add `when.vehicle`, this scope will place it into a containing `when` field in the
model it decorates. The type of the `when` field will be a new model class named `When` that
will be added as a nested class of the decorated model. Consequently, the decorated model must
not aready have a `when` field or a nested class named `When`.
not already have a `when` field or a nested class named `When`.
"""

def _field(self, parent: str, required: bool) -> object:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Types supporting the trravel mode scope.
Types supporting the travel mode scope.
"""

from enum import Enum
Expand Down
Loading
Loading