Sortingspecdraftimplproposal
Sortieren von Features in Rückgaben.
Umfang
Konformitätsklassen
Das Modul implementiert die Konformitätsklasse "Sorting" des Entwurfs von OGC API - Records - Part 1: Core.
Operationen
Ressource | Pfad | Methoden | Formate | Beschreibung |
---|---|---|---|---|
Sortables | collections/{collectionId}/sortables | GET | HTML, JSON | Die Sortables-Ressource identifiziert die Eigenschaften, auf die im Parameter "sortby" Bezug genommen werden kann, um die Features in der Antwort zu ordnen. Die Antwort wird als JSON-Schema-Dokument zurückgegeben, das ein einzelnes JSON-Objekt beschreibt, bei dem jede Eigenschaft ein Sortable ist. Beachten Sie, dass das Sortables-Schema kein Schema eines Objekts angibt, das über die API abgerufen werden kann. JSON Schema wird für die Sortables verwendet, um einen konsistenten Ansatz für die Beschreibung von Schemainformationen zu haben. JSON Schema wird in anderen Teilen der API außerdem dazu verwendet, um das Schema für JSON-Antwortdokumente zu beschreiben, einschließlich in OpenAPI-Dokumenten. |
Query Parameter
Name | Ressourcen | Beschreibung |
---|---|---|
sortby | Features | Ist der Parameter angegeben, werden die Features sortiert zurückgegeben. Sortiert wird nach den in einer kommaseparierten Liste angegebenen Attributen. Dem Attributnamen kann ein + (aufsteigend, das Standardverhalten) oder ein - (absteigend) vorangestellt werden. Beispiel: sortby=type,-name . |
f | Sortables | Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet. |
Konfiguration
Optionen
Name | Default | Beschreibung | Typ | Seit |
---|---|---|---|---|
buildingBlock | Immer SORTING . | string | v2.0 | |
extensionType | Deprecated Siehe buildingBlock . | string | v2.0 | |
enabled | false | Soll das Modul aktiviert werden? | boolean | v2.0 |
sortables | {} | Steuert, welche der Attribute in Queries für die Sortierung von Daten verwendet werden können. Erlaubt sind nur direkte Attribute (keine Attribute aus Arrays oder eingebetteten Objekten) der Datentypen STRING , DATETIME , INTEGER und FLOAT . | array | v2.0 |
Beispiele
- buildingBlock: SORTING
enabled: true
sortables:
- name
- function
- height