Coveo Connectivity API — Crawling Module

naftiko: 1.0.0-alpha2
info:
  label: Coveo Connectivity API — Crawling Module
  description: 'Coveo Connectivity API — Crawling Module. 6 operations. Lead operation: Crawling Module. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Connectivity
  - Crawling Module
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: connectivity-crawling-module
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Connectivity API — Crawling Module business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests
      path: /rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests
      operations:
      - name: getcrawlingmodulelogrequests
        method: GET
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: state
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
      - name: createcrawlingmodulelogrequest
        method: POST
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c
      path: /rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/download
      operations:
      - name: getcrawlingmodulelogrequestdownload
        method: GET
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: crawlingModuleLogRequestId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c
      path: /rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/state
      operations:
      - name: updatecrawlingmodulelogrequeststate
        method: PUT
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: crawlingModuleLogRequestId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c
      path: /rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/uploadurl
      operations:
      - name: getcrawlingmodulelogrequestuploadurl
        method: GET
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: crawlingModuleLogRequestId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-crawlingmodules-crawlingModuleId-reporting
      path: /rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/reporting
      operations:
      - name: createcrawlingmodulereport
        method: POST
        description: <details><summary>Privilege required</summary>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: crawlingModuleId
          in: path
          type: string
          required: true
        - name: destination
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: connectivity-crawling-module-rest
    port: 8080
    description: REST adapter for Coveo Connectivity API — Crawling Module. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/crawlingmodules/{crawlingmoduleid}/logrequests
      name: rest-organizations-organizationid-crawlingmodules-crawlingmoduleid-logrequests
      description: REST surface for rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests.
      operations:
      - method: GET
        name: getcrawlingmodulelogrequests
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.getcrawlingmodulelogrequests
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          state: rest.state
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcrawlingmodulelogrequest
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.createcrawlingmodulelogrequest
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/crawlingmodules/{crawlingmoduleid}/logrequests/{crawlingmodulelogrequestid}/download
      name: rest-organizations-organizationid-crawlingmodules-crawlingmoduleid-logrequests-c
      description: REST surface for rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c.
      operations:
      - method: GET
        name: getcrawlingmodulelogrequestdownload
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.getcrawlingmodulelogrequestdownload
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          crawlingModuleLogRequestId: rest.crawlingModuleLogRequestId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/crawlingmodules/{crawlingmoduleid}/logrequests/{crawlingmodulelogrequestid}/state
      name: rest-organizations-organizationid-crawlingmodules-crawlingmoduleid-logrequests-c
      description: REST surface for rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c.
      operations:
      - method: PUT
        name: updatecrawlingmodulelogrequeststate
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.updatecrawlingmodulelogrequeststate
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          crawlingModuleLogRequestId: rest.crawlingModuleLogRequestId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/crawlingmodules/{crawlingmoduleid}/logrequests/{crawlingmodulelogrequestid}/uploadurl
      name: rest-organizations-organizationid-crawlingmodules-crawlingmoduleid-logrequests-c
      description: REST surface for rest-organizations-organizationId-crawlingmodules-crawlingModuleId-logrequests-c.
      operations:
      - method: GET
        name: getcrawlingmodulelogrequestuploadurl
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.getcrawlingmodulelogrequestuploadurl
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          crawlingModuleLogRequestId: rest.crawlingModuleLogRequestId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/crawlingmodules/{crawlingmoduleid}/reporting
      name: rest-organizations-organizationid-crawlingmodules-crawlingmoduleid-reporting
      description: REST surface for rest-organizations-organizationId-crawlingmodules-crawlingModuleId-reporting.
      operations:
      - method: POST
        name: createcrawlingmodulereport
        description: <details><summary>Privilege required</summary>
        call: connectivity-crawling-module.createcrawlingmodulereport
        with:
          organizationId: rest.organizationId
          crawlingModuleId: rest.crawlingModuleId
          destination: rest.destination
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: connectivity-crawling-module-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Connectivity API — Crawling Module. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: details-summary-privilege-required-summary
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: connectivity-crawling-module.getcrawlingmodulelogrequests
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        state: tools.state
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-2
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: connectivity-crawling-module.createcrawlingmodulelogrequest
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-3
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: connectivity-crawling-module.getcrawlingmodulelogrequestdownload
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        crawlingModuleLogRequestId: tools.crawlingModuleLogRequestId
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-4
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: connectivity-crawling-module.updatecrawlingmodulelogrequeststate
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        crawlingModuleLogRequestId: tools.crawlingModuleLogRequestId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-5
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: connectivity-crawling-module.getcrawlingmodulelogrequestuploadurl
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        crawlingModuleLogRequestId: tools.crawlingModuleLogRequestId
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-6
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: connectivity-crawling-module.createcrawlingmodulereport
      with:
        organizationId: tools.organizationId
        crawlingModuleId: tools.crawlingModuleId
        destination: tools.destination
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.