PB-1677 Use <name> instead of properties.<name> for sortby

This is more in line with how the query extension is implemented.

For a "query" to the POST /search endpoint the following field values
are allowed:

- created
- updated
- title
- cf:standard_name
- unit

So it's not, e.g., "properties.updated" but only "updated". The "sortby"
now works the same.

The following fields are allowed for sort:

- id
- collection
- datetime
- title
- created
- updated

Author: asteiner-swisstopo

app/stac_api/utils.py

@@ -636,10 +636,10 @@ def parse_cache_control_header(cache_control_header):
 SORTABLE_FIELDS = {
     'id': 'name',
     'collection': 'collection__name',
-    'properties.datetime': 'properties_datetime',
-    'properties.title': 'properties_title',
-    'properties.created': 'created',
-    'properties.updated': 'updated',
+    'datetime': 'properties_datetime',
+    'title': 'properties_title',
+    'created': 'created',
+    'updated': 'updated',
 }
 
 
@@ -649,7 +649,7 @@ def parse_sortby_get(sortby_param, sortable_fields):
     The sortby parameter is a comma-separated string of fields prefixed with '+'
     (ascending, default) or '-' (descending).
 
-    Example: "-properties.created,title".
+    Example: "-created,title".
 
     Args:
         sortby_param: string
@@ -695,7 +695,7 @@ def parse_sortby_post(sortby_param, sortable_fields):
     The sortby parameter in the request body is a list of objects with a 'field'
     and a 'direction' ('asc' or 'desc') property.
 
-    Example: [{"field": "properties.created", "direction": "desc"}].
+    Example: [{"field": "created", "direction": "desc"}].
 
     Args:
         sortby_param: list

app/tests/tests_10/test_items_endpoint.py

@@ -228,7 +228,7 @@ def test_sortby_properties_datetime(self):
 
         # Test ascending sort
         response = self.client.get(
-            f"/{STAC_BASE_V}/collections/{self.collection.name}/items?sortby=properties.datetime"
+            f"/{STAC_BASE_V}/collections/{self.collection.name}/items?sortby=datetime"
         )
 
         self.assertStatusCode(200, response)
@@ -237,7 +237,7 @@ def test_sortby_properties_datetime(self):
 
         # Test descending sort
         response = self.client.get(
-            f"/{STAC_BASE_V}/collections/{self.collection.name}/items?sortby=-properties.datetime"
+            f"/{STAC_BASE_V}/collections/{self.collection.name}/items?sortby=-datetime"
         )
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
@@ -268,10 +268,10 @@ def test_sortby_multiple_fields(self):
         )
 
         # Sort by datetime ascending, then by title descending
-        response = self.client.get((
-            f"/{STAC_BASE_V}/collections/{self.collection.name}/items?"
-            f"sortby=properties.datetime,-properties.title"
-        ))
+        response = self.client.get(
+            (f"/{STAC_BASE_V}/collections/{self.collection.name}/items?"
+             f"sortby=datetime,-title")
+        )
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
         self.assertEqual(

app/tests/tests_10/test_search_endpoint_extensions.py

@@ -289,13 +289,13 @@ def test_get_sortby_properties_datetime(self):
         )
 
         # ascending sort
-        response = self.client.get(f"{self.path}?sortby=properties.datetime")
+        response = self.client.get(f"{self.path}?sortby=datetime")
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
         self.assertEqual(item_ids, ['item-1', 'item-2', 'item-dt-2', 'item-dt-1', 'item-dt-3'])
 
         # descending sort
-        response = self.client.get(f"{self.path}?sortby=-properties.datetime")
+        response = self.client.get(f"{self.path}?sortby=-datetime")
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
         self.assertEqual(item_ids, ['item-dt-3', 'item-dt-1', 'item-dt-2', 'item-2', 'item-1'])
@@ -325,7 +325,7 @@ def test_get_sortby_multiple_fields(self):
         )
 
         # Sort by datetime ascending, then by title descending
-        response = self.client.get(f"{self.path}?sortby=properties.datetime,-properties.title")
+        response = self.client.get(f"{self.path}?sortby=datetime,-title")
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
         self.assertEqual(
@@ -378,14 +378,14 @@ def test_post_sortby_properties_datetime(self):
         )
 
         # ascending sort
-        payload = {"sortby": [{"field": "properties.datetime", "direction": "asc"}]}
+        payload = {"sortby": [{"field": "datetime", "direction": "asc"}]}
         response = self.client.post(self.path, data=payload, content_type="application/json")
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
         self.assertEqual(item_ids, ['item-1', 'item-2', 'item-dt-2', 'item-dt-1', 'item-dt-3'])
 
         # descending sort
-        payload = {"sortby": [{"field": "properties.datetime", "direction": "desc"}]}
+        payload = {"sortby": [{"field": "datetime", "direction": "desc"}]}
         response = self.client.post(self.path, data=payload, content_type="application/json")
         self.assertStatusCode(200, response)
         item_ids = [item['id'] for item in response.json()['features']]
@@ -418,9 +418,9 @@ def test_post_sortby_multiple_fields(self):
         # Sort by datetime ascending, then by title descending
         payload = {
             "sortby": [{
-                "field": "properties.datetime", "direction": "asc"
+                "field": "datetime", "direction": "asc"
             }, {
-                "field": "properties.title", "direction": "desc"
+                "field": "title", "direction": "desc"
             }]
         }
         response = self.client.post(self.path, data=payload, content_type="application/json")

spec/components/parameters.yaml

@@ -141,4 +141,4 @@ components:
       required: false
       schema:
         type: string
-        example: '-properties.created,id'
+        example: '-created,id'

spec/components/schemas.yaml

@@ -1718,7 +1718,7 @@ components:
               - asc
               - desc
       example:
-        - field: properties.created
+        - field: created
           direction: asc
         - field: collection
           direction: desc

spec/static/spec/v1/openapi.yaml

@@ -138,7 +138,7 @@ components:
       required: false
       schema:
         type: string
-        example: '-properties.created,id'
+        example: '-created,id'
   responses:
     Collection:
       headers:
@@ -1951,7 +1951,7 @@ components:
               - asc
               - desc
       example:
-        - field: properties.created
+        - field: created
           direction: asc
         - field: collection
           direction: desc

spec/static/spec/v1/openapitransactional.yaml

@@ -138,7 +138,7 @@ components:
       required: false
       schema:
         type: string
-        example: '-properties.created,id'
+        example: '-created,id'
     uploadId:
       name: uploadId
       in: path
@@ -2035,7 +2035,7 @@ components:
               - asc
               - desc
       example:
-        - field: properties.created
+        - field: created
           direction: asc
         - field: collection
           direction: desc