openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Data Flow Debug Session API
  description: >-
    Manage data flow debug sessions for interactive testing and debugging of
    data flow transformations. Enables previewing data and validating
    transformation logic before deployment.
  version: '2020-12-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
  - url: https://{workspaceName}.dev.azuresynapse.net
    description: Synapse Data Plane
    variables:
      workspaceName:
        default: myworkspace
security:
  - azure_auth:
      - user_impersonation
paths:
  /queryDataFlowDebugSessions:
    post:
      operationId: DataFlowDebugSession_QueryDataFlowDebugSessionsByWorkspace
      summary: Azure Synapse Analytics List data flow debug sessions
      description: Query all active data flow debug sessions.
      tags:
        - DataFlowDebugSession
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDataFlowDebugSessionsResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /createDataFlowDebugSession:
    post:
      operationId: DataFlowDebugSession_CreateDataFlowDebugSession
      summary: Azure Synapse Analytics Create a data flow debug session
      description: Creates a data flow debug session.
      tags:
        - DataFlowDebugSession
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataFlowDebugSessionRequest'
      responses:
        '200':
          description: Successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataFlowDebugSessionResponse'
        '202':
          description: Creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /addDataFlowToDebugSession:
    post:
      operationId: DataFlowDebugSession_AddDataFlow
      summary: Azure Synapse Analytics Add a data flow to debug session
      description: Add a data flow into debug session.
      tags:
        - DataFlowDebugSession
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFlowDebugPackage'
      responses:
        '200':
          description: Successfully added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddDataFlowToDebugSessionResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /deleteDataFlowDebugSession:
    post:
      operationId: DataFlowDebugSession_DeleteDataFlowDebugSession
      summary: Azure Synapse Analytics Delete a data flow debug session
      description: Deletes a data flow debug session.
      tags:
        - DataFlowDebugSession
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDataFlowDebugSessionRequest'
      responses:
        '200':
          description: Successfully deleted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /executeDataFlowDebugCommand:
    post:
      operationId: DataFlowDebugSession_ExecuteCommand
      summary: Azure Synapse Analytics Execute a data flow debug command
      description: Execute a data flow debug command.
      tags:
        - DataFlowDebugSession
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFlowDebugCommandRequest'
      responses:
        '200':
          description: Successfully executed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlowDebugCommandResponse'
        '202':
          description: Execution accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2020-12-01'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    QueryDataFlowDebugSessionsResponse:
      type: object
      properties:
        value:
          type: array
          items:
            type: object
            properties:
              dataFlowName:
                type: string
              computeType:
                type: string
              coreCount:
                type: integer
              nodeCount:
                type: integer
              integrationRuntimeName:
                type: string
              sessionId:
                type: string
              startTime:
                type: string
              timeToLiveInMinutes:
                type: integer
              lastActivityTime:
                type: string
        nextLink:
          type: string
    CreateDataFlowDebugSessionRequest:
      type: object
      properties:
        computeType:
          type: string
        coreCount:
          type: integer
        timeToLiveInMinutes:
          type: integer
        integrationRuntime:
          type: object
          properties:
            name:
              type: string
            properties:
              type: object
    CreateDataFlowDebugSessionResponse:
      type: object
      properties:
        status:
          type: string
        sessionId:
          type: string
    DataFlowDebugPackage:
      type: object
      properties:
        sessionId:
          type: string
        dataFlow:
          type: object
          properties:
            name:
              type: string
            properties:
              type: object
        datasets:
          type: array
          items:
            type: object
        linkedServices:
          type: array
          items:
            type: object
        staging:
          type: object
        debugSettings:
          type: object
    AddDataFlowToDebugSessionResponse:
      type: object
      properties:
        jobVersion:
          type: string
    DeleteDataFlowDebugSessionRequest:
      type: object
      properties:
        sessionId:
          type: string
    DataFlowDebugCommandRequest:
      type: object
      properties:
        sessionId:
          type: string
        command:
          type: string
          enum:
            - executePreviewQuery
            - executeStatisticsQuery
            - executeExpressionQuery
        commandPayload:
          type: object
          properties:
            streamName:
              type: string
            rowLimits:
              type: integer
            columns:
              type: array
              items:
                type: string
            expression:
              type: string
    DataFlowDebugCommandResponse:
      type: object
      properties:
        status:
          type: string
        data:
          type: string
tags:
  - name: DataFlowDebugSession