Profile - References

specdraftimplcandidate

Profiles for feature properties that reference other resources.

Scope

If the feature schema includes at least one property of type FEATURE_REF or FEATURE_REF_ARRAY, three profiles can be used to select the encoding of object references in the response. Supported are "rel-as-link" (a link with URI and an optional title), "rel-as-key" (the featureId of the referenced feature) and "rel-as-uri" (the URI of the referenced feature).

Formats that only support simple values will typically not support "rel-as-link" and use "rel-as-key" as the default. HTML, GeoJSON, JSON-FG and GML use "rel-as-link" as the default. GML only supports "rel-as-link".

Conformance Classes

Profile - References implements the Requirements Class "Profiles for references" draft of OGC API - Features - Part 5: Schemas.

Configuration

Options

Name	Default	Description	Type	Since
buildingBlock		Always PROFILE_REL.	string	v2.0
enabled	true	Enable the building block?	boolean	v2.0

Examples

- buildingBlock: PROFILE_REL
  enabled: true