commonground-api-common 2.4.1__py3-none-any.whl → 2.5.1__py3-none-any.whl

{commonground_api_common-2.4.1.dist-info → commonground_api_common-2.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.4.1
+Version: 2.5.1
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie
@@ -61,7 +61,7 @@ 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"
+Requires-Dist: django-setup-configuration>=0.7.0; extra == "setup-configuration"
 Provides-Extra: pep8
 Requires-Dist: flake8; extra == "pep8"
 Provides-Extra: coverage

{commonground_api_common-2.4.1.dist-info → commonground_api_common-2.5.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-commonground_api_common-2.4.1.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
-vng_api_common/__init__.py,sha256=LgDSW5laOqA_7i2VW0cZ9QumZREigUxs3ZCBzJ1EG0o,22
+commonground_api_common-2.5.1.data/scripts/generate_schema,sha256=OpKgzlFc_uzA3TVW_vHSYXAD_feLaCdTEnkWjIcxVzA,280
+vng_api_common/__init__.py,sha256=PfQ9ThOuZlUZhThya-_PpR02LjazRR6LNSivpta03mM,22
 vng_api_common/admin.py,sha256=iFtUPGf-ha0I-bXgq8QIFrP23Kzk_H3FlgAjt0U-ip0,259
 vng_api_common/apps.py,sha256=QQiJXRmjX9Q91oh0P9fvVnHe3NSYd1cEcUUBw0HLBCA,3690
 vng_api_common/checks.py,sha256=tOyfV7MMLGh4anrd_W30LvJCxiyQ4sFs1mGd9mtrEc0,1175
@@ -28,12 +28,12 @@ vng_api_common/routers.py,sha256=hEnhBulkgMM-7W_lYaykKTgTBj3-avl7DGsR9P7BbTU,189
 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
+vng_api_common/serializers.py,sha256=NdrZJqP7p54lRKoKG4mEDS9MqaMcPESIr4dB1tnLaqI,10163
 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=ejaFZvFXFaBlqxjA2_07NSHKHlG5pejrfC_GHjwCj6E,12852
 vng_api_common/version.py,sha256=yJV9_yTM7Qnzg0zGNkJQkN9Uai3I_ZUkcyseJRPRk5I,129
-vng_api_common/views.py,sha256=VnvlpDmzBeSkDB9a-pBUkqBncKO7TT-6bY5zbYP4QOk,7607
+vng_api_common/views.py,sha256=pxpI2dl22I9auTYvRJ-Rx-_NHAKgo1F2QwQJF6WIjrE,7603
 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
@@ -76,7 +76,7 @@ vng_api_common/audittrails/migrations/_operations.py,sha256=UOMv0zAK8CIQ73cSu6ww
 vng_api_common/authorizations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/authorizations/admin.py,sha256=Tk0yYKbb005E0XZaYYWbucMf_K5M8Hhz62wSBDi8rhM,813
 vng_api_common/authorizations/middleware.py,sha256=KJ3znCXPRMOVqSur62SmBjvC6RcKxtcWq1rzaHdYR98,8416
-vng_api_common/authorizations/models.py,sha256=0bcZwRc0ntIlPzUM7I8R5yhQRrnXvAZ_l9FpTnpbnxk,5207
+vng_api_common/authorizations/models.py,sha256=slIYxSktxCxSg03Nfb2mhsQse17b93KWE-rdPdMv8Ik,5199
 vng_api_common/authorizations/serializers.py,sha256=3HeKWEqhI3UWwI8SttC4rEID-Epbk7SWsC-bEjolbaw,5151
 vng_api_common/authorizations/utils.py,sha256=VCXdU4q3CQ1cvuYkg1dPWSbZym1Ufoz5gSmbHYkQcgw,521
 vng_api_common/authorizations/validators.py,sha256=u7fKm0QgGy8fiAeYmIEB9Gy-yIE9C-tC2ZpnNQBXPso,2816
@@ -96,6 +96,7 @@ vng_api_common/authorizations/migrations/0013_auto_20201207_0846.py,sha256=fyJ0H
 vng_api_common/authorizations/migrations/0014_auto_20201221_0905.py,sha256=pkg7Y9yvUIY-QB9elvCxfR7OZJ3xMBIha_4WSZeDlwY,1659
 vng_api_common/authorizations/migrations/0015_auto_20220318_1608.py,sha256=jR1MDuqapBZU4bYVx0V3MRauRpDk_DtCVcBSe7gmtUA,1751
 vng_api_common/authorizations/migrations/0016_remove_authorizationsconfig_api_root_and_more.py,sha256=-UbTWExHaPL0O8585mm4_OFCm8xJXAmfwmU7V0ysSgg,2407
+vng_api_common/authorizations/migrations/0017_alter_applicatie_client_ids_and_more.py,sha256=E8Iin_EJu9aClokT9MX-TuR-YSp5k3XfrIMSdtHvD3w,1436
 vng_api_common/authorizations/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vng_api_common/caching/__init__.py,sha256=v_FC6HaHESwr_J94TWzaQBKtIjDLnsQADvqHylEW7g8,687
 vng_api_common/caching/decorators.py,sha256=lU5dnBjD9aHjoYaV32FlYxY7VFZPdMZe26fVDa_h3Q4,1804
@@ -108,7 +109,7 @@ vng_api_common/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 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/models.py,sha256=oqw0cOrbromC9CS3nWzfpDgOLg_xXyHoAi7jgw0f7Yk,1195
 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
@@ -119,8 +120,8 @@ vng_api_common/extensions/geojson.py,sha256=mVqry8F7RQm0YIK3m5scazePB7KprffQy02R
 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/locale/nl/LC_MESSAGES/django.mo,sha256=qcZT0NRN7oUzyoPGdV4kVFgovQ6gRhSvVthgFuItqEs,5094
+vng_api_common/locale/nl/LC_MESSAGES/django.po,sha256=zU1ksdcdLrCvvlk5wUISUWUhPtJpkdooZ87uv1tlyp8,20421
 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
@@ -182,7 +183,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.4.1.dist-info/METADATA,sha256=4ycNVljxoK6rd_ozoYpx0f_l07i4JnZsiUihMscJwK0,6988
-commonground_api_common-2.4.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-commonground_api_common-2.4.1.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
-commonground_api_common-2.4.1.dist-info/RECORD,,
+commonground_api_common-2.5.1.dist-info/METADATA,sha256=n8yxgZS9mpXtkpE-VCkFQfl9qKX9kIxbt7-mi8oXLvY,6988
+commonground_api_common-2.5.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+commonground_api_common-2.5.1.dist-info/top_level.txt,sha256=vPismc83zPzWXTmlNCCwfDlFV9iygJYxNJW5iDjKTgw,15
+commonground_api_common-2.5.1.dist-info/RECORD,,

vng_api_common/__init__.py

@@ -1 +1 @@
-__version__ = "2.4.1"
+__version__ = "2.5.1"

vng_api_common/authorizations/migrations/0017_alter_applicatie_client_ids_and_more.py

@@ -0,0 +1,41 @@
+# Generated by Django 4.2.17 on 2025-02-10 13:18
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("authorizations", "0016_remove_authorizationsconfig_api_root_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="applicatie",
+            name="client_ids",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(max_length=50),
+                help_text="Comma separated list of consumer identifiers (client_ids)",
+                size=None,
+                verbose_name="client IDs",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="applicatie",
+            name="heeft_alle_autorisaties",
+            field=models.BooleanField(
+                default=False,
+                help_text="If all authorizations are given to this applicatie, no individual permissions have to be configured. Only enable this if you fully trust the consumer.",
+                verbose_name="has all authorizations",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="applicatie",
+            name="label",
+            field=models.CharField(
+                help_text="A human readable representation of the application, for end users.",
+                max_length=100,
+            ),
+        ),
+    ]

vng_api_common/authorizations/models.py

@@ -74,21 +74,21 @@ class Applicatie(APIMixin, models.Model):
     client_ids = ArrayField(
         models.CharField(max_length=50),
         verbose_name=_("client IDs"),
-        help_text=_("Komma-gescheiden lijst van consumer identifiers (hun client_id)."),
+        help_text=_("Comma separated list of consumer identifiers (client_ids)"),
     )
     label = models.CharField(
         max_length=100,
         help_text=_(
-            "Een leesbare representatie van de applicatie, voor eindgebruikers."
+            "A human readable representation of the application, for end users."
         ),
     )
     heeft_alle_autorisaties = models.BooleanField(
-        _("heeft alle autorisaties"),
+        _("has all authorizations"),
         default=False,
         help_text=_(
-            "Indien alle autorisaties gegeven zijn, dan hoeven deze "
-            "niet individueel opgegeven te worden. Gebruik dit alleen "
-            "als je de consumer helemaal vertrouwt."
+            "If all authorizations are given to this applicatie, no individual "
+            "permissions have to be configured. Only enable this if you "
+            "fully trust the consumer."
         ),
     )
 

vng_api_common/contrib/setup_configuration/models.py

@@ -13,10 +13,14 @@ class SingleJWTSecretConfigurationModel(ConfigurationModel):
                 "secret",
             ]
         }
+        extra_kwargs = {
+            "identifier": {"examples": ["application-name"]},
+            "secret": {"examples": ["modify-this"]},
+        }
 
 
 class JWTSecretsConfigurationModel(ConfigurationModel):
-    items: list[SingleJWTSecretConfigurationModel] = Field(default_factory=list)
+    items: list[SingleJWTSecretConfigurationModel] = Field()
 
 
 class SingleApplicatieConfigurationModel(ConfigurationModel):
@@ -26,7 +30,11 @@ class SingleApplicatieConfigurationModel(ConfigurationModel):
         django_model_refs = {
             Applicatie: ["uuid", "client_ids", "label", "heeft_alle_autorisaties"]
         }
+        extra_kwargs = {
+            "client_ids": {"examples": [["open-notificaties-prod"]]},
+            "label": {"examples": ["Open Notificaties (productie)"]},
+        }
 
 
 class ApplicatieConfigurationModel(ConfigurationModel):
-    items: list[SingleApplicatieConfigurationModel] = Field(default_factory=list)
+    items: list[SingleApplicatieConfigurationModel]