Initial implementation of Bulk Patch approach for Connections, replace default for mutable fields and fix a comment, Remove unit test for old method

Author: bugraoz93

airflow/api_fastapi/core_api/datamodels/connections.py

@@ -18,6 +18,7 @@
 from __future__ import annotations
 
 import json
+from typing import Any, Literal
 
 from pydantic import Field, field_validator
 from pydantic_core.core_schema import ValidationInfo
@@ -90,8 +91,74 @@ class ConnectionBody(BaseModel):
     extra: str | None = Field(default=None)
 
 
-class ConnectionBulkBody(BaseModel):
-    """Connections Serializer for requests body."""
+class ConnectionBulkCreateAction(BaseModel):
+    """Bulk Create Variable serializer for request bodies."""
+
+    action: Literal["create"] = "create"
+    connections: list[ConnectionBody] = Field(..., description="A list of connections to be created.")
+    action_if_exists: Literal["skip", "overwrite", "fail"] = "fail"
+
+
+class ConnectionBulkUpdateAction(BaseModel):
+    """Bulk Update Connection serializer for request bodies."""
+
+    action: Literal["update"] = "update"
+    connections: list[ConnectionBody] = Field(..., description="A list of connections to be updated.")
+    action_if_not_exists: Literal["skip", "fail"] = "fail"
 
-    connections: list[ConnectionBody]
-    overwrite: bool | None = Field(default=False)
+
+class ConnectionBulkDeleteAction(BaseModel):
+    """Bulk Delete Connection serializer for request bodies."""
+
+    action: Literal["delete"] = "delete"
+    connection_ids: list[str] = Field(..., description="A list of connection IDs to be deleted.")
+    action_if_not_exists: Literal["skip", "fail"] = "fail"
+
+
+class ConnectionBulkBody(BaseModel):
+    """Request body for bulk Connection operations (create, update, delete)."""
+
+    actions: list[ConnectionBulkCreateAction | ConnectionBulkUpdateAction | ConnectionBulkDeleteAction] = (
+        Field(..., description="A list of Connection actions to perform.")
+    )
+
+
+class ConnectionBulkActionResponse(BaseModel):
+    """
+    Serializer for individual bulk action responses.
+
+    Represents the outcome of a single bulk operation (create, update, or delete).
+    The response includes a list of successful connection_ids and any errors encountered during the operation.
+    This structure helps users understand which key actions succeeded and which failed.
+    """
+
+    success: list[str] = Field(
+        default_factory=list, description="A list of connection_ids representing successful operations."
+    )
+    errors: list[dict[str, Any]] = Field(
+        default_factory=list,
+        description="A list of errors encountered during the operation, each containing details about the issue.",
+    )
+
+
+class ConnectionBulkResponse(BaseModel):
+    """
+    Serializer for responses to bulk connection operations.
+
+    This represents the results of create, update, and delete actions performed on connections in bulk.
+    Each action (if requested) is represented as a field containing details about successful connection_ids and any encountered errors.
+    Fields are populated in the response only if the respective action was part of the request, else are set None.
+    """
+
+    create: ConnectionBulkActionResponse | None = Field(
+        default=None,
+        description="Details of the bulk create operation, including successful connection_ids and errors.",
+    )
+    update: ConnectionBulkActionResponse | None = Field(
+        default=None,
+        description="Details of the bulk update operation, including successful connection_ids and errors.",
+    )
+    delete: ConnectionBulkActionResponse | None = Field(
+        default=None,
+        description="Details of the bulk delete operation, including successful connection_ids and errors.",
+    )

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

@@ -1786,50 +1786,49 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPValidationError'
-  /public/connections/bulk:
-    put:
+    patch:
       tags:
       - Connection
-      summary: Put Connections
-      description: Create connection entry.
-      operationId: put_connections
+      summary: Bulk Connections
+      description: Bulk create, update, and delete connections.
+      operationId: bulk_connections
       requestBody:
+        required: true
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/ConnectionBulkBody'
-        required: true
       responses:
         '200':
-          description: Created with overwrite
+          description: Successful Response
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ConnectionCollectionResponse'
+                $ref: '#/components/schemas/ConnectionBulkResponse'
         '401':
-          description: Unauthorized
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Unauthorized
         '403':
-          description: Forbidden
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
-        '409':
-          description: Conflict
+          description: Forbidden
+        '404':
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
-        '201':
-          description: Created
+          description: Not Found
+        '409':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ConnectionCollectionResponse'
+                $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Conflict
         '422':
           description: Validation Error
           content:
@@ -1850,7 +1849,7 @@ paths:
         as some hook classes tries to find out the `conn` from their __init__ method
         & errors out if not found.
 
-        It also deletes the conn id env variable after the test.'
+        It also deletes the conn id env connection after the test.'
       operationId: test_connection
       requestBody:
         content:
@@ -5983,6 +5982,18 @@ paths:
               schema:
                 $ref: '#/components/schemas/HTTPExceptionResponse'
           description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Not Found
+        '409':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPExceptionResponse'
+          description: Conflict
         '422':
           description: Validation Error
           content:
@@ -6886,24 +6897,158 @@ components:
       - conn_type
       title: ConnectionBody
       description: Connection Serializer for requests body.
+    ConnectionBulkActionResponse:
+      properties:
+        success:
+          items:
+            type: string
+          type: array
+          title: Success
+          description: A list of connection_ids representing successful operations.
+        errors:
+          items:
+            type: object
+          type: array
+          title: Errors
+          description: A list of errors encountered during the operation, each containing
+            details about the issue.
+      type: object
+      title: ConnectionBulkActionResponse
+      description: 'Serializer for individual bulk action responses.
+
+
+        Represents the outcome of a single bulk operation (create, update, or delete).
+
+        The response includes a list of successful connection_ids and any errors encountered
+        during the operation.
+
+        This structure helps users understand which key actions succeeded and which
+        failed.'
     ConnectionBulkBody:
       properties:
+        actions:
+          items:
+            anyOf:
+            - $ref: '#/components/schemas/ConnectionBulkCreateAction'
+            - $ref: '#/components/schemas/ConnectionBulkUpdateAction'
+            - $ref: '#/components/schemas/ConnectionBulkDeleteAction'
+          type: array
+          title: Actions
+          description: A list of Connection actions to perform.
+      type: object
+      required:
+      - actions
+      title: ConnectionBulkBody
+      description: Request body for bulk Connection operations (create, update, delete).
+    ConnectionBulkCreateAction:
+      properties:
+        action:
+          type: string
+          const: create
+          title: Action
+          default: create
         connections:
           items:
             $ref: '#/components/schemas/ConnectionBody'
           type: array
           title: Connections
-        overwrite:
+          description: A list of connections to be created.
+        action_if_exists:
+          type: string
+          enum:
+          - skip
+          - overwrite
+          - fail
+          title: Action If Exists
+          default: fail
+      type: object
+      required:
+      - connections
+      title: ConnectionBulkCreateAction
+      description: Bulk Create Variable serializer for request bodies.
+    ConnectionBulkDeleteAction:
+      properties:
+        action:
+          type: string
+          const: delete
+          title: Action
+          default: delete
+        connection_ids:
+          items:
+            type: string
+          type: array
+          title: Connection Ids
+          description: A list of connection IDs to be deleted.
+        action_if_not_exists:
+          type: string
+          enum:
+          - skip
+          - fail
+          title: Action If Not Exists
+          default: fail
+      type: object
+      required:
+      - connection_ids
+      title: ConnectionBulkDeleteAction
+      description: Bulk Delete Connection serializer for request bodies.
+    ConnectionBulkResponse:
+      properties:
+        create:
           anyOf:
-          - type: boolean
+          - $ref: '#/components/schemas/ConnectionBulkActionResponse'
           - type: 'null'
-          title: Overwrite
-          default: false
+          description: Details of the bulk create operation, including successful
+            connection_ids and errors.
+        update:
+          anyOf:
+          - $ref: '#/components/schemas/ConnectionBulkActionResponse'
+          - type: 'null'
+          description: Details of the bulk update operation, including successful
+            connection_ids and errors.
+        delete:
+          anyOf:
+          - $ref: '#/components/schemas/ConnectionBulkActionResponse'
+          - type: 'null'
+          description: Details of the bulk delete operation, including successful
+            connection_ids and errors.
+      type: object
+      title: ConnectionBulkResponse
+      description: 'Serializer for responses to bulk connection operations.
+
+
+        This represents the results of create, update, and delete actions performed
+        on connections in bulk.
+
+        Each action (if requested) is represented as a field containing details about
+        successful connection_ids and any encountered errors.
+
+        Fields are populated in the response only if the respective action was part
+        of the request, else are set None.'
+    ConnectionBulkUpdateAction:
+      properties:
+        action:
+          type: string
+          const: update
+          title: Action
+          default: update
+        connections:
+          items:
+            $ref: '#/components/schemas/ConnectionBody'
+          type: array
+          title: Connections
+          description: A list of connections to be updated.
+        action_if_not_exists:
+          type: string
+          enum:
+          - skip
+          - fail
+          title: Action If Not Exists
+          default: fail
       type: object
       required:
       - connections
-      title: ConnectionBulkBody
-      description: Connections Serializer for requests body.
+      title: ConnectionBulkUpdateAction
+      description: Bulk Update Connection serializer for request bodies.
     ConnectionCollectionResponse:
       properties:
         connections: