Mockaroo API — Downloads

naftiko: "1.0.0-alpha2"

info:
  label: "Mockaroo API — Downloads"
  description: >-
    Downloads — track and manage long-running background generation jobs
    triggered with background=true. 2 operations. Lead operation: Get
    Background Download Status. Self-contained Naftiko capability covering one
    Mockaroo business surface.
  tags:
    - Mockaroo
    - Test Data
    - Downloads
  created: "2026-05-30"
  modified: "2026-05-30"

binds:
  - namespace: env
    keys:
      MOCKAROO_API_KEY: MOCKAROO_API_KEY

capability:

  consumes:
    - type: http
      namespace: "mockaroo-downloads"
      baseUri: "https://api.mockaroo.com"
      description: "Mockaroo background download job tracking. Self-contained, no shared references."
      authentication:
        type: apikey
        key: X-API-Key
        value: "{{env.MOCKAROO_API_KEY}}"
        placement: header
      resources:
        - name: "downloads"
          path: "/api/downloads/{id}"
          operations:
            - name: "getDownload"
              method: GET
              description: "Get the status of a background download job."
              inputParameters:
                - name: id
                  in: path
                  type: string
                  required: true
                  description: "Background download job identifier."
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: "$."
            - name: "cancelDownload"
              method: DELETE
              description: "Cancel a background download job."
              inputParameters:
                - name: id
                  in: path
                  type: string
                  required: true
                  description: "Background download job identifier."
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: "$."

  exposes:
    - type: rest
      namespace: "mockaroo-downloads-rest"
      port: 8080
      description: "REST adapter for Mockaroo Downloads. One Spectral-compliant resource per consumed operation, prefixed with /v1."
      resources:
        - path: "/v1/downloads/{id}"
          name: "downloads"
          description: "REST surface for background download job management."
          operations:
            - method: GET
              name: "getDownload"
              description: "Get the status of a background download job."
              call: "mockaroo-downloads.getDownload"
              with:
                id: "rest.id"
              outputParameters:
                - type: object
                  mapping: "$."
            - method: DELETE
              name: "cancelDownload"
              description: "Cancel a background download job."
              call: "mockaroo-downloads.cancelDownload"
              with:
                id: "rest.id"
              outputParameters:
                - type: object
                  mapping: "$."

    - type: mcp
      namespace: "mockaroo-downloads-mcp"
      port: 9090
      transport: http
      description: "MCP adapter for Mockaroo Downloads. One tool per consumed operation, routed inline through this capability's consumes block."
      tools:
        - name: "get-download-status"
          description: "Get the status of a background download job."
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: "mockaroo-downloads.getDownload"
          with:
            id: "tools.id"
          outputParameters:
            - type: object
              mapping: "$."
        - name: "cancel-download"
          description: "Cancel a background download job."
          hints:
            readOnly: false
            destructive: true
            idempotent: true
          call: "mockaroo-downloads.cancelDownload"
          with:
            id: "tools.id"
          outputParameters:
            - type: object
              mapping: "$."