commonground-api-common 2.4.1__tar.gz → 2.5.1__tar.gz

{commonground_api_common-2.4.1 → commonground_api_common-2.5.1}/CHANGELOG.rst

@@ -2,6 +2,16 @@
 Change history
 ==============
 
+2.5.1 (2025-02-10)
+------------------
+
+* Add English translations for Applicatie model
+
+2.5.0 (2025-02-06)
+------------------
+
+* Update setup-config docs to use example directive and add extra example values to models
+
 2.4.1 (2025-01-14)
 ------------------
 

{commonground_api_common-2.4.1/commonground_api_common.egg-info → commonground_api_common-2.5.1}/PKG-INFO

@@ -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 → commonground_api_common-2.5.1/commonground_api_common.egg-info}/PKG-INFO

@@ -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 → commonground_api_common-2.5.1}/commonground_api_common.egg-info/SOURCES.txt

@@ -134,6 +134,7 @@ vng_api_common/authorizations/migrations/0013_auto_20201207_0846.py
 vng_api_common/authorizations/migrations/0014_auto_20201221_0905.py
 vng_api_common/authorizations/migrations/0015_auto_20220318_1608.py
 vng_api_common/authorizations/migrations/0016_remove_authorizationsconfig_api_root_and_more.py
+vng_api_common/authorizations/migrations/0017_alter_applicatie_client_ids_and_more.py
 vng_api_common/authorizations/migrations/__init__.py
 vng_api_common/caching/__init__.py
 vng_api_common/caching/decorators.py

{commonground_api_common-2.4.1 → commonground_api_common-2.5.1}/commonground_api_common.egg-info/requires.txt

@@ -42,7 +42,7 @@ flake8
 bump2version
 
 [setup-configuration]
-django-setup-configuration>=0.4.0
+django-setup-configuration>=0.7.0
 
 [tests]
 psycopg2

{commonground_api_common-2.4.1 → commonground_api_common-2.5.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.4.1
+version = 2.5.1
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common
@@ -88,7 +88,7 @@ tests =
 testutils = 
 	zgw-consumers-oas
 setup-configuration = 
-	django-setup-configuration>=0.4.0
+	django-setup-configuration>=0.7.0
 pep8 = flake8
 coverage = pytest-cov
 docs = 

commonground_api_common-2.5.1/vng_api_common/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.5.1"

commonground_api_common-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,
+            ),
+        ),
+    ]

{commonground_api_common-2.4.1 → commonground_api_common-2.5.1}/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."
         ),
     )
 

{commonground_api_common-2.4.1 → commonground_api_common-2.5.1}/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]