feat: We can add a number of use max for the secret in pilot registration

Author: Robin-Van-de-Merghel

diracx-client/src/diracx/client/_generated/models/_models.py

@@ -263,6 +263,8 @@ class BodyPilotsRegisterNewPilotsToDb(_serialization.Model):
     :vartype pilot_references: dict[str, any]
     :ivar generate_secrets: Boolean to allow secret creation or not.
     :vartype generate_secrets: bool
+    :ivar pilot_secret_use_count_max: Number of times we can use a secret.
+    :vartype pilot_secret_use_count_max: int
     """
 
     _validation = {
@@ -276,6 +278,10 @@ class BodyPilotsRegisterNewPilotsToDb(_serialization.Model):
         "grid_type": {"key": "grid_type", "type": "str"},
         "pilot_references": {"key": "pilot_references", "type": "{object}"},
         "generate_secrets": {"key": "generate_secrets", "type": "bool"},
+        "pilot_secret_use_count_max": {
+            "key": "pilot_secret_use_count_max",
+            "type": "int",
+        },
     }
 
     def __init__(
@@ -286,6 +292,7 @@ def __init__(
         grid_type: str = "Dirac",
         pilot_references: Optional[Dict[str, Any]] = None,
         generate_secrets: bool = True,
+        pilot_secret_use_count_max: int = 1,
         **kwargs: Any,
     ) -> None:
         """
@@ -299,13 +306,16 @@ def __init__(
         :paramtype pilot_references: dict[str, any]
         :keyword generate_secrets: Boolean to allow secret creation or not.
         :paramtype generate_secrets: bool
+        :keyword pilot_secret_use_count_max: Number of times we can use a secret.
+        :paramtype pilot_secret_use_count_max: int
         """
         super().__init__(**kwargs)
         self.pilot_stamps = pilot_stamps
         self.vo = vo
         self.grid_type = grid_type
         self.pilot_references = pilot_references
         self.generate_secrets = generate_secrets
+        self.pilot_secret_use_count_max = pilot_secret_use_count_max
 
 
 class GroupInfo(_serialization.Model):

diracx-routers/src/diracx/routers/pilots/credentials.py

@@ -59,6 +59,9 @@ async def register_new_pilots_to_db(
     generate_secrets: Annotated[
         bool, Body(description="Boolean to allow secret creation or not.")
     ] = True,
+    pilot_secret_use_count_max: Annotated[
+        int, Body(description="Number of times we can use a secret.")
+    ] = 1,
 ) -> list[PilotStampInfo] | list[PilotCredentialsInfo]:
     """Endpoint where a you can create pilots with their references.
     It will return the pilot secrets as well as an expiration date.
@@ -80,7 +83,11 @@ async def register_new_pilots_to_db(
 
     if generate_secrets:
         credentials, expiration_dates = await add_pilot_credentials(
-            pilot_stamps=pilot_stamps, pilot_db=pilot_db, settings=settings, vo=vo
+            pilot_stamps=pilot_stamps,
+            pilot_db=pilot_db,
+            settings=settings,
+            vo=vo,
+            pilot_secret_use_count_max=pilot_secret_use_count_max,
         )
     # Logs credentials creation
     logger.debug(f"{user_info.preferred_username} added {len(pilot_stamps)} pilots.")

extensions/gubbins/gubbins-client/src/gubbins/client/_generated/_client.py

@@ -20,6 +20,7 @@
     ConfigOperations,
     JobsOperations,
     LollygagOperations,
+    PilotsOperations,
     WellKnownOperations,
 )
 
@@ -37,6 +38,8 @@ class Dirac:  # pylint: disable=client-accepts-api-version-keyword
     :vartype jobs: _generated.operations.JobsOperations
     :ivar lollygag: LollygagOperations operations
     :vartype lollygag: _generated.operations.LollygagOperations
+    :ivar pilots: PilotsOperations operations
+    :vartype pilots: _generated.operations.PilotsOperations
     :keyword endpoint: Service URL. Required. Default value is "".
     :paramtype endpoint: str
     """
@@ -92,6 +95,9 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
         self.lollygag = LollygagOperations(
             self._client, self._config, self._serialize, self._deserialize
         )
+        self.pilots = PilotsOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
 
     def send_request(
         self, request: HttpRequest, *, stream: bool = False, **kwargs: Any

extensions/gubbins/gubbins-client/src/gubbins/client/_generated/aio/_client.py

@@ -20,6 +20,7 @@
     ConfigOperations,
     JobsOperations,
     LollygagOperations,
+    PilotsOperations,
     WellKnownOperations,
 )
 
@@ -37,6 +38,8 @@ class Dirac:  # pylint: disable=client-accepts-api-version-keyword
     :vartype jobs: _generated.aio.operations.JobsOperations
     :ivar lollygag: LollygagOperations operations
     :vartype lollygag: _generated.aio.operations.LollygagOperations
+    :ivar pilots: PilotsOperations operations
+    :vartype pilots: _generated.aio.operations.PilotsOperations
     :keyword endpoint: Service URL. Required. Default value is "".
     :paramtype endpoint: str
     """
@@ -92,6 +95,9 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
         self.lollygag = LollygagOperations(
             self._client, self._config, self._serialize, self._deserialize
         )
+        self.pilots = PilotsOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
 
     def send_request(
         self, request: HttpRequest, *, stream: bool = False, **kwargs: Any

extensions/gubbins/gubbins-client/src/gubbins/client/_generated/aio/operations/__init__.py

@@ -15,6 +15,7 @@
 from ._operations import ConfigOperations  # type: ignore
 from ._operations import JobsOperations  # type: ignore
 from ._operations import LollygagOperations  # type: ignore
+from ._operations import PilotsOperations  # type: ignore
 
 from ._patch import __all__ as _patch_all
 from ._patch import *
@@ -26,6 +27,7 @@
     "ConfigOperations",
     "JobsOperations",
     "LollygagOperations",
+    "PilotsOperations",
 ]
 __all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 _patch_sdk()