Weaviate REST API — export

naftiko: 1.0.0-alpha2
info:
  label: Weaviate REST API — export
  description: 'Weaviate REST API — export. 3 operations. Lead operation: Weaviate Start A New Export. Self-contained Naftiko
    capability covering one Weaviate business surface.'
  tags:
  - Weaviate
  - export
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEAVIATE_API_KEY: WEAVIATE_API_KEY
capability:
  consumes:
  - type: http
    namespace: weaviate-export
    baseUri: http://localhost:8080
    description: Weaviate REST API — export business capability. Self-contained, no shared references.
    resources:
    - name: export-backend
      path: /export/{backend}
      operations:
      - name: exportcreate
        method: POST
        description: Weaviate Start A New Export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: backend
          in: path
          type: string
          description: The backend storage system to use for the export (e.g., `filesystem`, `gcs`, `s3`, `azure`).
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: export-backend-id
      path: /export/{backend}/{id}
      operations:
      - name: exportstatus
        method: GET
        description: Weaviate Get Export Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: backend
          in: path
          type: string
          description: The backend storage system where the export is stored.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier of the export.
          required: true
      - name: exportcancel
        method: DELETE
        description: Weaviate Cancel An Export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: backend
          in: path
          type: string
          description: The backend storage system where the export is stored.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier of the export to cancel.
          required: true
    authentication:
      type: bearer
      token: '{{env.WEAVIATE_API_KEY}}'
  exposes:
  - type: rest
    namespace: weaviate-export-rest
    port: 8080
    description: REST adapter for Weaviate REST API — export. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/export/{backend}
      name: export-backend
      description: REST surface for export-backend.
      operations:
      - method: POST
        name: exportcreate
        description: Weaviate Start A New Export
        call: weaviate-export.exportcreate
        with:
          backend: rest.backend
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/export/{backend}/{id}
      name: export-backend-id
      description: REST surface for export-backend-id.
      operations:
      - method: GET
        name: exportstatus
        description: Weaviate Get Export Status
        call: weaviate-export.exportstatus
        with:
          backend: rest.backend
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: exportcancel
        description: Weaviate Cancel An Export
        call: weaviate-export.exportcancel
        with:
          backend: rest.backend
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: weaviate-export-mcp
    port: 9090
    transport: http
    description: MCP adapter for Weaviate REST API — export. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: weaviate-start-new-export
      description: Weaviate Start A New Export
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: weaviate-export.exportcreate
      with:
        backend: tools.backend
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: weaviate-get-export-status
      description: Weaviate Get Export Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: weaviate-export.exportstatus
      with:
        backend: tools.backend
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: weaviate-cancel-export
      description: Weaviate Cancel An Export
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: weaviate-export.exportcancel
      with:
        backend: tools.backend
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.