udata-hydra-csvapi 0.3.2.dev6__py3-none-any.whl → 0.3.2.dev7__py3-none-any.whl

api_tabular/config_default.toml

@@ -7,7 +7,8 @@ PAGE_SIZE_DEFAULT = 20
 PAGE_SIZE_MAX = 50
 BATCH_SIZE = 50000
 DOC_PATH = "/api/doc"
-ALLOW_AGGREGATION = [
+ALLOW_AGGREGATION = false
+ALLOW_AGGREGATION_EXCEPTIONS = [
     "dddddddd-7777-eeee-8888-ffffffffffff",  # without indexes
     "aaaaaaaa-9999-bbbb-1010-cccccccccccc",  # with indexes
 ]  # list of resource_ids

api_tabular/core/utils.py

@@ -6,7 +6,7 @@ from api_tabular.core.error import QueryException
 
 
 def is_aggregation_allowed(resource_id: str) -> bool:
-    return resource_id in config.ALLOW_AGGREGATION
+    return config.ALLOW_AGGREGATION or resource_id in config.ALLOW_AGGREGATION_EXCEPTIONS
 
 
 def process_total(res: Response | ClientResponse) -> int:

api_tabular/tabular/app.py

@@ -149,7 +149,11 @@ async def get_health(request):
 @routes.get(r"/api/aggregation-exceptions/")
 async def get_aggregation_exceptions(request):
     """Return the list of resources for which aggregation queries are allowed"""
-    return web.json_response(config.ALLOW_AGGREGATION)
+    body = {
+        "allowed": config.ALLOW_AGGREGATION,
+        "exceptions": config.ALLOW_AGGREGATION_EXCEPTIONS,
+    }
+    return web.json_response(body)
 
 
 async def app_factory():

{udata_hydra_csvapi-0.3.2.dev6.dist-info → udata_hydra_csvapi-0.3.2.dev7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: udata-hydra-csvapi
-Version: 0.3.2.dev6
+Version: 0.3.2.dev7
 Summary: API for CSV converted by udata-hydra
 Author-email: "data.gouv.fr" <opendatateam@data.gouv.fr>
 License-Expression: MIT
@@ -323,7 +323,9 @@ column_name__sort=desc
 ```
 
 #### Aggregation Operators
-> ⚠️ **WARNING**: Aggregation requests are only available for resources that are listed in the `ALLOW_AGGREGATION` list of the config file, which can be seen at the `/api/aggregation-exceptions/` endpoint, and on columns that have an index.
+> ⚠️ **WARNING**: Aggregation requests are disabled by default.
+> You can allow or disallow it for all resources with the `ALLOW_AGGREGATION` config. If `ALLOW_AGGREGATION` is set to `false`, you can specify allow exceptions by listing these in the `ALLOW_AGGREGATION_EXCEPTIONS` list.
+> You can get the current status and exceptions at `/api/aggregation-exceptions/` endpoint.
 
 ```
 # group by values
@@ -479,7 +481,8 @@ Configuration is handled through TOML files and environment variables. The defau
 | `PAGE_SIZE_MAX` | `50` | Maximum allowed page size |
 | `BATCH_SIZE` | `50000` | Batch size for streaming |
 | `DOC_PATH` | `/api/doc` | Swagger documentation path |
-| `ALLOW_AGGREGATION` | `["dddddddd-7777-eeee-8888-ffffffffffff", "aaaaaaaa-9999-bbbb-1010-cccccccccccc"]` | List of resource IDs allowed for aggregation |
+| `ALLOW_AGGREGATION` | `False` | Whether aggregation queries are allowed (`column__groupby`). If False, it can still be explicitly allowed with `ALLOW_AGGREGATION_EXCEPTIONS` |
+| `ALLOW_AGGREGATION_EXCEPTIONS` | `["dddddddd-7777-eeee-8888-ffffffffffff", "aaaaaaaa-9999-bbbb-1010-cccccccccccc"]` | List of resource IDs allowed for aggregation |
 
 ### Environment Variables
 

{udata_hydra_csvapi-0.3.2.dev6.dist-info → udata_hydra_csvapi-0.3.2.dev7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 api_tabular/__init__.py,sha256=sYG6CMz-twob-QLyfsPYRc6cWDtqWXvq_N5Dxk-U5qA,2263
-api_tabular/config_default.toml,sha256=3zQMpzr87qwd23dG_scGUptj0T3IUOjaHecI4ppJBqY,384
+api_tabular/config_default.toml,sha256=cX506NdqHW7gK_2aZjzLiz0Z4gMSl1tU_tI4i4BvuXs,421
 api_tabular/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 api_tabular/core/data.py,sha256=5j-3d_el7LMoHpn6V__UdhYHD6GiJbwdH67jrnOYWZQ,1459
 api_tabular/core/error.py,sha256=xRt6fkQfsiupv0tWWzdX0DJjAKbw1n0tRxFyt15VBLA,1062
@@ -8,15 +8,15 @@ api_tabular/core/query.py,sha256=m98cO16mVkz0cSNICesgjC8MNVEfDW_645sz-DTd2Pw,557
 api_tabular/core/sentry.py,sha256=fN5MrDZszLnzLXF3b_nUymPVB0ffNn4PI7xS1GtJNyE,948
 api_tabular/core/swagger.py,sha256=0RZFu941CD3qWt2R6e3nnlcrkYjjAHU5eOFl4jH2liA,14188
 api_tabular/core/url.py,sha256=af7VKfrMtKMzlHrGgtLDLuRBim4qFv7xlt2PYxAyW2g,761
-api_tabular/core/utils.py,sha256=SWU1gVkOq728-eZHmZzlyA3pQg6kelEf3SMlL-uEbns,1032
+api_tabular/core/utils.py,sha256=VTxPiNWE3FF6f2aX5Q21XPezCL3sVZ_KICIrGBJRm_E,1071
 api_tabular/core/version.py,sha256=OKLg0l1CpDRHV2hsqVgtSihoo3tg0aMG6kzMILtQ-bY,250
 api_tabular/metrics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 api_tabular/metrics/app.py,sha256=5kZXzAiFh1tSNYO5GEz67m4zTsTVyoIkgcelDGyT1zE,4637
 api_tabular/tabular/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-api_tabular/tabular/app.py,sha256=JgqL1svglQ_fD5ndhft_Cm7HmTh5FuyoxYUPGS1_l-o,6771
+api_tabular/tabular/app.py,sha256=b75nhHTXz4rt2kHNkXSU3-c0LpI91OFzRuDXYmJFx5k,6874
 api_tabular/tabular/utils.py,sha256=BL2nl04-3imBQG-RZiYvVMjxoBORi4lwrKq8NiWecLY,4487
-udata_hydra_csvapi-0.3.2.dev6.dist-info/licenses/LICENSE,sha256=fb-HAYw94ffh--z1cZrWbpk6YKM0p9WFG7kdd0K7uGQ,1062
-udata_hydra_csvapi-0.3.2.dev6.dist-info/METADATA,sha256=H8RvN_eAVebPVB0Hf4GfPPMxxNjy0IeyOcuh2x1lBtY,19156
-udata_hydra_csvapi-0.3.2.dev6.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-udata_hydra_csvapi-0.3.2.dev6.dist-info/top_level.txt,sha256=MAaK09hxwPhIBBC0i1TdEBAgdu3W_gXnAZqk767gVak,12
-udata_hydra_csvapi-0.3.2.dev6.dist-info/RECORD,,
+udata_hydra_csvapi-0.3.2.dev7.dist-info/licenses/LICENSE,sha256=fb-HAYw94ffh--z1cZrWbpk6YKM0p9WFG7kdd0K7uGQ,1062
+udata_hydra_csvapi-0.3.2.dev7.dist-info/METADATA,sha256=si0qB7KLdF-XWFw4EwZNvBEB0FGZDqXgkq6SzGutCI0,19482
+udata_hydra_csvapi-0.3.2.dev7.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+udata_hydra_csvapi-0.3.2.dev7.dist-info/top_level.txt,sha256=MAaK09hxwPhIBBC0i1TdEBAgdu3W_gXnAZqk767gVak,12
+udata_hydra_csvapi-0.3.2.dev7.dist-info/RECORD,,