Weaviate REST API — batch

naftiko: 1.0.0-alpha2
info:
  label: Weaviate REST API — batch
  description: 'Weaviate REST API — batch. 3 operations. Lead operation: Weaviate Create Objects In Batch. Self-contained
    Naftiko capability covering one Weaviate business surface.'
  tags:
  - Weaviate
  - batch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEAVIATE_API_KEY: WEAVIATE_API_KEY
capability:
  consumes:
  - type: http
    namespace: weaviate-batch
    baseUri: http://localhost:8080
    description: Weaviate REST API — batch business capability. Self-contained, no shared references.
    resources:
    - name: batch-objects
      path: /batch/objects
      operations:
      - name: batchobjectscreate
        method: POST
        description: Weaviate Create Objects In Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: consistency_level
          in: query
          type: string
          description: Determines how many replicas must acknowledge a request before it is considered successful.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: batchobjectsdelete
        method: DELETE
        description: Weaviate Delete Objects In Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: consistency_level
          in: query
          type: string
          description: Determines how many replicas must acknowledge a request before it is considered successful.
        - name: tenant
          in: query
          type: string
          description: Specifies the tenant in a request targeting a multi-tenant collection (class).
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: batch-references
      path: /batch/references
      operations:
      - name: batchreferencescreate
        method: POST
        description: Weaviate Create Cross-References In Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: consistency_level
          in: query
          type: string
          description: Determines how many replicas must acknowledge a request before it is considered successful.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.WEAVIATE_API_KEY}}'
  exposes:
  - type: rest
    namespace: weaviate-batch-rest
    port: 8080
    description: REST adapter for Weaviate REST API — batch. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/batch/objects
      name: batch-objects
      description: REST surface for batch-objects.
      operations:
      - method: POST
        name: batchobjectscreate
        description: Weaviate Create Objects In Batch
        call: weaviate-batch.batchobjectscreate
        with:
          consistency_level: rest.consistency_level
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: batchobjectsdelete
        description: Weaviate Delete Objects In Batch
        call: weaviate-batch.batchobjectsdelete
        with:
          consistency_level: rest.consistency_level
          tenant: rest.tenant
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/batch/references
      name: batch-references
      description: REST surface for batch-references.
      operations:
      - method: POST
        name: batchreferencescreate
        description: Weaviate Create Cross-References In Bulk
        call: weaviate-batch.batchreferencescreate
        with:
          consistency_level: rest.consistency_level
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: weaviate-batch-mcp
    port: 9090
    transport: http
    description: MCP adapter for Weaviate REST API — batch. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: weaviate-create-objects-batch
      description: Weaviate Create Objects In Batch
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: weaviate-batch.batchobjectscreate
      with:
        consistency_level: tools.consistency_level
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: weaviate-delete-objects-batch
      description: Weaviate Delete Objects In Batch
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: weaviate-batch.batchobjectsdelete
      with:
        consistency_level: tools.consistency_level
        tenant: tools.tenant
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: weaviate-create-cross-references-bulk
      description: Weaviate Create Cross-References In Bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: weaviate-batch.batchreferencescreate
      with:
        consistency_level: tools.consistency_level
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.