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 docs/getting-data/duckdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Download all pizza restaurants in New York City as a `GeoJSON` file.

<QueryBuilder query={NewYorkPizza}></QueryBuilder>

See the [places schema](/schema/reference/places/place) to learn more about each attribute or the [common schema concepts](/schema/reference/core/names) to better understand `names.primary` from `names.common`.
See the [places schema](/schema/reference/places/place) to learn more about each attribute or the [common schema concepts](/schema/reference/common/names) to better understand `names.primary` from `names.common`.
</TabItem>

<TabItem value="Buildings" label="Buildings">
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/transportation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ This example selects all the segments that that connect to the example id.
|:--|
| *Conceptual diagram of the splitter tool output. The numbers following 1234@ represent start_lr and end_lr values.* |

The [transportation-spitter tool](https://github.com/OvertureMaps/transportation-splitter) transforms Overture road data into simpler sub-segments. It will optionally divide features at each connector point and at each change of a [scoped based property](/schema/reference/core/scoping/linearly_referenced_range), depending on configuration. Depending on your needs and map stack, the resulting dataset may be easier to manipulate than the original Overture data as each segment will only have connections at either end and have one set of properties for its entire length.
The [transportation-spitter tool](https://github.com/OvertureMaps/transportation-splitter) transforms Overture road data into simpler sub-segments. It will optionally divide features at each connector point and at each change of a [scoped based property](/schema/reference/common/scoping/linearly_referenced_range), depending on configuration. Depending on your needs and map stack, the resulting dataset may be easier to manipulate than the original Overture data as each segment will only have connections at either end and have one set of properties for its entire length.

Since a GERS ID will no longer be unique with this output, the resulting data will have two additional columns: `start_lr` and `end_lr` which are linear references describing which section of the original feature this new segment comes from.

Expand Down
18 changes: 12 additions & 6 deletions docs/schema/reference/addresses/address.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_position: 1
hide_table_of_contents: true
---

# Address
Expand Down Expand Up @@ -29,15 +28,18 @@ provinces, state, and regions, and similar addressing units are found.
| `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) | |
| `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. |
| `version` | [`FeatureVersion`](../common/feature_version.md) | |
| `sources[]` | [`Sources`](../common/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. |
| `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.<br/><br/>This should be a valid SPDX license identifier when available.<br/><br/>If omitted, contact the data provider for more license information. |
| `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.<br/><br/>The format of record identifiers is dataset-specific. |
| `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. |
| `sources[].confidence` | [`ConfidenceScore`](../common/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[].provider` | [`SnakeCaseString`](../system/snake_case_string.md) (optional) | The provider label for the entity that contributed this data (e.g., osm, meta, esri). |
| `sources[].resource` | [`SnakeCaseString`](../system/snake_case_string.md) (optional) | The subject or type of data contributed by the provider (e.g., planet, buildings, division_names). |
| `sources[].version` | [`NoWhitespaceString`](../system/no_whitespace_string.md) (optional) | A sortable identifier for the specific snapshot of the resource (e.g., 2026-02-13, 5.3, A5692). |
| `sources[].between` | [`LinearlyReferencedRange`](../common/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/><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. |
Expand All @@ -53,18 +55,22 @@ provinces, state, and regions, and similar addressing units are found.
| -------: | ------- |
| `id` | `416ab01c-d836-4c4f-aedc-2f30941ce94d` |
| `bbox.xmin` | `-176.56381225585938` |
| `bbox.xmax` | `-176.56378173828125` |
| `bbox.ymin` | `-43.94719696044922` |
| `bbox.xmax` | `-176.56378173828125` |
| `bbox.ymax` | `-43.94718933105469` |
| `geometry` | `POINT (-176.5637854 -43.9471955)` |
| `theme` | `addresses` |
| `type` | `address` |
| `version` | `1` |
| `sources[0].property` | |
| `sources[0].dataset` | `OpenAddresses/LINZ` |
| `sources[0].license` | `null` |
| `sources[0].record_id` | `null` |
| `sources[0].update_time` | `null` |
| `sources[0].confidence` | `null` |
| `sources[0].provider` | `null` |
| `sources[0].resource` | `null` |
| `sources[0].version` | `null` |
| `sources[0].between` | `null` |
| `address_levels[0].value` | `Chatham Islands` |
| `address_levels[1].value` | `Chatham Island` |
Expand Down
4 changes: 0 additions & 4 deletions docs/schema/reference/addresses/types/address_level.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
hide_table_of_contents: true
---

# AddressLevel

A sub-country addressing unit, such as a region, city, or neighborhood, that is less specific
Expand Down
4 changes: 4 additions & 0 deletions docs/schema/reference/annex/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Annex",
"position": 2
}
41 changes: 41 additions & 0 deletions docs/schema/reference/annex/sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1
---

# Sources

Common schema definitions for data sources.

## Fields

| Name | Type | Description |
| -----: | :----: | ------------- |
| `datasets[]` | `list<`[`Dataset`](types/dataset.md)`>` | List of data source entries used by Overture. |
| `datasets[].source_name` | `string` | The name of the source. |
| `datasets[].source_dataset_name` | `string` | The name of the dataset being used from the source. This should match the 'dataset' value found in a record's sources column. |
| `datasets[].data_url` | [`HttpUrl`](../pydantic/networks/http_url.md) | The data page or data portal of this source, typically includes links to data downloads and license links. |
| `datasets[].data_url_archived` | [`HttpUrl`](../pydantic/networks/http_url.md) | URL of the source's data page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `datasets[].license_url` | [`HttpUrl`](../pydantic/networks/http_url.md) | A link to this source's data license or page referencing the license associated with the data being imported. This should include explicit license terms. |
| `datasets[].license_url_archived` | [`HttpUrl`](../pydantic/networks/http_url.md) | URL of the source's license page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `datasets[].license_type` | `string` | The license that is associated with the data being used from this source. This should be a valid SPDX license identifier when available. |
| `datasets[].license_text` | `string` | Any relevant license text, direct from the source's license page. |
| `datasets[].license_attribution` | `string` | Any attribution required by this source. |
| `datasets[].coverage_bbox` | `list<float64>` | The bounding box, in [xmin, ymin, xmax, ymax] format, of this source's coverage. |
| `datasets[].inception_date` | `date` (optional) | The first date this source was used in the Overture addresses theme, in YYYY-MM-DD format. |
| `datasets[].url` | [`HttpUrl`](../pydantic/networks/http_url.md) (optional) | The home page of this source. |
| `datasets[].url_archived` | [`HttpUrl`](../pydantic/networks/http_url.md) (optional) | URL of the source's home page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `datasets[].data_download_url` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | Either a direct download link of data from this source, typically a geo-format or compressed file, or an endpoint from where the data was obtained for use within Overture. |
| `datasets[].countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` (optional) | A list of two-character iso country codes that this data source provides data in. |
| `datasets[].coverage_description` | `string` (optional) | A description of the coverage type of the source data - i.e. national, regional, local. |
| `datasets[].data_layer_name` | `string` (optional) | Name of the data layer used from this source. |
| `datasets[].oa_path` | `list<string>` (optional) | File path and name in OpenAddresses, if existing. |
| `datasets[].address_levels` | `list<string>` (optional) | Available address level attributes from OpenAddress, if existing. |
| `datasets[].file_format` | `string` (optional) | Format of the file used from this source. |
| `datasets[].update_frequency` | `string` (optional) | How frequently the source data is updated upstream. |
| `datasets[].build_source` | [`BuildSource`](types/build_source.md) (optional) | |
| `datasets[].update_type` | [`UpdateType`](types/update_type.md) (optional) | |
| `datasets[].update_schedule` | `list<string>` (optional) | The month or months in which the data is to be re-ingested by the Overture theme using this data source. |
| `datasets[].known_issues` | `string` (optional) | A description of any issues with the data that are known - i.e. data is incomplete, coverage is incomplete, or issues with character encoding. |
| `datasets[].notes` | `string` (optional) | Freeform notes about this data source, including notes on any pre-processing requirements. |
| `datasets[].requires_attribution` | `string` (optional) | Whether this source requires attribution to be used in Overture Maps. |
| `license_priority` | `map<LicenseShortname, int64>` | Map of license shortnames to their priority (lower number indicates higher priority). |
3 changes: 3 additions & 0 deletions docs/schema/reference/annex/types/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Types"
}
12 changes: 12 additions & 0 deletions docs/schema/reference/annex/types/build_source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# BuildSource

The ingest source for address data.

## Values

- `OpenAddresses`
- `tf-data-platform`

## Used By

- [`Dataset`](dataset.md)
39 changes: 39 additions & 0 deletions docs/schema/reference/annex/types/dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Dataset

Dataset definition for Overture Maps data sources.

## Fields

| Name | Type | Description |
| -----: | :----: | ------------- |
| `source_name` | `string` | The name of the source. |
| `source_dataset_name` | `string` | The name of the dataset being used from the source. This should match the 'dataset' value found in a record's sources column. |
| `data_url` | [`HttpUrl`](../../pydantic/networks/http_url.md) | The data page or data portal of this source, typically includes links to data downloads and license links. |
| `data_url_archived` | [`HttpUrl`](../../pydantic/networks/http_url.md) | URL of the source's data page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `license_url` | [`HttpUrl`](../../pydantic/networks/http_url.md) | A link to this source's data license or page referencing the license associated with the data being imported. This should include explicit license terms. |
| `license_url_archived` | [`HttpUrl`](../../pydantic/networks/http_url.md) | URL of the source's license page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `license_type` | `string` | The license that is associated with the data being used from this source. This should be a valid SPDX license identifier when available. |
| `license_text` | `string` | Any relevant license text, direct from the source's license page. |
| `license_attribution` | `string` | Any attribution required by this source. |
| `coverage_bbox` | `list<float64>` | The bounding box, in [xmin, ymin, xmax, ymax] format, of this source's coverage.<br/><br/>*Minimum length: 4*<br/>*Maximum length: 4* |
| `inception_date` | `date` (optional) | The first date this source was used in the Overture addresses theme, in YYYY-MM-DD format. |
| `url` | [`HttpUrl`](../../pydantic/networks/http_url.md) (optional) | The home page of this source. |
| `url_archived` | [`HttpUrl`](../../pydantic/networks/http_url.md) (optional) | URL of the source's home page, stored on archive.org, at or near the date the source data was obtained for use within Overture. |
| `data_download_url` | `list<`[`HttpUrl`](../../pydantic/networks/http_url.md)`>` (optional) | Either a direct download link of data from this source, typically a geo-format or compressed file, or an endpoint from where the data was obtained for use within Overture. |
| `countries` | `list<`[`CountryCodeAlpha2`](../../system/country_code_alpha2.md)`>` (optional) | A list of two-character iso country codes that this data source provides data in. |
| `coverage_description` | `string` (optional) | A description of the coverage type of the source data - i.e. national, regional, local. |
| `data_layer_name` | `string` (optional) | Name of the data layer used from this source. |
| `oa_path` | `list<string>` (optional) | File path and name in OpenAddresses, if existing. |
| `address_levels` | `list<string>` (optional) | Available address level attributes from OpenAddress, if existing. |
| `file_format` | `string` (optional) | Format of the file used from this source. |
| `update_frequency` | `string` (optional) | How frequently the source data is updated upstream. |
| `build_source` | [`BuildSource`](build_source.md) (optional) | |
| `update_type` | [`UpdateType`](update_type.md) (optional) | |
| `update_schedule` | `list<string>` (optional) | The month or months in which the data is to be re-ingested by the Overture theme using this data source. |
| `known_issues` | `string` (optional) | A description of any issues with the data that are known - i.e. data is incomplete, coverage is incomplete, or issues with character encoding. |
| `notes` | `string` (optional) | Freeform notes about this data source, including notes on any pre-processing requirements. |
| `requires_attribution` | `string` (optional) | Whether this source requires attribution to be used in Overture Maps. |

## Used By

- [`Sources`](../sources.md)
11 changes: 11 additions & 0 deletions docs/schema/reference/annex/types/license_shortname.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# LicenseShortname

Underlying type: `string`

## Constraints

- `pattern='^[A-Za-z0-9._+\\-]+$'`

## Used By

- [`Sources`](../sources.md)
12 changes: 12 additions & 0 deletions docs/schema/reference/annex/types/update_type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# UpdateType

Whether the data is continuously updated upstream or needs manual intervention.

## Values

- `continuous`
- `manual`

## Used By

- [`Dataset`](dataset.md)
2 changes: 1 addition & 1 deletion docs/schema/reference/base/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Base",
"position": 2
"position": 3
}
Loading