Skip to content
Open
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: 12 additions & 8 deletions docs/schema/reference/addresses/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ provinces, state, and regions, and similar addressing units are found.
| Name | Type | Description |
| -----: | :----: | ------------- |
| `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.<br/>*Allowed geometry types: Point* |
| `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature |
| `geometry` | [`geometry`](../system/primitive/geometry.md) | Position of the address. Addresses are point geometries.<br/><br/>*Allowed geometry types: Point* |
| `theme` | `"addresses"` | |
| `type` | `"address"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
Expand All @@ -37,20 +37,24 @@ 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.<br/>*`minimum length: 1`*<br/>*`maximum length: 5`* |
| `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/><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.<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`* |
| `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/><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/><br/>*Minimum length: 1* |
| `postcode` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal code.<br/><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/><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/><br/>*Minimum length: 1* |

## Examples

| Column | Value |
| -------: | ------- |
| `id` | `416ab01c-d836-4c4f-aedc-2f30941ce94d` |
| `bbox.xmin` | `-176.56381225585938` |
| `bbox.xmax` | `-176.56378173828125` |
| `bbox.ymin` | `-43.94719696044922` |
| `bbox.ymax` | `-43.94718933105469` |
| `geometry` | `POINT (-176.5637854 -43.9471955)` |
| `theme` | `addresses` |
| `type` | `address` |
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<br/>*`minimum length: 1`* |
| `value` | [`StrippedString`](../../system/stripped_string.md) (optional) | A string without leading or trailing whitespace<br/><br/>*Minimum length: 1* |

## Used By

Expand Down
10 changes: 7 additions & 3 deletions docs/schema/reference/base/bathymetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ lake beds or ocean floors.
| Name | Type | Description |
| -----: | :----: | ------------- |
| `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.<br/>*Allowed geometry types: MultiPolygon, Polygon* |
| `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature |
| `geometry` | [`geometry`](../system/primitive/geometry.md) | Shape of the underwater area, which may be a polygon or multi-polygon.<br/><br/>*Allowed geometry types: MultiPolygon, Polygon* |
| `theme` | `"base"` | |
| `type` | `"bathymetry"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
Expand All @@ -37,7 +37,11 @@ lake beds or ocean floors.
| Column | Value |
| -------: | ------- |
| `id` | `5d40bd6c-db14-5492-b29f-5e25a59032bc` |
| `geometry` | `MULTIPOLYGON (((-170.71296928 -76.744313428, -170.719841483 -76.757076376, -170.731061124 -76.761566...` |
| `bbox.xmin` | `-175.12791442871094` |
| `bbox.xmax` | `-170.05111694335938` |
| `bbox.ymin` | `-77.9718246459961` |
| `bbox.ymax` | `-75.64299774169922` |
| `geometry` | `MULTIPOLYGON (((-170.71296928 -76.744313428, -170.719841483 -76.757076376, -170.731061124 -76.761...` |
| `theme` | `base` |
| `type` | `bathymetry` |
| `version` | `0` |
Expand Down
17 changes: 8 additions & 9 deletions docs/schema/reference/base/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| Name | Type | Description |
| -----: | :----: | ------------- |
| `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.<br/>*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* |
| `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature |
| `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the infrastructure feature, which may be a point, line string, polygon, or multi-polygon.<br/><br/>*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* |
| `theme` | `"base"` | |
| `type` | `"infrastructure"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
Expand All @@ -38,7 +38,7 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. |
| `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. |
| `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. |
| `names.rules[].perspectives.countries` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) (list) | Countries holding the given mode of perspective. |
| `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. |
| `names.rules[].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 NameRule applies to. |
| `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. |
| `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level |
Expand All @@ -50,6 +50,10 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| Column | Value |
| -------: | ------- |
| `id` | `e9e3d506-89c0-3473-8cee-5e5ac6596d6c` |
| `bbox.xmin` | `-180.0` |
| `bbox.xmax` | `-179.99998474121094` |
| `bbox.ymin` | `-82.42408752441406` |
| `bbox.ymax` | `-82.42407989501953` |
| `geometry` | `POINT (-179.9999994 -82.42408)` |
| `theme` | `base` |
| `type` | `infrastructure` |
Expand All @@ -68,10 +72,5 @@ such as bridges, airports, runways, aerialways, communication towers, and power
| `names.common` | `null` |
| `names.rules` | `null` |
| `level` | `null` |
| `source_tags.description` | `1036 km to South Pole.` |
| `source_tags.information` | `route_marker` |
| `source_tags.note` | `The road continue in west side of the map` |
| `source_tags.start_date` | `2007` |
| `source_tags.tourism` | `information` |
| `source_tags.wikipedia` | `en:South Pole Traverse` |
| `source_tags` | `{"description": "1036 km to South Pole.", "information": "route_marker", "note": "The road contin...` |
| `wikidata` | `Q800558` |
14 changes: 8 additions & 6 deletions docs/schema/reference/base/land.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ TODO: Update this description when the relationship to `land_cover` is better un
| Name | Type | Description |
| -----: | :----: | ------------- |
| `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 land feature, which may be a point, line string, polygon, or multi-polygon.<br/>*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* |
| `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature |
| `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the land feature, which may be a point, line string, polygon, or multi-polygon.<br/><br/>*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* |
| `theme` | `"base"` | |
| `type` | `"land"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
Expand All @@ -48,7 +48,7 @@ TODO: Update this description when the relationship to `land_cover` is better un
| `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. |
| `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. |
| `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. |
| `names.rules[].perspectives.countries` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) (list) | Countries holding the given mode of perspective. |
| `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. |
| `names.rules[].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 NameRule applies to. |
| `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. |
| `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level |
Expand All @@ -60,6 +60,10 @@ TODO: Update this description when the relationship to `land_cover` is better un
| Column | Value |
| -------: | ------- |
| `id` | `70fc3596-a987-3fea-820c-c016c0a2f0da` |
| `bbox.xmin` | `-178.7000274658203` |
| `bbox.xmax` | `-178.6999969482422` |
| `bbox.ymin` | `-85.45001220703125` |
| `bbox.ymax` | `-85.44999694824219` |
| `geometry` | `POINT (-178.7 -85.45)` |
| `theme` | `base` |
| `type` | `land` |
Expand All @@ -78,7 +82,5 @@ TODO: Update this description when the relationship to `land_cover` is better un
| `names.common` | `null` |
| `names.rules` | `null` |
| `level` | `null` |
| `source_tags.natural` | `cliff` |
| `source_tags.ref:linz:place_id` | `12318` |
| `source_tags.wikipedia` | `en:Dismal Buttress` |
| `source_tags` | `{"natural": "cliff", "ref:linz:place_id": "12318", "wikipedia": "en:Dismal Buttress"}` |
| `wikidata` | `Q5282342` |
10 changes: 7 additions & 3 deletions docs/schema/reference/base/land_cover.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ TODO: Explain relationship to `Land` features.
| Name | Type | Description |
| -----: | :----: | ------------- |
| `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 covered land area, which may be a polygon or multi-polygon.<br/>*Allowed geometry types: MultiPolygon, Polygon* |
| `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature |
| `geometry` | [`geometry`](../system/primitive/geometry.md) | Shape of the covered land area, which may be a polygon or multi-polygon.<br/><br/>*Allowed geometry types: MultiPolygon, Polygon* |
| `theme` | `"base"` | |
| `type` | `"land_cover"` | |
| `version` | [`FeatureVersion`](../core/feature_version.md) | |
Expand All @@ -44,7 +44,11 @@ TODO: Explain relationship to `Land` features.
| Column | Value |
| -------: | ------- |
| `id` | `c347312d-012b-5e73-8bd3-a10d04b2981d` |
| `geometry` | `POLYGON ((-179.99877531181616 65.95172539425603, -179.99740705536922 65.95265577758867, -179.9975172...` |
| `bbox.xmin` | `-180.0001983642578` |
| `bbox.xmax` | `-179.99313354492188` |
| `bbox.ymin` | `65.95172119140625` |
| `bbox.ymax` | `65.96218872070312` |
| `geometry` | `POLYGON ((-179.99877531181616 65.95172539425603, -179.99740705536922 65.95265577758867, -179.9975...` |
| `theme` | `base` |
| `type` | `land_cover` |
| `version` | `0` |
Expand Down
Loading