Coveo Search API — Statement groups

naftiko: 1.0.0-alpha2
info:
  label: Coveo Search API — Statement groups
  description: 'Coveo Search API — Statement groups. 12 operations. Lead operation: Returns the List of All Pipeline Features
    and Whether They''re Active or Not.. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Search
  - Statement groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: search-statement-groups
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Search API — Statement groups business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-search-admin-pipelines-featureActiveState
      path: /rest/search/admin/pipelines/featureActiveState
      operations:
      - name: getfeatureactivestate
        method: GET
        description: Returns the List of All Pipeline Features and Whether They're Active or Not.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups
      operations:
      - name: liststatementgroups
        method: GET
        description: List Statement Groups of a Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createstatementgroup
        method: POST
        description: Create a New Statement Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-associations-dissociat
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/associations/dissociate
      operations:
      - name: statementgroupsassociationsdissociate
        method: POST
        description: Dissociate Pipeline Rules Associated to Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-bulkGet
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/bulkGet
      operations:
      - name: bulkgetstatementgroupsoperation
        method: POST
        description: List Statement Groups of a Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-validate
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate
      operations:
      - name: validatestatementgroupoperation
        method: POST
        description: Validate a Single Statement Group Operation.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-validate-batch
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/validate/batch
      operations:
      - name: validatestatementgroupsoperations
        method: POST
        description: Validate a Batch of Statement Groups Operations.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-statementGroupId
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}
      operations:
      - name: getastatementgroupofapipeline
        method: GET
        description: Get a Statement Group of a Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteastatementgroupofapipeline
        method: DELETE
        description: Delete a Statement Group of a Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateastatementgroup
        method: PUT
        description: Update a Statement Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: toggleapermanentgroup
        method: PATCH
        description: Toggle a Permanent Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-search-v2-admin-pipelines-pipelineId-statementGroups-statementGroupId-assoc
      path: /rest/search/v2/admin/pipelines/{pipelineId}/statementGroups/{statementGroupId}/associations
      operations:
      - name: updatestatementgroupsassociations
        method: PUT
        description: Update the Rules Associated with a Statement Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: search-statement-groups-rest
    port: 8080
    description: REST adapter for Coveo Search API — Statement groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/search/admin/pipelines/featureactivestate
      name: rest-search-admin-pipelines-featureactivestate
      description: REST surface for rest-search-admin-pipelines-featureActiveState.
      operations:
      - method: GET
        name: getfeatureactivestate
        description: Returns the List of All Pipeline Features and Whether They're Active or Not.
        call: search-statement-groups.getfeatureactivestate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups.
      operations:
      - method: GET
        name: liststatementgroups
        description: List Statement Groups of a Pipeline
        call: search-statement-groups.liststatementgroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createstatementgroup
        description: Create a New Statement Group
        call: search-statement-groups.createstatementgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/associations/dissociate
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-associations-dissociat
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-associations-dissociat.
      operations:
      - method: POST
        name: statementgroupsassociationsdissociate
        description: Dissociate Pipeline Rules Associated to Groups
        call: search-statement-groups.statementgroupsassociationsdissociate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/bulkget
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-bulkget
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-bulkGet.
      operations:
      - method: POST
        name: bulkgetstatementgroupsoperation
        description: List Statement Groups of a Pipeline
        call: search-statement-groups.bulkgetstatementgroupsoperation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/validate
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-validate
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-validate.
      operations:
      - method: POST
        name: validatestatementgroupoperation
        description: Validate a Single Statement Group Operation.
        call: search-statement-groups.validatestatementgroupoperation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/validate/batch
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-validate-batch
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-validate-batch.
      operations:
      - method: POST
        name: validatestatementgroupsoperations
        description: Validate a Batch of Statement Groups Operations.
        call: search-statement-groups.validatestatementgroupsoperations
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/{statementgroupid}
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-statementgroupid
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-statementGroupId.
      operations:
      - method: GET
        name: getastatementgroupofapipeline
        description: Get a Statement Group of a Pipeline
        call: search-statement-groups.getastatementgroupofapipeline
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteastatementgroupofapipeline
        description: Delete a Statement Group of a Pipeline
        call: search-statement-groups.deleteastatementgroupofapipeline
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateastatementgroup
        description: Update a Statement Group
        call: search-statement-groups.updateastatementgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: toggleapermanentgroup
        description: Toggle a Permanent Group
        call: search-statement-groups.toggleapermanentgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/v2/admin/pipelines/{pipelineid}/statementgroups/{statementgroupid}/associations
      name: rest-search-v2-admin-pipelines-pipelineid-statementgroups-statementgroupid-assoc
      description: REST surface for rest-search-v2-admin-pipelines-pipelineId-statementGroups-statementGroupId-assoc.
      operations:
      - method: PUT
        name: updatestatementgroupsassociations
        description: Update the Rules Associated with a Statement Group
        call: search-statement-groups.updatestatementgroupsassociations
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-statement-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Search API — Statement groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: returns-list-all-pipeline-features
      description: Returns the List of All Pipeline Features and Whether They're Active or Not.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-statement-groups.getfeatureactivestate
      outputParameters:
      - type: object
        mapping: $.
    - name: list-statement-groups-pipeline
      description: List Statement Groups of a Pipeline
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-statement-groups.liststatementgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-statement-group
      description: Create a New Statement Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-statement-groups.createstatementgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dissociate-pipeline-rules-associated-groups
      description: Dissociate Pipeline Rules Associated to Groups
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-statement-groups.statementgroupsassociationsdissociate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-statement-groups-pipeline-2
      description: List Statement Groups of a Pipeline
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-statement-groups.bulkgetstatementgroupsoperation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-single-statement-group-operation
      description: Validate a Single Statement Group Operation.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-statement-groups.validatestatementgroupoperation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-batch-statement-groups-operations
      description: Validate a Batch of Statement Groups Operations.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: search-statement-groups.validatestatementgroupsoperations
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-statement-group-pipeline
      description: Get a Statement Group of a Pipeline
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-statement-groups.getastatementgroupofapipeline
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-statement-group-pipeline
      description: Delete a Statement Group of a Pipeline
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-statement-groups.deleteastatementgroupofapipeline
      outputParameters:
      - type: object
        mapping: $.
    - name: update-statement-group
      description: Update a Statement Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-statement-groups.updateastatementgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: toggle-permanent-group
      description: Toggle a Permanent Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-statement-groups.toggleapermanentgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-rules-associated-statement-group
      description: Update the Rules Associated with a Statement Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-statement-groups.updatestatementgroupsassociations
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.