Azure AI Search REST API — Documents

naftiko: 1.0.0-alpha2
info:
  label: Azure AI Search REST API — Documents
  description: 'Azure AI Search REST API — Documents. 2 operations. Lead operation: Search Search documents. Self-contained
    Naftiko capability covering one Microsoft Azure Search business surface.'
  tags:
  - Microsoft Azure Search
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_SEARCH_API_KEY: MICROSOFT_AZURE_SEARCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: microsoft-azure-search-documents
    baseUri: https://{search-service}.search.windows.net
    description: Azure AI Search REST API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: indexes('{indexName}')-docs
      path: /indexes('{indexName}')/docs
      operations:
      - name: searchdocuments
        method: GET
        description: Search Search documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: search
          in: query
          type: string
    - name: indexes('{indexName}')-docs-search.index
      path: /indexes('{indexName}')/docs/search.index
      operations:
      - name: indexdocuments
        method: POST
        description: Search Index documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: api-key
      value: '{{env.MICROSOFT_AZURE_SEARCH_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: microsoft-azure-search-documents-rest
    port: 8080
    description: REST adapter for Azure AI Search REST API — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/indexes-indexname/docs
      name: indexes-indexname-docs
      description: REST surface for indexes('{indexName}')-docs.
      operations:
      - method: GET
        name: searchdocuments
        description: Search Search documents
        call: microsoft-azure-search-documents.searchdocuments
        with:
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/indexes-indexname/docs/search-index
      name: indexes-indexname-docs-search-index
      description: REST surface for indexes('{indexName}')-docs-search.index.
      operations:
      - method: POST
        name: indexdocuments
        description: Search Index documents
        call: microsoft-azure-search-documents.indexdocuments
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: microsoft-azure-search-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Azure AI Search REST API — Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: search-search-documents
      description: Search Search documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-azure-search-documents.searchdocuments
      with:
        search: tools.search
      outputParameters:
      - type: object
        mapping: $.
    - name: search-index-documents
      description: Search Index documents
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: microsoft-azure-search-documents.indexdocuments
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.