commonground-api-common 2.1.2__py3-none-any.whl → 2.3.0__py3-none-any.whl

commonground_api_common-2.1.2.data/scripts/patch_content_types → commonground_api_common-2.3.0.data/scripts/generate_schema

@@ -9,7 +9,5 @@ if [[ -z "$VIRTUAL_ENV" ]]; then
     exit 1
 fi
 
-source_file=${1:-./src/openapi.yaml}
-manage=${MANAGE:-src/manage.py}
-
-python $manage patch_error_contenttypes $source_file
+echo "generate schema"
+src/manage.py spectacular --file src/openapi.yaml --validate

{commonground_api_common-2.1.2.dist-info → commonground_api_common-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.1.2
+Version: 2.3.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -25,8 +25,8 @@ Requires-Dist: django-solo
 Requires-Dist: djangorestframework>=3.15.0
 Requires-Dist: djangorestframework_camel_case>=1.2.0
 Requires-Dist: django-rest-framework-condition
-Requires-Dist: drf-yasg>=1.20.0
 Requires-Dist: drf-nested-routers>=0.94.1
+Requires-Dist: drf-spectacular
 Requires-Dist: iso-639
 Requires-Dist: isodate
 Requires-Dist: notifications-api-common>=0.3.1
@@ -40,10 +40,15 @@ Requires-Dist: ape-pie
 Provides-Extra: markdown-docs
 Requires-Dist: django-markup<=1.3; extra == "markdown-docs"
 Requires-Dist: markdown; extra == "markdown-docs"
+Provides-Extra: djangorestframework-gis
+Requires-Dist: djangorestframework-gis>=1.0; extra == "djangorestframework-gis"
+Provides-Extra: drf-extra-fields
+Requires-Dist: drf-extra-fields>=3.7.0; extra == "drf-extra-fields"
 Provides-Extra: tests
 Requires-Dist: psycopg2; extra == "tests"
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-django; extra == "tests"
+Requires-Dist: pytest-dotenv; extra == "tests"
 Requires-Dist: pytest-factoryboy; extra == "tests"
 Requires-Dist: tox; extra == "tests"
 Requires-Dist: isort; extra == "tests"
@@ -51,8 +56,12 @@ Requires-Dist: black; extra == "tests"
 Requires-Dist: requests-mock; extra == "tests"
 Requires-Dist: freezegun; extra == "tests"
 Requires-Dist: zgw-consumers-oas; extra == "tests"
+Requires-Dist: djangorestframework-gis; extra == "tests"
+Requires-Dist: drf-extra-fields; extra == "tests"
 Provides-Extra: testutils
 Requires-Dist: zgw-consumers-oas; extra == "testutils"
+Provides-Extra: setup-configuration
+Requires-Dist: django-setup-configuration>=0.4.0; extra == "setup-configuration"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.1.2.dist-info → commonground_api_common-2.3.0.dist-info}/RECORD

@@ -1,9 +1,7 @@
-commonground_api_common-2.1.2.data/scripts/generate_schema,sha256=UKhznmbHX1zUjPx8G3XtxUPQiqnyd3TOIXs27Tnjl7U,952
-commonground_api_common-2.1.2.data/scripts/patch_content_types,sha256=dpGpYrZOZe8O5CHWd0F0QnP6Wk_7lK6DyuVZpBPr4mY,319
-commonground_api_common-2.1.2.data/scripts/use_external_components,sha256=xvvbngO2aDUagVXv4xRUqPaVtH_eOaVMWLQ8lyAPhEA,369
-vng_api_common/__init__.py,sha256=UiuBcRXPtXxPUBDdp0ZDvWl0U9Db1kMNfT3oAfhxqLg,22
+commonground_api_common-2.3.0.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
+vng_api_common/__init__.py,sha256=CpK8IH_dCUAwg9tqv7zm9FxbBFkxCnED1JUiRe7cftU,22
 vng_api_common/admin.py,sha256=iFtUPGf-ha0I-bXgq8QIFrP23Kzk_H3FlgAjt0U-ip0,259
-vng_api_common/apps.py,sha256=wOQuxUImMpH39R0JrDdCZp5ADaUM8jU8vFPFW9froSs,3458
+vng_api_common/apps.py,sha256=14vSvFX2H6alME95uOK9aL5TIWI3reiOW86Qa9kmhNw,3610
 vng_api_common/checks.py,sha256=tOyfV7MMLGh4anrd_W30LvJCxiyQ4sFs1mGd9mtrEc0,1175
 vng_api_common/choices.py,sha256=dboFRoM34GpRUpxB9WexexccopcQSogu1QIyY4B9ACY,541
 vng_api_common/client.py,sha256=HNLc86RwczAudPBDgH_zQncE19OUaLyhSnacQRxJO0c,1972
@@ -15,19 +13,19 @@ vng_api_common/doc.py,sha256=a4Wm6Y-Va-tBsLwZFjPX_oA4PppkDR4wpIiw9q7NLd4,1167
 vng_api_common/exception_handling.py,sha256=Z8Si1-GPWaTtsgaFI_zLOvlnLVLM8jqfgFIimX8eo-8,4759
 vng_api_common/exceptions.py,sha256=7Qk5dlETjoQjZeGRKei4PkeLACLoZOMrMiuyi-yn6Kk,615
 vng_api_common/fields.py,sha256=1911m0CKEU-5-2t_h5P-D2YjC8BGosx8t8FQ-SGfgFw,6335
-vng_api_common/filters.py,sha256=77m9s3V6woMqE7uOQoqzit7w1AQpWcGqZozzQFdKAYs,5681
+vng_api_common/filters.py,sha256=oPivwrES1BQgSUg1jD9hJab7dyoO3VbZDVbbRRiW2SQ,5618
 vng_api_common/filtersets.py,sha256=Ioarp5t_cz6Hf3iIcP2Rc0D7tGYhcMQPVdIJJ2dvtv8,867
-vng_api_common/generators.py,sha256=tD7ZyyFgCQ3KiktpBFtn5YiVdl3jioGxzyvkEZFYdQQ,4911
+vng_api_common/generators.py,sha256=88yQN5-vRFUegfzQcsZtlpbtQyn_zZQwvs20OidPK7M,1239
 vng_api_common/geo.py,sha256=AZbrw0rwGYOmaSUk8JJSkx-4_tVrfT_cgggh9omRwhU,1862
 vng_api_common/middleware.py,sha256=2DRw0hPpvUMqwoH1Ze8S7tDB16lmj4Bnd6vN5ijkGM8,875
 vng_api_common/mocks.py,sha256=0sELLs-uy2ndu29m5P6FN_p1ehNhYv7IoRayYPs379Y,6200
 vng_api_common/models.py,sha256=3WgpCWQpkCOrMCtqp7EbnP681II43Sg_cch8ZOm4EcU,1707
-vng_api_common/oas.py,sha256=v_M_nsPRk12VF4lFa3Kw2c-wUThfY8PJ6JlEgeUhz9E,2618
+vng_api_common/oas.py,sha256=ATqqNM7zkDMoK3E-cxNh_c65n6YCrP96KxCFYfkEVK0,2523
 vng_api_common/pagination.py,sha256=sI6VJ5AHDBhtNRQ8OFrD2heQK-NxaL_6n73ijiqWDLc,255
 vng_api_common/permissions.py,sha256=ayDxk9Wt8j0yO57FhZ8XaRkPET4lAqd8SSw3m4o3EGs,7562
 vng_api_common/polymorphism.py,sha256=N-x39pG2unD4N0ZbxFvuhE8ibPaJ0eKeqfvAJW3NnEU,6623
 vng_api_common/routers.py,sha256=hEnhBulkgMM-7W_lYaykKTgTBj3-avl7DGsR9P7BbTU,1897
-vng_api_common/schema.py,sha256=1Bt9dH67AOLpfPNF7Q4IH1cXJeaIevSamZQzJ8DJ7ks,6144
+vng_api_common/schema.py,sha256=axs2Q8IXwpHNd5WscQg5xOErL6bWhP8WFItTt4xCFO4,16305
 vng_api_common/scopes.py,sha256=PGs6CkXorAAdWXGFY1bSy-jmsPn122Njen9aFFOpFIQ,2351
 vng_api_common/search.py,sha256=yehS6boCOk1JXLCqAMU-B62hWtbTBSf_WKIVGPgp0Mg,1045
 vng_api_common/serializers.py,sha256=7_7IotlRfVb0woe6Wy79l_el3sPzrSY8-bfiYLbEUqs,10162
@@ -35,18 +33,19 @@ vng_api_common/urls.py,sha256=9IWHYLlEIIHNaZ_Zq02qNQ2HJpETb7o-89r7yBM_tQs,270
 vng_api_common/utils.py,sha256=zrtpssOA-NcJHhAlxioBiXeY3G2R_uf0l8oWkDD_EiE,8511
 vng_api_common/validators.py,sha256=Y1OQrmnH3U01hnCizWc_xjpSSGUWKlwiFxeHHGCThpI,11012
 vng_api_common/version.py,sha256=yJV9_yTM7Qnzg0zGNkJQkN9Uai3I_ZUkcyseJRPRk5I,129
-vng_api_common/views.py,sha256=trsAZjyZt0PRaZOCDvjMJ5xTz4Ic0u4M73k0K_2qS4o,7620
+vng_api_common/views.py,sha256=VnvlpDmzBeSkDB9a-pBUkqBncKO7TT-6bY5zbYP4QOk,7607
 vng_api_common/viewsets.py,sha256=z5pzvSymFiiuCjP_-uuW-3OJKZY_psPAt8fWeWySU0c,2278
 vng_api_common/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/api/permissions.py,sha256=okbwiscxlAtbQWTCRDLL2reOxgj0rRDZeDcrtXAYq00,739
 vng_api_common/api/serializers.py,sha256=F1od8SZxgIlGVTSd_x5eTxacL6x8HbNn35O9z1zjio4,213
 vng_api_common/api/urls.py,sha256=Ei-bpoGhZQvcSYx9dY_vh3ESYDaSt0Uqlr6fS0MU46M,167
-vng_api_common/api/views.py,sha256=m9wbLVb4oPX-LJWor9oHkZCfxIJjNqpVG43aXeyQ2j4,491
+vng_api_common/api/views.py,sha256=qtgcSFg5oXdaELFT70g6jGkVmBhCcsVoKoItOroi02k,513
 vng_api_common/audittrails/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/audittrails/admin.py,sha256=mrRK9KhvFlRWcmsq-DM9cJdwtpBUciMa4DvtEIYfirQ,301
 vng_api_common/audittrails/apps.py,sha256=eM4RMMgqXq_Hm1Il-dUlO0rtXJVP0DgAFQBW25epzdw,111
 vng_api_common/audittrails/audits.py,sha256=44_vry_9XPZoyKUJeMhhf4xr0OsCndgzGGxRqa65_d0,337
 vng_api_common/audittrails/models.py,sha256=O1GhyJlZaDYPTwKcZE45J2Fl1q02BGtYciu-QdjzBsQ,3596
+vng_api_common/audittrails/utils.py,sha256=fhDQ-iaSGE8mWkcE9LXySI_pYfn7Xpao-n1m699h_hk,1316
 vng_api_common/audittrails/viewsets.py,sha256=K0AMPHYU6w_Z1cAww_itzfHjeqzZhIAi1m3cUHcXp30,8105
 vng_api_common/audittrails/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/audittrails/api/scopes.py,sha256=fL3PlX284g-mGFlcIzc2UWcyFBNZI6apnnhbFulZN2I,206
@@ -106,27 +105,22 @@ vng_api_common/caching/models.py,sha256=RroS9HFiKNXDV59Odh0x8BO8Az8E81v4gwuprF1A
 vng_api_common/caching/registry.py,sha256=mY1r99x7m0DQ1BN9lZF2zMjFj_oDNq7urxDkOH7-8Yg,6205
 vng_api_common/caching/signals.py,sha256=78ej5cVan-JpNHKzZNAfs0m2ON_TXKphe8ZKtP-6FVY,4615
 vng_api_common/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vng_api_common/conf/api.py,sha256=bRc488POvBdKeaKVit7s1_LFP-BRLpETmTzcQ6JD614,4372
+vng_api_common/conf/api.py,sha256=Lx3Kk7S7mKxeaUr0dm6jbKrEh4WI2gye4i7QxN2x69E,3150
+vng_api_common/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vng_api_common/contrib/setup_configuration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vng_api_common/contrib/setup_configuration/models.py,sha256=ztev7KDGW0ESLl6jSuLx0tlNV58IOL3ibYEfVmjfv2Y,920
+vng_api_common/contrib/setup_configuration/steps.py,sha256=3jYRdHFlPq5zR-T-SPYTDp_Aipy0JK1HaJFrSgH4Vd0,1680
 vng_api_common/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/db/operations.py,sha256=3vj9zD4EntMSmYsNGN1pRDjAcVM68MESDdoAk9wl0U0,3333
-vng_api_common/inspectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vng_api_common/inspectors/cache.py,sha256=6h2ckYd6RGxluPhdXZbxehOQNsb5yrWTMiLknTbZx-E,1890
-vng_api_common/inspectors/fields.py,sha256=XgD6K-KKzWVbxKb0kG92bNOsqLuuS_ywjidP359VWDU,3980
-vng_api_common/inspectors/files.py,sha256=kedBFCLS0H8lopVgIa7SpBrwXgk6E7Hd8xZT65P0TOE,4385
-vng_api_common/inspectors/geojson.py,sha256=Vs6PsY5hY_zlkEko-5nvj_QIO0UKuoSlu2ONpW5Z65s,12575
-vng_api_common/inspectors/polymorphic.py,sha256=4U_wjmcBwWCbTPvd0ojFCdmtuyJShy7ORChO2JqKjvs,2627
-vng_api_common/inspectors/query.py,sha256=pl_M84BCtgVtBbc_5YtmsImU8c416hYOuDTo91ApFX4,3802
-vng_api_common/inspectors/utils.py,sha256=uLyB_Giw7B2flMiBB_HwCpxOs-QcTUIHjHkE0xUmPfo,1481
-vng_api_common/inspectors/view.py,sha256=f28MFNqHUE3LSWgYHuJB2PwjRszIAqPU_fBk75Utl3w,20425
+vng_api_common/extensions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vng_api_common/extensions/file.py,sha256=tvOiSYbu0CrVKefgO_nOj1af1L0JjShec3VkR-i-IWE,950
+vng_api_common/extensions/gegevensgroep.py,sha256=mfwXpQ8Zq8Tevv_bt28OZqv8a9u6L3yJEKQqXerKzBI,518
+vng_api_common/extensions/geojson.py,sha256=mVqry8F7RQm0YIK3m5scazePB7KprffQy02RNA1FOIE,9217
+vng_api_common/extensions/hyperlink.py,sha256=jadfiQ2vdJ78q-dXo3YOuDgv54zZWm8Y0nzg21aB_HE,1360
+vng_api_common/extensions/polymorphic.py,sha256=Hjzn1VAx3E0Eafb7NctkNQuDYJeh6ln0KHgVNRjHG1s,2768
+vng_api_common/extensions/query.py,sha256=mXxv2aiyP-kHmXUrszHqxEKhAedUugwVJZljQ5nPLcY,585
 vng_api_common/locale/nl/LC_MESSAGES/django.mo,sha256=w1sFqpNIcpHWbNOFpKjVUmA3idit-Q1SH2wE5h0nXPU,6211
 vng_api_common/locale/nl/LC_MESSAGES/django.po,sha256=UVAmaSTntaUC73IY4rAN-iT3FoIpLSh4bj-8DyqcwPw,19495
-vng_api_common/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vng_api_common/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vng_api_common/management/commands/generate_autorisaties.py,sha256=kMaZQo6e6vCXA9y0e6P2PlxObyjHMyNynRcM4WtzVZI,1130
-vng_api_common/management/commands/generate_notificaties.py,sha256=0p7CkLkQo-BeV2IljGv0rcRNw2aWY_HwlvybjggZ_gs,1090
-vng_api_common/management/commands/generate_swagger.py,sha256=DyRRSDMFEZeXSJp_PWiMc6vYFK3GPEO4WIRWZV-tlm0,6120
-vng_api_common/management/commands/patch_error_contenttypes.py,sha256=xyFIQ4JRutLZCTcLrWqon0FDeAJCw1bkVg4jM8-EM24,2025
-vng_api_common/management/commands/use_external_components.py,sha256=FLkhZ5jAIZoAXQWwxqu4yT94LiBJ4GRr6g4ZRp7b_Eg,2936
 vng_api_common/migrations/0001_initial.py,sha256=frE83rux6uVHK4v-1fsb_1C00TBQQ6koFBA3DoVPHmk,895
 vng_api_common/migrations/0002_apicredential.py,sha256=AYgkLMizI0g-Ogth8j_FVJHTDDI3bWzQgZzuQeABzaU,1083
 vng_api_common/migrations/0003_auto_20190417_1145.py,sha256=0ABqDggAdjmZxhSsLrMb2ZBwTcR1BOWo1Tn8StfiG0A,1001
@@ -139,7 +133,7 @@ vng_api_common/notifications/apps.py,sha256=7grk1hxQn5usAWV-sWATmNJ4TwSvT3izXVvV
 vng_api_common/notifications/handlers.py,sha256=xjuE_qn5h4gbRNGMsTaCTrHIjXTBcF8na6oMURGAuUU,2089
 vng_api_common/notifications/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/notifications/api/urls.py,sha256=c1T_6tuRpgN0V80Xg_ehZzGGlF1FNMmHdBEPAjR736I,164
-vng_api_common/notifications/api/views.py,sha256=EvppqaANutuOIrkNepavmzFTX6fxo32c6l5c6DKHe8k,2326
+vng_api_common/notifications/api/views.py,sha256=DmeDAJCY-jlwTNZ_YwBSjud04x2ZzAcKMNgCib93IAg,2313
 vng_api_common/notifications/migrations/0001_initial.py,sha256=zEIVIB--6FStaTl3r9GCXxHL1cSCWRO3T90rEpJr3hY,3049
 vng_api_common/notifications/migrations/0002_subscription__subscription.py,sha256=eqaj6-FAl7vuCswdvin9Lf8nzjP8U6WqVQO4opNKKCc,550
 vng_api_common/notifications/migrations/0003_auto_20190319_1048.py,sha256=C-ccYUwQPNCjTctpDDFhnQbm_OcpAlTjYQbEuiEi-ys,987
@@ -174,11 +168,8 @@ vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.svg,
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.ttf,sha256=elj3Qf9TmvlHmP9WHJGOWEHX5hZOkMvle-_exKFvak4,186444
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff,sha256=IEZK67_1TMF3dkl85BEsM3SlSzj3ul9Y7sEhdBSdZ0I,96256
 vng_api_common/static/vng_api_common/libs/fontawesome/webfonts/fa-solid-900.woff2,sha256=8YxIaoAXXPAv7g4FwrSs2GwEzbrs7GHB75H5IFCbXv4,74256
-vng_api_common/templates/vng_api_common/api_schema_to_markdown_table.md,sha256=XKs4D32SC4HRdths3jdeloqwfLi3hO2DuLsFDv6-25w,598
-vng_api_common/templates/vng_api_common/autorisaties.md,sha256=yGZVwIQwyJ3W3-LqHHUm6vwdSiAxVovtH5WYJVPktvs,402
 vng_api_common/templates/vng_api_common/index.html,sha256=jZyzxHnZABoTxNFPKbUJGoU6ZJuSeuM8xt2fVr7-hSw,1684
 vng_api_common/templates/vng_api_common/master.html,sha256=p7xZSpuTaf0cyKU31N5o_1BWwiwEZhLxvte60KMo5v8,3417
-vng_api_common/templates/vng_api_common/notificaties.md,sha256=VNQz_CtYGDw24QJxdfkUfOvHvgv9__O072gmQCqh_Pg,856
 vng_api_common/templates/vng_api_common/view_config.html,sha256=_8OhafH-Y3b_gOl3GukqYbh2G7XXizUdaOrudGWa36U,881
 vng_api_common/templates/vng_api_common/admin/base_site.html,sha256=mMr_9L7dugHEvULZE0CB18mKdeXs92oPLi1CDgXyqnw,1739
 vng_api_common/templates/vng_api_common/includes/kanalen_card.html,sha256=jPKpms8cP4MZaHO7_NgBJEhFvvBsGQ3s23x1EUxSw5c,330
@@ -191,7 +182,7 @@ vng_api_common/tests/auth.py,sha256=IKDWTEFv4Bign4F70-ibsFcnJqRxEJaXvqaPQJWa1xY,
 vng_api_common/tests/caching.py,sha256=zfIw5cRRvO9cekHZZKfRqZc8cx5IfJUYNmcH6cuIMg4,624
 vng_api_common/tests/schema.py,sha256=WDvifDQQiKqIpQijpeQ7rYkFroJmuPuHe7zNhl1Bigk,2293
 vng_api_common/tests/urls.py,sha256=PFrYzQbBC0TFPMEn3uPhcBG0IQs9JsEPqckicJT1UA4,2159
-commonground_api_common-2.1.2.dist-info/METADATA,sha256=aZsWkuXEZv6U80PK2Xau_5xLmD57lzp2KyGK-OGRm6A,6497
-commonground_api_common-2.1.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-commonground_api_common-2.1.2.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
-commonground_api_common-2.1.2.dist-info/RECORD,,
+commonground_api_common-2.3.0.dist-info/METADATA,sha256=Ke1dE5k_UQ-0ZdksTJ9aBp_AxOy0ZZh3OxtgTn5AS4k,6988
+commonground_api_common-2.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+commonground_api_common-2.3.0.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
+commonground_api_common-2.3.0.dist-info/RECORD,,

{commonground_api_common-2.1.2.dist-info → commonground_api_common-2.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

vng_api_common/__init__.py

@@ -1 +1 @@
-__version__ = "2.1.2"
+__version__ = "2.3.0"

vng_api_common/api/views.py

@@ -7,6 +7,7 @@ from .serializers import JWTSecretSerializer
 
 
 class CreateJWTSecretView(CreateAPIView):
+    action = "create"
     swagger_schema = None
 
     model = JWTSecret

vng_api_common/apps.py

@@ -1,14 +1,10 @@
+import logging
+
 from django.apps import AppConfig
 from django.db import models
 from django.forms.fields import CharField
 from django.utils.translation import gettext_lazy as _
 
-from drf_yasg import openapi
-from drf_yasg.inspectors.field import (
-    basic_type_info,
-    model_field_to_basic_type,
-    serializer_field_to_basic_type,
-)
 from rest_framework import serializers
 
 from . import fields
@@ -25,6 +21,8 @@ except ImportError:
 # is collected somewhere so there's precedent
 FORMAT_DURATION = "duration"
 
+logger = logging.getLogger(__name__)
+
 
 class CommonGroundAPICommonConfig(AppConfig):
     name = "vng_api_common"
@@ -32,36 +30,21 @@ class CommonGroundAPICommonConfig(AppConfig):
 
     def ready(self):
         from . import checks  # noqa
+        from . import schema  # noqa
         from .caching import signals  # noqa
+        from .extensions import gegevensgroep, hyperlink, polymorphic, query  # noqa
 
-        patch_duration_type()
         register_serializer_field()
         set_custom_hyperlinkedmodelserializer_field()
         set_charfield_error_messages()
         ensure_text_choice_descriptions(TextChoicesWithDescriptions)
-
-
-def patch_duration_type():
-    def _patch(basic_types, _field_cls, format=None):
-        for index, (field_cls, basic_type) in enumerate(basic_types):
-            if field_cls is _field_cls:
-                basic_types[index] = (_field_cls, (openapi.TYPE_STRING, format))
-                break
-
-    _patch(model_field_to_basic_type, models.DurationField, FORMAT_DURATION)
-    _patch(basic_type_info, models.DurationField, FORMAT_DURATION)
-    _patch(serializer_field_to_basic_type, serializers.DurationField, FORMAT_DURATION)
-    _patch(basic_type_info, serializers.DurationField, FORMAT_DURATION)
-
-    # best-effort support for relativedeltafield
-    if RelativeDeltaField is not None:
-        _patch(model_field_to_basic_type, RelativeDeltaField, FORMAT_DURATION)
-        _patch(basic_type_info, RelativeDeltaField, FORMAT_DURATION)
+        register_geojson_field_extension()
+        register_base64_field_extension()
 
 
 def register_serializer_field():
     mapping = serializers.ModelSerializer.serializer_field_mapping
-    mapping[models.fields.DurationField] = DurationField
+    mapping[models.DurationField] = DurationField
     mapping[fields.DaysDurationField] = DurationField
 
     if RelativeDeltaField is not None:
@@ -97,3 +80,37 @@ def ensure_text_choice_descriptions(text_choice_class):
 
     for cls in text_choice_class.__subclasses__():
         ensure_text_choice_descriptions(cls)
+
+
+def register_geojson_field_extension() -> None:
+    """
+    register GeoJSONGeometry extension only if rest_framework_gis is
+    installed
+    """
+    try:
+        from rest_framework_gis.fields import GeometryField  # noqa
+    except ImportError:
+        logger.debug(
+            "Could not import djangorestframework-gis, skipping "
+            "GeometryFieldExtension registration."
+        )
+        return
+
+    from .extensions import geojson  # noqa
+
+
+def register_base64_field_extension() -> None:
+    """
+    register Base64FileFileFieldExtension extension only if drf_extra_fields is
+    installed
+    """
+    try:
+        from drf_extra_fields.fields import Base64FileField  # noqa
+    except ImportError:
+        logger.debug(
+            "Could not import drf-extra-fields, skipping "
+            "Base64FileFileFieldExtension registration."
+        )
+        return
+
+    from .extensions import file  # noqa

vng_api_common/audittrails/utils.py

@@ -0,0 +1,44 @@
+import inspect
+import logging
+
+from django.apps import apps
+
+from rest_framework import viewsets
+
+logger = logging.getLogger(__name__)
+
+
+AUDIT_TRAIL_ENABLED = apps.is_installed("vng_api_common.audittrails")
+
+
+def _view_supports_audittrail(view: viewsets.ViewSet) -> bool:
+    # moved from vng_api_common.inspectors
+    if not AUDIT_TRAIL_ENABLED:
+        return False
+
+    if not hasattr(view, "action"):
+        logger.debug("Could not determine view action for view %r", view)
+        return False
+
+    # local imports, since you get errors if you try to import non-installed app
+    # models
+    from vng_api_common.audittrails.viewsets import AuditTrailMixin
+
+    relevant_bases = [
+        base for base in view.__class__.__bases__ if issubclass(base, AuditTrailMixin)
+    ]
+    if not relevant_bases:
+        return False
+
+    # check if the view action is listed in any of the audit trail mixins
+    action = view.action
+    if action == "partial_update":  # partial update is self.update(partial=True)
+        action = "update"
+
+    # if the current view action is not provided by any of the audit trail
+    # related bases, then it's not audit trail enabled
+    action_in_audit_bases = any(
+        action in dict(inspect.getmembers(base)) for base in relevant_bases
+    )
+
+    return action_in_audit_bases

vng_api_common/conf/api.py

@@ -1,7 +1,7 @@
 __all__ = [
     "API_VERSION",
     "BASE_REST_FRAMEWORK",
-    "BASE_SWAGGER_SETTINGS",
+    "BASE_SPECTACULAR_SETTINGS",
     "COMMON_SPEC",
     "LINK_FETCHER",
     "GEMMA_URL_TEMPLATE",
@@ -12,43 +12,30 @@ __all__ = [
     "NOTIFICATIONS_KANAAL",
     "NOTIFICATIONS_DISABLED",
     "JWT_LEEWAY",
+    "SECURITY_DEFINITION_NAME",
     "COMMONGROUND_API_COMMON_GET_DOMAIN",
+    "JWT_SPECTACULAR_SETTINGS",
 ]
 
 API_VERSION = "1.0.0-rc1"  # semantic version
 
+SECURITY_DEFINITION_NAME = "JWT-Claims"
+
 BASE_REST_FRAMEWORK = {
+    "DEFAULT_SCHEMA_CLASS": "vng_api_common.schema.AutoSchema",
     "DEFAULT_RENDERER_CLASSES": (
         "djangorestframework_camel_case.render.CamelCaseJSONRenderer",
     ),
     "DEFAULT_PARSER_CLASSES": (
         "djangorestframework_camel_case.parser.CamelCaseJSONParser",
     ),
-    "DEFAULT_AUTHENTICATION_CLASSES": (
-        # 'oauth2_provider.contrib.rest_framework.OAuth2Authentication',
-        # 'rest_framework.authentication.SessionAuthentication',
-        # 'rest_framework.authentication.BasicAuthentication'
-    ),
     # there is no authentication of 'end-users', only authorization (via JWT)
     # of applications
     "DEFAULT_AUTHENTICATION_CLASSES": (),
-    # 'DEFAULT_PERMISSION_CLASSES': (
-    #     'oauth2_provider.contrib.rest_framework.TokenHasReadWriteScope',
-    #     # 'rest_framework.permissions.IsAuthenticated',
-    #     # 'rest_framework.permissions.AllowAny',
-    # ),
     "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.URLPathVersioning",
-    #
-    # # Generic view behavior
-    # 'DEFAULT_PAGINATION_CLASS': 'ztc.api.utils.pagination.HALPagination',
-    "DEFAULT_FILTER_BACKENDS": (
-        "vng_api_common.filters.Backend",
-        # 'rest_framework.filters.SearchFilter',
-        # 'rest_framework.filters.OrderingFilter',
-    ),
+    "DEFAULT_FILTER_BACKENDS": ("vng_api_common.filters.Backend",),
     #
     # # Filtering
-    # 'SEARCH_PARAM': 'zoek',  # 'search',
     "ORDERING_PARAM": "ordering",  # 'ordering',
     #
     # Versioning
@@ -60,34 +47,35 @@ BASE_REST_FRAMEWORK = {
     "EXCEPTION_HANDLER": "vng_api_common.views.exception_handler",
     "TEST_REQUEST_DEFAULT_FORMAT": "json",
 }
-
-BASE_SWAGGER_SETTINGS = {
+BASE_SPECTACULAR_SETTINGS = {
     "DEFAULT_GENERATOR_CLASS": "vng_api_common.generators.OpenAPISchemaGenerator",
-    "DEFAULT_AUTO_SCHEMA_CLASS": "vng_api_common.inspectors.view.AutoSchema",
-    "DEFAULT_INFO": "must.be.overridden",
-    "DEFAULT_FIELD_INSPECTORS": (
-        # GeometryFieldInspector has external dependencies, and is opt-in
-        # 'vng_api_common.inspectors.geojson.GeometryFieldInspector',
-        "vng_api_common.inspectors.fields.HyperlinkedIdentityFieldInspector",
-        "vng_api_common.inspectors.fields.ReadOnlyFieldInspector",
-        "vng_api_common.inspectors.polymorphic.PolymorphicSerializerInspector",
-        "vng_api_common.inspectors.fields.GegevensGroepInspector",
-        "drf_yasg.inspectors.CamelCaseJSONFilter",
-        "drf_yasg.inspectors.RecursiveFieldInspector",
-        "drf_yasg.inspectors.ReferencingSerializerInspector",
-        "drf_yasg.inspectors.ChoiceFieldInspector",
-        "drf_yasg.inspectors.FileFieldInspector",
-        "drf_yasg.inspectors.DictFieldInspector",
-        "drf_yasg.inspectors.JSONFieldInspector",
-        "drf_yasg.inspectors.HiddenFieldInspector",
-        "drf_yasg.inspectors.RelatedFieldInspector",
-        "drf_yasg.inspectors.SerializerMethodFieldInspector",
-        "drf_yasg.inspectors.SimpleFieldInspector",
-        "drf_yasg.inspectors.StringDefaultFieldInspector",
-    ),
-    "DEFAULT_FILTER_INSPECTORS": ("vng_api_common.inspectors.query.FilterInspector",),
+    "SERVE_INCLUDE_SCHEMA": False,
+    "POSTPROCESSING_HOOKS": [
+        "drf_spectacular.hooks.postprocess_schema_enums",
+        "drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
+    ],
+    "SCHEMA_PATH_PREFIX": "/api/v1",
+}
+
+# add to SPECTACULAR_SETTINGS if you are using the AuthMiddleware
+JWT_SPECTACULAR_SETTINGS = {
+    "APPEND_COMPONENTS": {
+        "securitySchemes": {
+            SECURITY_DEFINITION_NAME: {
+                "type": "http",
+                "bearerFormat": "JWT",
+                "scheme": "bearer",
+            }
+        },
+    },
+    "SECURITY": [
+        {
+            SECURITY_DEFINITION_NAME: [],
+        }
+    ],
 }
 
+
 REDOC_SETTINGS = {"EXPAND_RESPONSES": "200,201", "SPEC_URL": "openapi.json"}
 
 # See: https://github.com/Rebilly/ReDoc#redoc-options-object

vng_api_common/contrib/setup_configuration/models.py

@@ -0,0 +1,32 @@
+from django_setup_configuration.models import ConfigurationModel
+from pydantic import Field
+
+from vng_api_common.authorizations.models import Applicatie
+from vng_api_common.models import JWTSecret
+
+
+class SingleJWTSecretConfigurationModel(ConfigurationModel):
+    class Meta:
+        django_model_refs = {
+            JWTSecret: [
+                "identifier",
+                "secret",
+            ]
+        }
+
+
+class JWTSecretsConfigurationModel(ConfigurationModel):
+    items: list[SingleJWTSecretConfigurationModel] = Field(default_factory=list)
+
+
+class SingleApplicatieConfigurationModel(ConfigurationModel):
+    client_ids: list[str]
+
+    class Meta:
+        django_model_refs = {
+            Applicatie: ["uuid", "client_ids", "label", "heeft_alle_autorisaties"]
+        }
+
+
+class ApplicatieConfigurationModel(ConfigurationModel):
+    items: list[SingleApplicatieConfigurationModel] = Field(default_factory=list)

vng_api_common/contrib/setup_configuration/steps.py

@@ -0,0 +1,46 @@
+from django_setup_configuration.configuration import BaseConfigurationStep
+
+from vng_api_common.authorizations.models import Applicatie
+from vng_api_common.models import JWTSecret
+
+from .models import ApplicatieConfigurationModel, JWTSecretsConfigurationModel
+
+
+class JWTSecretsConfigurationStep(BaseConfigurationStep[JWTSecretsConfigurationModel]):
+    """
+    Configure credentials for Applications that need access
+    """
+
+    verbose_name = "Configuration to create credentials"
+    config_model = JWTSecretsConfigurationModel
+    namespace = "vng_api_common_credentials"
+    enable_setting = "vng_api_common_credentials_config_enable"
+
+    def execute(self, model: JWTSecretsConfigurationModel):
+        for config in model.items:
+            JWTSecret.objects.update_or_create(
+                identifier=config.identifier,
+                defaults={"secret": config.secret},
+            )
+
+
+class ApplicatieConfigurationStep(BaseConfigurationStep[ApplicatieConfigurationModel]):
+    """
+    Configure Applicatie used for authorization
+    """
+
+    verbose_name = "Configuration to create applicaties"
+    config_model = ApplicatieConfigurationModel
+    namespace = "vng_api_common_applicaties"
+    enable_setting = "vng_api_common_applicaties_config_enable"
+
+    def execute(self, model: ApplicatieConfigurationModel):
+        for config in model.items:
+            Applicatie.objects.update_or_create(
+                uuid=config.uuid,
+                defaults={
+                    "client_ids": config.client_ids,
+                    "label": config.label,
+                    "heeft_alle_autorisaties": config.heeft_alle_autorisaties,
+                },
+            )

vng_api_common/extensions/file.py

@@ -0,0 +1,26 @@
+from django.utils.translation import gettext_lazy as _
+
+from drf_spectacular.extensions import OpenApiSerializerFieldExtension
+from drf_spectacular.openapi import OpenApiTypes
+from drf_spectacular.plumbing import build_basic_type
+
+
+class Base64FileFileFieldExtension(OpenApiSerializerFieldExtension):
+    target_class = "drf_extra_fields.fields.Base64FileField"
+    match_subclasses = True
+
+    def map_serializer_field(self, auto_schema, direction):
+        base64_schema = {
+            **build_basic_type(OpenApiTypes.BYTE),
+            "description": _("Base64 encoded binary content."),
+        }
+
+        uri_schema = {
+            **build_basic_type(OpenApiTypes.URI),
+            "description": _("Download URL of the binary content."),
+        }
+
+        if direction == "request":
+            return base64_schema
+        elif direction == "response":
+            return uri_schema if not self.target.represent_in_base64 else base64_schema

vng_api_common/extensions/gegevensgroep.py

@@ -0,0 +1,16 @@
+from drf_spectacular.extensions import OpenApiSerializerExtension
+from drf_spectacular.openapi import AutoSchema
+
+
+class GegevensGroepFieldExtension(OpenApiSerializerExtension):
+    target_class = "vng_api_common.serializers.GegevensGroepSerializer"
+    match_subclasses = True
+
+    def map_serializer(self, auto_schema: AutoSchema, direction):
+        schema = auto_schema._map_serializer(
+            self.target, direction, bypass_extensions=True
+        )
+
+        del schema["description"]
+
+        return schema