Spin.AI SpinOne API — Entities

naftiko: 1.0.0-alpha2
info:
  label: Spin.AI SpinOne API — Entities
  description: 'Spin.AI SpinOne API — Entities. 3 operations. Lead operation: Get All Backup Entities. Self-contained Naftiko
    capability covering one Spin Ai business surface.'
  tags:
  - Spin Ai
  - Entities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SPIN_AI_API_KEY: SPIN_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: spin-ai-entities
    baseUri: https://apg-1.spin.ai
    description: Spin.AI SpinOne API — Entities business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-integration-backup-entities-all
      path: /api/v1/integration/backup/entities/all
      operations:
      - name: getallentities
        method: GET
        description: Get All Backup Entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: platform
          in: query
          type: string
          description: Filter entities by SaaS platform
    - name: api-v1-integration-backup-entities-filter
      path: /api/v1/integration/backup/entities/filter
      operations:
      - name: filterentities
        method: POST
        description: Filter Backup Entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-integration-backup-entity-status
      path: /api/v1/integration/backup/entity/status
      operations:
      - name: updateentitystatus
        method: POST
        description: Update Entity Backup Status
        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: Authorization
      value: '{{env.SPIN_AI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: spin-ai-entities-rest
    port: 8080
    description: REST adapter for Spin.AI SpinOne API — Entities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/integration/backup/entities/all
      name: api-v1-integration-backup-entities-all
      description: REST surface for api-v1-integration-backup-entities-all.
      operations:
      - method: GET
        name: getallentities
        description: Get All Backup Entities
        call: spin-ai-entities.getallentities
        with:
          platform: rest.platform
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/integration/backup/entities/filter
      name: api-v1-integration-backup-entities-filter
      description: REST surface for api-v1-integration-backup-entities-filter.
      operations:
      - method: POST
        name: filterentities
        description: Filter Backup Entities
        call: spin-ai-entities.filterentities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/integration/backup/entity/status
      name: api-v1-integration-backup-entity-status
      description: REST surface for api-v1-integration-backup-entity-status.
      operations:
      - method: POST
        name: updateentitystatus
        description: Update Entity Backup Status
        call: spin-ai-entities.updateentitystatus
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: spin-ai-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Spin.AI SpinOne API — Entities. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-all-backup-entities
      description: Get All Backup Entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spin-ai-entities.getallentities
      with:
        platform: tools.platform
      outputParameters:
      - type: object
        mapping: $.
    - name: filter-backup-entities
      description: Filter Backup Entities
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: spin-ai-entities.filterentities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-entity-backup-status
      description: Update Entity Backup Status
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: spin-ai-entities.updateentitystatus
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.