add doc

bisgaard-itis · bisgaard-itis · commit 31fc2916b289 · 2025-09-11T16:57:23.000+02:00
diff --git a/packages/models-library/src/models_library/api_schemas_rpc_async_jobs/async_jobs.py b/packages/models-library/src/models_library/api_schemas_rpc_async_jobs/async_jobs.py
@@ -67,7 +67,7 @@ class AsyncJobFilter(AsyncJobFilterBase):
 
     product_name: ProductName
     user_id: UserID
-    client_name: Annotated[
+    client_name: Annotated[  # this is the name of the app which *submits* the async job. It is mainly used for filtering purposes
         str,
         StringConstraints(min_length=1, pattern=r"^[^\s]+$"),
     ]

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ class AsyncJobFilter(AsyncJobFilterBase):`
`67`	`67`
`68`	`68`	`product_name: ProductName`
`69`	`69`	`user_id: UserID`
`70`		`- client_name: Annotated[`
	`70`	`+ client_name: Annotated[ # this is the name of the app which submits the async job. It is mainly used for filtering purposes`
`71`	`71`	`str,`
`72`	`72`	`StringConstraints(min_length=1, pattern=r"^[^\s]+$"),`
`73`	`73`	`]`