AIP-84 constraint wildcard path params for get batch TI (#44175)

Author: pierrejeambrun

airflow/api_fastapi/core_api/openapi/v1-generated.yaml

@@ -3620,12 +3620,31 @@ paths:
       summary: Get Task Instances Batch
       description: Get list of task instances.
       operationId: get_task_instances_batch
+      parameters:
+      - name: dag_id
+        in: path
+        required: true
+        schema:
+          enum:
+          - '~'
+          const: '~'
+          type: string
+          title: Dag Id
+      - name: dag_run_id
+        in: path
+        required: true
+        schema:
+          enum:
+          - '~'
+          const: '~'
+          type: string
+          title: Dag Run Id
       requestBody:
+        required: true
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/TaskInstancesBatchBody'
-        required: true
       responses:
         '200':
           description: Successful Response
@@ -3634,23 +3653,23 @@ paths:
               schema:
                 $ref: '#/components/schemas/TaskInstanceCollectionResponse'
         '401':
-          description: Unauthorized
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Unauthorized
         '403':
-          description: Forbidden
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Forbidden
         '404':
-          description: Not Found
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Not Found
         '422':
           description: Validation Error
           content:

airflow/api_fastapi/core_api/routes/public/task_instances.py

@@ -17,7 +17,7 @@
 
 from __future__ import annotations
 
-from typing import Annotated
+from typing import Annotated, Literal
 
 from fastapi import Depends, HTTPException, Request, status
 from sqlalchemy.orm import Session, joinedload
@@ -339,6 +339,8 @@ def get_task_instances(
     responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]),
 )
 def get_task_instances_batch(
+    dag_id: Literal["~"],
+    dag_run_id: Literal["~"],
     body: TaskInstancesBatchBody,
     session: Annotated[Session, Depends(get_session)],
 ) -> TaskInstanceCollectionResponse:

airflow/ui/openapi-gen/queries/queries.ts

@@ -2077,6 +2077,8 @@ export const usePoolServicePostPool = <
  * Get Task Instances Batch
  * Get list of task instances.
  * @param data The data for the request.
+ * @param data.dagId
+ * @param data.dagRunId
  * @param data.requestBody
  * @returns TaskInstanceCollectionResponse Successful Response
  * @throws ApiError
@@ -2091,6 +2093,8 @@ export const useTaskInstanceServiceGetTaskInstancesBatch = <
       TData,
       TError,
       {
+        dagId: "~";
+        dagRunId: "~";
         requestBody: TaskInstancesBatchBody;
       },
       TContext
@@ -2102,12 +2106,16 @@ export const useTaskInstanceServiceGetTaskInstancesBatch = <
     TData,
     TError,
     {
+      dagId: "~";
+      dagRunId: "~";
       requestBody: TaskInstancesBatchBody;
     },
     TContext
   >({
-    mutationFn: ({ requestBody }) =>
+    mutationFn: ({ dagId, dagRunId, requestBody }) =>
       TaskInstanceService.getTaskInstancesBatch({
+        dagId,
+        dagRunId,
         requestBody,
       }) as unknown as Promise<TData>,
     ...options,

airflow/ui/openapi-gen/requests/services.gen.ts

@@ -1931,6 +1931,8 @@ export class TaskInstanceService {
    * Get Task Instances Batch
    * Get list of task instances.
    * @param data The data for the request.
+   * @param data.dagId
+   * @param data.dagRunId
    * @param data.requestBody
    * @returns TaskInstanceCollectionResponse Successful Response
    * @throws ApiError
@@ -1941,6 +1943,10 @@ export class TaskInstanceService {
     return __request(OpenAPI, {
       method: "POST",
       url: "/public/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/list",
+      path: {
+        dag_id: data.dagId,
+        dag_run_id: data.dagRunId,
+      },
       body: data.requestBody,
       mediaType: "application/json",
       errors: {

airflow/ui/openapi-gen/requests/types.gen.ts

@@ -1505,6 +1505,8 @@ export type GetTaskInstancesData = {
 export type GetTaskInstancesResponse = TaskInstanceCollectionResponse;
 
 export type GetTaskInstancesBatchData = {
+  dagId: "~";
+  dagRunId: "~";
   requestBody: TaskInstancesBatchBody;
 };
 

tests/api_fastapi/core_api/routes/public/test_task_instances.py

@@ -1341,6 +1341,19 @@ def test_should_raise_400_for_no_json(self, test_client):
             },
         ]
 
+    def test_should_respond_422_for_non_wildcard_path_parameters(self, test_client):
+        response = test_client.post(
+            "/public/dags/non_wildcard/dagRuns/~/taskInstances/list",
+        )
+        assert response.status_code == 422
+        assert "Input should be '~'" in str(response.json()["detail"])
+
+        response = test_client.post(
+            "/public/dags/~/dagRuns/non_wildcard/taskInstances/list",
+        )
+        assert response.status_code == 422
+        assert "Input should be '~'" in str(response.json()["detail"])
+
     @pytest.mark.parametrize(
         "payload, expected",
         [