fix(hitl): make the user model in HITLDetail consistent with airflow user model (apache#55463)

Author: Lee-W

airflow-core/docs/img/airflow_erd.sha256

@@ -1 +1 @@
-c05cefbe080ed889ebe132a0285756db477ff28256bbc1e86da1e053873f6478
+e491b0c58188f06ab4696cc09c765413065069f90d78e27eb53fdac5e2e92c82

airflow-core/docs/img/airflow_erd.svg

@@ -95,6 +95,9 @@ Approval or Rejection
 ---------------------
 
 A specialized form of option selection, which has only 'Approval' and 'Rejection' as options.
+You can also set the ``assigned_users`` to restrict the users allowed to respond for a HITL operator.
+It should be a list of user ids and user names (both needed) (e.g., ``[{"id": "1", "name": "user1"}, {"id": "2", "name": "user2"}]``.
+ONLY the users within this list will be allowed to respond.
 
 .. exampleinclude:: /../../providers/standard/src/airflow/providers/standard/example_dags/example_hitl_operator.py
    :language: python

airflow-core/docs/tutorial/hitl.rst

@@ -1022,27 +1022,28 @@ def _optional_boolean(value: bool | None) -> bool | None:
         )
     ),
 ]
+
 QueryHITLDetailRespondedUserIdFilter = Annotated[
     FilterParam[list[str]],
     Depends(
         filter_param_factory(
-            HITLDetail.responded_user_id,
+            HITLDetail.responded_by_user_id,
             list[str],
             FilterOptionEnum.ANY_EQUAL,
             default_factory=list,
-            filter_name="responded_user_id",
+            filter_name="responded_by_user_id",
         )
     ),
 ]
 QueryHITLDetailRespondedUserNameFilter = Annotated[
     FilterParam[list[str]],
     Depends(
         filter_param_factory(
-            HITLDetail.responded_user_name,
+            HITLDetail.responded_by_user_name,
             list[str],
             FilterOptionEnum.ANY_EQUAL,
             default_factory=list,
-            filter_name="responded_user_name",
+            filter_name="responded_by_user_name",
         )
     ),
 ]

airflow-core/src/airflow/api_fastapi/common/parameters.py

@@ -37,13 +37,19 @@ class UpdateHITLDetailPayload(BaseModel):
 class HITLDetailResponse(BaseModel):
     """Response of updating a Human-in-the-loop detail."""
 
-    responded_user_id: str
-    responded_user_name: str
+    responded_by: HITLUser
     response_at: datetime
     chosen_options: list[str] = Field(min_length=1)
     params_input: Mapping = Field(default_factory=dict)
 
 
+class HITLUser(BaseModel):
+    """Schema for a Human-in-the-loop users."""
+
+    id: str
+    name: str
+
+
 class HITLDetail(BaseModel):
     """Schema for Human-in-the-loop detail."""
 
@@ -56,11 +62,10 @@ class HITLDetail(BaseModel):
     defaults: list[str] | None = None
     multiple: bool = False
     params: dict[str, Any] = Field(default_factory=dict)
-    respondents: list[str] | None = None
+    assigned_users: list[HITLUser] = Field(default_factory=list)
 
     # Response Content Detail
-    responded_user_id: str | None = None
-    responded_user_name: str | None = None
+    responded_by_user: HITLUser | None = None
     response_at: datetime | None = None
     chosen_options: list[str] | None = None
     params_input: dict[str, Any] = Field(default_factory=dict)

airflow-core/src/airflow/api_fastapi/core_api/datamodels/hitl.py

@@ -1994,23 +1994,15 @@ components:
           additionalProperties: true
           type: object
           title: Params
-        respondents:
-          anyOf:
-          - items:
-              type: string
-            type: array
-          - type: 'null'
-          title: Respondents
-        responded_user_id:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Responded User Id
-        responded_user_name:
+        assigned_users:
+          items:
+            $ref: '#/components/schemas/HITLUser'
+          type: array
+          title: Assigned Users
+        responded_by_user:
           anyOf:
-          - type: string
+          - $ref: '#/components/schemas/HITLUser'
           - type: 'null'
-          title: Responded User Name
         response_at:
           anyOf:
           - type: string
@@ -2039,6 +2031,20 @@ components:
       - subject
       title: HITLDetail
       description: Schema for Human-in-the-loop detail.
+    HITLUser:
+      properties:
+        id:
+          type: string
+          title: Id
+        name:
+          type: string
+          title: Name
+      type: object
+      required:
+      - id
+      - name
+      title: HITLUser
+      description: Schema for a Human-in-the-loop users.
     HTTPExceptionResponse:
       properties:
         detail: