ldproxy

Feature Collections - Schema

specstableimplmature

Publish a logical schema of the feature properties, described in JSON Schema.

Scope

The schema is automatically derived from the type definitions in the feature provider. Currently, schemas are created according to JSON Schema 2020-12.

For geometry properties (type: GEOMETRY) the schema documents the admissible geometry type(s) in two complementary ways:

  • format (string) identifies a single, possibly combined geometry type using the values defined
    by OGC API - Features - Part 5, e.g. geometry-point, geometry-multipolygon,
    geometry-point-or-multipoint, geometry-any.
  • x-ldproxy-geometryTypes (array of strings) lists the individual admissible types in
    UpperCamelCase, e.g. ["Point", "MultiPoint"] or ["MultiPolygon"]. The keyword is omitted
    when no specific types are configured (i.e. the property accepts any geometry).

The values are derived from the provider-schema fields geometryType (a single type) and geometryTypes (a list of admissible types).

Conformance Classes

Feature Collections - Schema implements OGC API - Features - Part 5/OGC API - Common - Part 3: Schemasopen in new window.

Operations

ResourcePathMethodsMedia TypesDescription
Feature Schema
collections/{collectionId}/schema
GET
JSON Schema of the features of the collection collectionId.

Path Parameters

NameResourcesDescription
collectionId
Feature Schema
The identifier of the feature collection.

Query Parameters

NameResourcesDescription
f
Feature Schema
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

Configuration

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always SCHEMA.
string
v3.1
enabled
false
Enable the building block?
boolean
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1
defaultProfiles
{"codelist": "codelists-ref"}
Change the default value of the profile parameter for schema resources. The value is an object where the key is the id of a profile set, such as codelist, and the value is the default profile for the profile set, e.g., codelists-inline. In addition, format-specific default profiles can be specified in the building block of each schema format. Those defaults have a higher priority.
object
v4.5

This building block does not require or support any additional configuration files.

Examples


- buildingBlock: SCHEMA
 enabled: true
Legal NoticePrivacy Notice