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
20 changes: 10 additions & 10 deletions docs/schema/reference/addresses/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ provinces, state, and regions, and similar addressing units are found.
| -----: | :----: | ------------- |
| `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. |
| `bbox` | `bbox` (optional) | An optional bounding box for the feature |
| `geometry` | `geometry` | Position of the address. Addresses are point geometries. |
| `theme` | `"addresses"` | |
| `type` | `"address"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `geometry` | `geometry` | Position of the address. Addresses are point geometries.<br/>*Allowed geometry types: Point* |
| `theme` | `"addresses"` | |
| `type` | `"address"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. |
| `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.<br/><br/>The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.<br/><br/>Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. |
| `sources[].dataset` | `string` | Name of the dataset where the source data can be found. |
Expand All @@ -37,14 +37,14 @@ provinces, state, and regions, and similar addressing units are found.
| `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. |
| `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.<br/><br/>This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. |
| `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. |
| `address_levels[]` | `list<`[`AddressLevel`](types/address_level.md)`>` (optional) | Names of the sub-country addressing areas the address belongs to, including the city or locality, in descending order of generality.<br/><br/>The list is sorted so that the highest, or most general, level comes first (*e.g.*, region) and the lowest, or most particular level, comes last (*e.g.*, city or town).<br/><br/>The number of items in this list and their meaning is country-dependent. For example, in the United States, we expect two items: the state, and the locality or municipality within the state. Other countries might have as few as one, or even three or more.<br/><br/>When a specific level that is required for a country is not known. most likely because the data provider has not supplied it and we have not derived it from another source, the list item corresponding to that level must be present, but its `value` field should be omitted. |
| `address_levels[]` | `list<`[`AddressLevel`](types/address_level.md)`>` (optional) | Names of the sub-country addressing areas the address belongs to, including the city or locality, in descending order of generality.<br/><br/>The list is sorted so that the highest, or most general, level comes first (*e.g.*, region) and the lowest, or most particular level, comes last (*e.g.*, city or town).<br/><br/>The number of items in this list and their meaning is country-dependent. For example, in the United States, we expect two items: the state, and the locality or municipality within the state. Other countries might have as few as one, or even three or more.<br/><br/>When a specific level that is required for a country is not known. most likely because the data provider has not supplied it and we have not derived it from another source, the list item corresponding to that level must be present, but its `value` field should be omitted.<br/>*`minimum length: 1`*<br/>*`maximum length: 5`* |
| `address_levels[].value` | [`StrippedString`](../system/stripped_string.md) (optional) | A string without leading or trailing whitespace |
| `country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) | The country the address belongs to, as an ISO 3166-1 alpha-2 country code. |
| `number` | [`StrippedString`](../system/stripped_string.md) (optional) | The house number.<br/><br/>This field does not necessarily contain an integer or even a number. Values such as "74B", "189 1/2", and "208.5", where the non-integer or non-number part is part of the house number, not a unit number, are in common use. |
| `postal_city` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal authority designated city name, if applicable.<br/><br/>In some countries or regions, a mailing address may need to specify a different city name than the city that actually contains the address coordinates. This optional field can be used to specify the alternate city name to use.<br/><br/>For example:<br/><br/>- The postal city for the US address *716 East County Road, Winchester, Indiana* is Ridgeville. - The postal city for the Slovenian address *Tomaj 71, 6221 Tomaj, Slovenia* is Dutovlje. |
| `postcode` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal code. |
| `street` | [`StrippedString`](../system/stripped_string.md) (optional) | The street name.<br/><br/>The street name can include a type (*e.g.*, "Street" or "St", "Boulevard" or "Blvd", *etc.*) and a directional (*e.g.*, "NW" or "Northwest", "S" or "Sud"). Both type and directional, if present, may be either a prefix or a suffix to the primary name. They may either be fully spelled-out or abbreviated. |
| `unit` | [`StrippedString`](../system/stripped_string.md) (optional) | The secondary address unit designator.<br/><br/>In the case where the primary street address is divided into secondary units, which may be apartments, floors, or even buildings if the primary street address is a campus, this field names the specific secondary unit being addressed. |
| `number` | [`StrippedString`](../system/stripped_string.md) (optional) | The house number.<br/><br/>This field does not necessarily contain an integer or even a number. Values such as "74B", "189 1/2", and "208.5", where the non-integer or non-number part is part of the house number, not a unit number, are in common use.<br/>*`minimum length: 1`* |
| `postal_city` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal authority designated city name, if applicable.<br/><br/>In some countries or regions, a mailing address may need to specify a different city name than the city that actually contains the address coordinates. This optional field can be used to specify the alternate city name to use.<br/><br/>For example:<br/><br/>- The postal city for the US address *716 East County Road, Winchester, Indiana* is Ridgeville. - The postal city for the Slovenian address *Tomaj 71, 6221 Tomaj, Slovenia* is Dutovlje.<br/>*`minimum length: 1`* |
| `postcode` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal code.<br/>*`minimum length: 1`* |
| `street` | [`StrippedString`](../system/stripped_string.md) (optional) | The street name.<br/><br/>The street name can include a type (*e.g.*, "Street" or "St", "Boulevard" or "Blvd", *etc.*) and a directional (*e.g.*, "NW" or "Northwest", "S" or "Sud"). Both type and directional, if present, may be either a prefix or a suffix to the primary name. They may either be fully spelled-out or abbreviated.<br/>*`minimum length: 1`* |
| `unit` | [`StrippedString`](../system/stripped_string.md) (optional) | The secondary address unit designator.<br/><br/>In the case where the primary street address is divided into secondary units, which may be apartments, floors, or even buildings if the primary street address is a campus, this field names the specific secondary unit being addressed.<br/>*`minimum length: 1`* |

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/schema/reference/addresses/types/address_level.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ countries and regions, address levels do not necessarily correspond to administr

| Name | Type | Description |
| -----: | :----: | ------------- |
| `value` | [`StrippedString`](../../system/stripped_string.md) (optional) | A string without leading or trailing whitespace |
| `value` | [`StrippedString`](../../system/stripped_string.md) (optional) | A string without leading or trailing whitespace<br/>*`minimum length: 1`* |

## Used By

Expand Down
10 changes: 5 additions & 5 deletions docs/schema/reference/base/bathymetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ lake beds or ocean floors.
| -----: | :----: | ------------- |
| `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. |
| `bbox` | `bbox` (optional) | An optional bounding box for the feature |
| `geometry` | `geometry` | Shape of the underwater area, which may be a polygon or multi-polygon. |
| `theme` | `"base"` | |
| `type` | `"bathymetry"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `geometry` | `geometry` | Shape of the underwater area, which may be a polygon or multi-polygon.<br/>*Allowed geometry types: MultiPolygon, Polygon* |
| `theme` | `"base"` | |
| `type` | `"bathymetry"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. |
| `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.<br/><br/>The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.<br/><br/>Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. |
| `sources[].dataset` | `string` | Name of the dataset where the source data can be found. |
Expand All @@ -26,7 +26,7 @@ lake beds or ocean floors.
| `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.<br/><br/>This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. |
| `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. |
| `depth` | [`Depth`](types/depth.md) | Depth below surface level of the feature in meters. |
| `cartography` | [`CartographicHints`](../core/cartographic_hints.md) (optional) | |
| `cartography` | [`CartographicHints`](../core/cartographic_hints.md) (optional) | |
| `cartography.prominence` | [`Prominence`](../core/prominence.md) (optional) | Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant.<br/><br/>This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features.<br/><br/>When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. |
| `cartography.min_zoom` | [`MinZoom`](../core/min_zoom.md) (optional) | Recommended minimum tile zoom level in which this feature should be displayed.<br/><br/>It is recommended that the feature be hidden at zoom levels below this value.<br/><br/>Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection |
| `cartography.max_zoom` | [`MaxZoom`](../core/max_zoom.md) (optional) | Recommended maximum tile zoom level in which this feature should be displayed.<br/><br/>It is recommended that the feature be hidden at zoom levels above this value.<br/><br/>Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection |
Expand Down
18 changes: 9 additions & 9 deletions docs/schema/reference/base/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| -----: | :----: | ------------- |
| `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. |
| `bbox` | `bbox` (optional) | An optional bounding box for the feature |
| `geometry` | `geometry` | Geometry of the infrastructure feature, which may be a point, line string, polygon, or multi-polygon. |
| `theme` | `"base"` | |
| `type` | `"infrastructure"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `geometry` | `geometry` | Geometry of the infrastructure feature, which may be a point, line string, polygon, or multi-polygon.<br/>*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* |
| `theme` | `"base"` | |
| `type` | `"infrastructure"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
| `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. |
| `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.<br/><br/>The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.<br/><br/>Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. |
| `sources[].dataset` | `string` | Name of the dataset where the source data can be found. |
Expand All @@ -25,13 +25,13 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. |
| `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.<br/><br/>This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. |
| `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. |
| `class` | [`InfrastructureClass`](types/infrastructure_class.md) | |
| `subtype` | [`InfrastructureSubtype`](types/infrastructure_subtype.md) | |
| `class` | [`InfrastructureClass`](types/infrastructure_class.md) | |
| `subtype` | [`InfrastructureSubtype`](types/infrastructure_subtype.md) | |
| `height` | [`Height`](types/height.md) (optional) | Height of the feature in meters. |
| `surface` | [`SurfaceMaterial`](types/surface_material.md) (optional) | |
| `names` | [`Names`](../core/names.md) (optional) | |
| `surface` | [`SurfaceMaterial`](types/surface_material.md) (optional) | |
| `names` | [`Names`](../core/names.md) (optional) | |
| `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. |
| `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | |
| `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | |
| `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. |
| `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. |
| `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. |
Expand Down
Loading