huanld/pygeoapi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update sortby parameter handling

Browse Source
This commit is contained in:
Tom Kralidis
2021-02-20 08:58:48 -05:00
parent 6bb5c71496
commit 9da53b0b76
10 changed files with 40 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pygeoapi/api.py
+9 -15
View File
@@ -906,27 +906,21 @@ class API:
sortby = []
sorts = val.split(',')
for s in sorts:
if ':' in s:
prop, order = s.split(':')
if order not in ['A', 'D']:
exception = {
'code': 'InvalidParameterValue',
'description': 'sort order should be A or D'
}
LOGGER.error(exception)
return headers_, 400, to_json(exception,
self.pretty_print)
sortby.append({'property': prop, 'order': order})
else:
sortby.append({'property': s, 'order': 'A'})
for s in sortby:
if s['property'] not in p.fields.keys():
prop = s
order = '+'
if s[0] in ['+', '-']:
order = s[0]
prop = s[1:]
if prop not in p.fields.keys():
exception = {
'code': 'InvalidParameterValue',
'description': 'bad sort property'
}
LOGGER.error(exception)
return headers_, 400, to_json(exception, self.pretty_print)
sortby.append({'property': prop, 'order': order})
else:
sortby = []
pygeoapi/openapi.py
+1 -12
View File
@@ -295,17 +295,6 @@ def get_oas_30(cfg):
'default': False
}
},
'sortby': {
'name': 'sortby',
'in': 'query',
'description': 'The optional sortby parameter indicates the sort property and order on which the server shall present results in the response document using the convention `sortby=PROPERTY:X`, where `PROPERTY` is the sort property and `X` is the sort order (`A` is ascending, `D` is descending). Sorting by multiple properties is supported by providing a comma-separated list.', # noqa
'required': False,
'schema': {
'type': 'string',
},
'style': 'form',
'explode': False
},
'startindex': {
'name': 'startindex',
'in': 'query',
@@ -449,7 +438,7 @@ def get_oas_30(cfg):
{'$ref': '{}#/components/parameters/limit'.format(OPENAPI_YAML['oapif'])}, # noqa
coll_properties,
{'$ref': '#/components/parameters/skipGeometry'},
{'$ref': '#/components/parameters/sortby'},
{'$ref': '{}/parameters/sortby.yaml'.format(OPENAPI_YAML['oapir'])}, # noqa
{'$ref': '#/components/parameters/startindex'},
],
'responses': {
pygeoapi/provider/elasticsearch_.py
+1 -1
View File
@@ -227,7 +227,7 @@ class ElasticsearchProvider(BaseProvider):
sort_property = self.mask_prop(sp)
sort_order = 'asc'
if sort['order'] == 'D':
if sort['order'] == '-':
sort_order = 'desc'
sort_ = {
pygeoapi/provider/mongo.py
+1 -1
View File
@@ -123,7 +123,7 @@ class MongoProvider(BaseProvider):
filterobj = {'$and': and_filter} if and_filter else {}
sort_list = [("properties." + sort['property'],
ASCENDING if (sort['order'] == 'A') else DESCENDING)
ASCENDING if (sort['order'] == '+') else DESCENDING)
for sort in sortby]
featurelist, matchcount = self._get_feature_list(filterobj,
pygeoapi/provider/tinydb_.py
+1 -1
View File
@@ -191,7 +191,7 @@ class TinyDBCatalogueProvider(BaseProvider):
if sortby:
LOGGER.debug('Sorting results')
if sortby[0]['order'] == 'D':
if sortby[0]['order'] == '-':
sort_reverse = True
else:
sort_reverse = False
tests/pygeoapi-test-openapi.yml
+7 -8
View File
@@ -45,17 +45,16 @@ components:
type: string
style: form
sortby:
description: The optional sortby parameter indicates the sort property and order
on which the server shall present results in the response document using the
convention `sortby=PROPERTY:X`, where `PROPERTY` is the sort property and
`X` is the sort order (`A` is ascending, `D` is descending). Sorting by multiple
properties is supported by providing a comma-separated list.
explode: false
in: query
name: sortby
in: query
required: false
schema:
type: string
type: array
minItems: 1
items:
type: string
pattern: "[+|-][A-Za-z_][A-Za-z_0-9]*"
explode: false
style: form
startindex:
description: The optional startindex parameter indicates the index within the
tests/test_api.py
+9 -9
View File
@@ -439,18 +439,18 @@ def test_get_collection_items(config, api_):
assert code == 400
rsp_headers, code, response = api_.get_collection_items(
req_headers, {
'sortby': 'stn_id:FOO',
'stn_id': '35',
'value': '89.9'
}, 'obs')
assert code == 400
req_headers, {'sortby': 'stn_id'}, 'obs')
features = json.loads(response)
assert code == 200
rsp_headers, code, response = api_.get_collection_items(
req_headers, {'sortby': 'stn_id:A'}, 'obs')
req_headers, {'sortby': '+stn_id'}, 'obs')
features = json.loads(response)
assert code == 200
rsp_headers, code, response = api_.get_collection_items(
req_headers, {'sortby': '-stn_id'}, 'obs')
features = json.loads(response)
# FIXME? this test errors out currently
assert code == 200
rsp_headers, code, response = api_.get_collection_items(
tests/test_elasticsearch__provider.py
+5 -5
View File
@@ -72,21 +72,21 @@ def test_query(config):
assert len(results['features']) == 1
assert results['features'][0]['id'] == 3168070
results = p.query(sortby=[{'property': 'nameascii', 'order': 'A'}])
results = p.query(sortby=[{'property': 'nameascii', 'order': '+'}])
assert results['features'][0]['properties']['nameascii'] == 'Abidjan'
results = p.query(sortby=[{'property': 'nameascii', 'order': 'D'}])
results = p.query(sortby=[{'property': 'nameascii', 'order': '-'}])
assert results['features'][0]['properties']['nameascii'] == 'Zagreb'
results = p.query(sortby=[{'property': 'scalerank', 'order': 'A'}])
results = p.query(sortby=[{'property': 'scalerank', 'order': '+'}])
assert results['features'][0]['properties']['scalerank'] == 0
results = p.query(sortby=[{'property': 'scalerank', 'order': 'D'}])
results = p.query(sortby=[{'property': 'scalerank', 'order': '-'}])
assert results['features'][0]['properties']['scalerank'] == 8
assert len(results['features'][0]['properties']) == 37
results = p.query(sortby=[{'property': 'nameascii', 'order': 'D'}],
results = p.query(sortby=[{'property': 'nameascii', 'order': '-'}],
limit=10001)
assert results['features'][0]['properties']['nameascii'] == 'Zagreb'
assert len(results['features']) == 242
tests/test_mongo_provider.py
+4 -4
View File
@@ -82,16 +82,16 @@ def test_query(config):
assert len(results['features']) == 1
assert results['features'][0]['properties']['nameascii'] == 'Vaduz'
results = p.query(sortby=[{'property': 'nameascii', 'order': 'A'}])
results = p.query(sortby=[{'property': 'nameascii', 'order': '+'}])
assert results['features'][0]['properties']['nameascii'] == 'Abidjan'
results = p.query(sortby=[{'property': 'nameascii', 'order': 'D'}])
results = p.query(sortby=[{'property': 'nameascii', 'order': '-'}])
assert results['features'][0]['properties']['nameascii'] == 'Zagreb'
results = p.query(sortby=[{'property': 'scalerank', 'order': 'A'}])
results = p.query(sortby=[{'property': 'scalerank', 'order': '+'}])
assert results['features'][0]['properties']['scalerank'] == 0
results = p.query(sortby=[{'property': 'scalerank', 'order': 'D'}])
results = p.query(sortby=[{'property': 'scalerank', 'order': '-'}])
assert results['features'][0]['properties']['scalerank'] == 8
assert len(results['features'][0]['properties']) == 37
tests/test_tinydb_catalogue_provider.py
+2 -2
View File
@@ -107,10 +107,10 @@ def test_query(config):
assert len(results['features']) == 2
assert results['features'][0]['id'] == 'd3028ad0-b0d0-47ff-bcc3-d383881e17cd' # noqa
results = p.query(sortby=[{'property': 'title', 'order': 'A'}])
results = p.query(sortby=[{'property': 'title', 'order': '+'}])
assert results['features'][0]['id'] == '1687cac6-ee13-4866-ab8a-114c2ede7b13' # noqa
results = p.query(sortby=[{'property': 'title', 'order': 'D'}])
results = p.query(sortby=[{'property': 'title', 'order': '-'}])
assert results['features'][0]['id'] == '8a09413a-0a01-4aab-8925-720d987deb20' # noqa