commonground-api-common 2.5.0__tar.gz → 2.5.2__tar.gz

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2}/CHANGELOG.rst

@@ -2,6 +2,16 @@
 Change history
 ==============
 
+2.5.2 (2025-03-06)
+------------------
+
+* Add English translation for ``HyperlinkedIdentityField`` description
+
+2.5.1 (2025-02-10)
+------------------
+
+* Add English translations for Applicatie model
+
 2.5.0 (2025-02-06)
 ------------------
 

{commonground_api_common-2.5.0/commonground_api_common.egg-info → commonground_api_common-2.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.5.0
+Version: 2.5.2
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: commonground-api-common
-Version: 2.5.0
+Version: 2.5.2
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2}/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.5.0 → commonground_api_common-2.5.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.5.0
+version = 2.5.2
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2}/tests/test_field_extensions.py

@@ -109,7 +109,7 @@ def test_hyper_link_identity_field():
         "format": "uri",
         "minLength": 1,
         "maxLength": 1000,
-        "description": "URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.",
+        "description": "URL reference to this object. This is the unique identification and location of this object.",
         "readOnly": True,
     }
 

commonground_api_common-2.5.2/vng_api_common/__init__.py

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

commonground_api_common-2.5.2/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.5.0 → commonground_api_common-2.5.2}/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.5.0 → commonground_api_common-2.5.2}/vng_api_common/contrib/setup_configuration/models.py

@@ -14,7 +14,7 @@ class SingleJWTSecretConfigurationModel(ConfigurationModel):
             ]
         }
         extra_kwargs = {
-            "identifier": {"examples": ["application-name"]},
+            "identifier": {"examples": ["open-notificaties-prod"]},
             "secret": {"examples": ["modify-this"]},
         }
 

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2}/vng_api_common/contrib/setup_configuration/steps.py

@@ -26,7 +26,12 @@ class JWTSecretsConfigurationStep(BaseConfigurationStep[JWTSecretsConfigurationM
 
 class ApplicatieConfigurationStep(BaseConfigurationStep[ApplicatieConfigurationModel]):
     """
-    Configure Applicatie used for authorization
+    Configure Applicaties used for authorization.
+
+    .. note:: The values of ``client_ids`` must match the values of the ``identifier`` field(s)
+        in the ``vng_api_common_credentials`` namespace. To give proper access to an application,
+        you need to load the credentials (``identifier`` and ``secret``)
+        **and** the Applicatie (``client_ids``, ``uuid``, ``label`` and permissions)
     """
 
     verbose_name = "Configuration to create applicaties"

{commonground_api_common-2.5.0 → commonground_api_common-2.5.2}/vng_api_common/extensions/hyperlink.py

@@ -32,6 +32,7 @@ class HyperlinkedIdentityFieldExtension(OpenApiSerializerFieldExtension):
             "minLength": 1,
             "maxLength": 1000,
             "description": _(
-                "URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object."
+                "URL reference to this object. "
+                "This is the unique identification and location of this object."
             ),
         }