Profile - Codelists in Schemas

specdraftimplcandidate

Profiles for the representation of codelist values in schemas. Applicable to schemas.

Scope

A codelist is a list of codes with a human-readable title. Two different representations of a codelist-valued property in a schema are specified as profiles. The two profiles are:

• "codelist-inline": The schema of each codelist-valued property is represented by a "oneOf" schema with a schema for each code. The schema for each code has a "const" member with the code as the value. This representation has the advantage that all information is in the schema; no external information needs to be accessed.
• "codelist-ref" (default): The schema of each codelist-valued property is represented by an "enum" member with the codes. In addition the codelist is referenced by a HTTP(S) URI using the keyword "x-ogc-codelistUri". This profile has the advantage that "enum" is easier to parse/handle than "oneOf" and that a separate resource for codelists may be useful for other purposes, too, and in fact may already be published.

Conformance Classes

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

Configuration

Options

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

Examples

- buildingBlock: PROFILE_CODELIST
  enabled: true