Azure Synapse Analytics - Notebook API — Notebook

naftiko: 1.0.0-alpha2
info:
  label: Azure Synapse Analytics - Notebook API — Notebook
  description: 'Azure Synapse Analytics - Notebook API — Notebook. 6 operations. Lead operation: Azure Synapse Analytics List
    notebooks. Self-contained Naftiko capability covering one Microsoft Azure Synapse Analytics business surface.'
  tags:
  - Microsoft Azure Synapse Analytics
  - Notebook
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY: MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-synapse-analytics-notebook-notebook
    baseUri: https://{workspaceName}.dev.azuresynapse.net
    description: Azure Synapse Analytics - Notebook API — Notebook business capability. Self-contained, no shared references.
    resources:
    - name: notebooks
      path: /notebooks
      operations:
      - name: notebookgetnotebooksbyworkspace
        method: GET
        description: Azure Synapse Analytics List notebooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: notebooks-summary
      path: /notebooks/summary
      operations:
      - name: notebookgetnotebooksummarybyworkspace
        method: GET
        description: Azure Synapse Analytics List notebook summaries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: notebooks-notebookName
      path: /notebooks/{notebookName}
      operations:
      - name: notebookgetnotebook
        method: GET
        description: Azure Synapse Analytics Get a notebook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-None-Match
          in: header
          type: string
      - name: notebookcreateorupdatenotebook
        method: PUT
        description: Azure Synapse Analytics Create or update a notebook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-Match
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: notebookdeletenotebook
        method: DELETE
        description: Azure Synapse Analytics Delete a notebook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: notebooks-notebookName-rename
      path: /notebooks/{notebookName}/rename
      operations:
      - name: notebookrenamenotebook
        method: POST
        description: Azure Synapse Analytics Rename a notebook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY}}'
  exposes:
  - type: rest
    namespace: azure-synapse-analytics-notebook-notebook-rest
    port: 8080
    description: REST adapter for Azure Synapse Analytics - Notebook API — Notebook. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/notebooks
      name: notebooks
      description: REST surface for notebooks.
      operations:
      - method: GET
        name: notebookgetnotebooksbyworkspace
        description: Azure Synapse Analytics List notebooks
        call: azure-synapse-analytics-notebook-notebook.notebookgetnotebooksbyworkspace
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notebooks/summary
      name: notebooks-summary
      description: REST surface for notebooks-summary.
      operations:
      - method: GET
        name: notebookgetnotebooksummarybyworkspace
        description: Azure Synapse Analytics List notebook summaries
        call: azure-synapse-analytics-notebook-notebook.notebookgetnotebooksummarybyworkspace
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notebooks/{notebookname}
      name: notebooks-notebookname
      description: REST surface for notebooks-notebookName.
      operations:
      - method: GET
        name: notebookgetnotebook
        description: Azure Synapse Analytics Get a notebook
        call: azure-synapse-analytics-notebook-notebook.notebookgetnotebook
        with:
          If-None-Match: rest.If-None-Match
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: notebookcreateorupdatenotebook
        description: Azure Synapse Analytics Create or update a notebook
        call: azure-synapse-analytics-notebook-notebook.notebookcreateorupdatenotebook
        with:
          If-Match: rest.If-Match
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: notebookdeletenotebook
        description: Azure Synapse Analytics Delete a notebook
        call: azure-synapse-analytics-notebook-notebook.notebookdeletenotebook
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notebooks/{notebookname}/rename
      name: notebooks-notebookname-rename
      description: REST surface for notebooks-notebookName-rename.
      operations:
      - method: POST
        name: notebookrenamenotebook
        description: Azure Synapse Analytics Rename a notebook
        call: azure-synapse-analytics-notebook-notebook.notebookrenamenotebook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-synapse-analytics-notebook-notebook-mcp
    port: 9090
    transport: http
    description: MCP adapter for Azure Synapse Analytics - Notebook API — Notebook. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: azure-synapse-analytics-list-notebooks
      description: Azure Synapse Analytics List notebooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-notebook-notebook.notebookgetnotebooksbyworkspace
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-list-notebook
      description: Azure Synapse Analytics List notebook summaries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-notebook-notebook.notebookgetnotebooksummarybyworkspace
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-get-notebook
      description: Azure Synapse Analytics Get a notebook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-notebook-notebook.notebookgetnotebook
      with:
        If-None-Match: tools.If-None-Match
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-update
      description: Azure Synapse Analytics Create or update a notebook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-notebook-notebook.notebookcreateorupdatenotebook
      with:
        If-Match: tools.If-Match
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-delete-notebook
      description: Azure Synapse Analytics Delete a notebook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-synapse-analytics-notebook-notebook.notebookdeletenotebook
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-rename-notebook
      description: Azure Synapse Analytics Rename a notebook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-notebook-notebook.notebookrenamenotebook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.