Profile - Codelists in Schemas

specdraftimplcandidate

Profile für die Darstellung von Codelistwerten in Schemas. Auf Schemas anwendbar.

Umfang

Eine Codeliste ist eine Liste von Codes (String oder Integer) mit einer textlichen Bezeichnung. Zwei verschiedene Darstellungen einer Codelist-wertigen Eigenschaft in einem Schema werden als Profile unterstützt. Die beiden Profile sind:

  • "codelist-inline": Das Schema jeder Codelist-wertigen Eigenschaft wird durch ein "oneOf"-Schema mit einem Schema für jeden Code dargestellt. Das Schema für jeden Code hat ein "const"-Member mit dem Code als Wert und die Bezeichnung in "title". Diese Darstellung hat den Vorteil, dass alle Informationen im Schema enthalten sind. Es muss nicht auf externe Informationen zugegriffen werden.
  • "codelist-ref" (Standardprofil): Das Schema jeder Codelist-Eigenschaft wird durch ein "enum"-Array mit den Codes dargestellt. Zusätzlich wird die Codeliste durch einen HTTP(S)-URI mit dem Schlüsselwort "x-ogc-codelistUri" referenziert. Dieses Profil hat den Vorteil, dass "enum" einfacher zu parsen/handhaben ist als "oneOf" und dass eine separate Ressource für Codelisten auch für andere Zwecke nützlich sein kann.

Konformitätsklassen

Der Baustein implementiert die Requirements Class "Profiles for codelists" Entwurf von OGC API - Features - Part 5: Schemasopen in new window.

Konfiguration

Optionen

NameDefaultBeschreibungTypSeit
buildingBlock
Immer PROFILE_CODELIST.
string
v2.0
enabled
true
Soll der Baustein aktiviert werden?
boolean
v2.0

Beispiele


- buildingBlock: PROFILE_CODELIST
  enabled: true