openapi: 3.1.0
info:
  title: Azure Synapse Analytics - SQL Script API
  description: >-
    Create, update, list, and delete SQL scripts within a Synapse workspace. SQL
    scripts can target both dedicated and serverless SQL pools for querying and
    data management.
  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:
  /sqlScripts:
    get:
      operationId: SqlScript_GetSqlScriptsByWorkspace
      summary: Azure Synapse Analytics List SQL scripts
      description: Lists SQL scripts in the workspace.
      tags:
        - SqlScript
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of SQL scripts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlScriptListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /sqlScripts/{sqlScriptName}:
    get:
      operationId: SqlScript_GetSqlScript
      summary: Azure Synapse Analytics Get a SQL script
      description: Gets a SQL script.
      tags:
        - SqlScript
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/SqlScriptNameParameter'
        - name: If-None-Match
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved the SQL script.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlScriptResource'
        '304':
          description: Not modified.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: SqlScript_CreateOrUpdateSqlScript
      summary: Azure Synapse Analytics Create or update a SQL script
      description: Creates or updates a SQL script.
      tags:
        - SqlScript
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/SqlScriptNameParameter'
        - name: If-Match
          in: header
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SqlScriptResource'
      responses:
        '200':
          description: Successfully updated the SQL script.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlScriptResource'
        '202':
          description: SQL script creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: SqlScript_DeleteSqlScript
      summary: Azure Synapse Analytics Delete a SQL script
      description: Deletes a SQL script.
      tags:
        - SqlScript
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/SqlScriptNameParameter'
      responses:
        '200':
          description: Successfully deleted the SQL script.
        '202':
          description: SQL script deletion accepted.
        '204':
          description: SQL script not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /sqlScripts/{sqlScriptName}/rename:
    post:
      operationId: SqlScript_RenameSqlScript
      summary: Azure Synapse Analytics Rename a SQL script
      description: Renames a SQL script.
      tags:
        - SqlScript
      parameters:
        - $ref: '#/components/parameters/ApiVersionParameter'
        - $ref: '#/components/parameters/SqlScriptNameParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactRenameRequest'
      responses:
        '200':
          description: Successfully renamed.
        '202':
          description: Rename 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'
    SqlScriptNameParameter:
      name: sqlScriptName
      in: path
      required: true
      description: The SQL script name.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    SqlScriptListResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/SqlScriptResource'
        nextLink:
          type: string
    SqlScriptResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        etag:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/SqlScript'
    SqlScript:
      type: object
      required:
        - content
      properties:
        description:
          type: string
        type:
          type: string
          enum:
            - SqlQuery
        content:
          $ref: '#/components/schemas/SqlScriptContent'
        folder:
          type: object
          properties:
            name:
              type: string
    SqlScriptContent:
      type: object
      required:
        - query
        - currentConnection
      properties:
        query:
          type: string
          description: SQL query content.
        metadata:
          type: object
          properties:
            language:
              type: string
        currentConnection:
          type: object
          properties:
            name:
              type: string
              description: The connected pool name.
            type:
              type: string
              description: The pool type.
              enum:
                - SqlOnDemand
                - SqlPool
        resultLimit:
          type: integer
          description: Limit of results.
    ArtifactRenameRequest:
      type: object
      properties:
        newName:
          type: string
tags:
  - name: SqlScript