naftiko: 1.0.0-alpha2
info:
label: Coveo Catalog Management API — View Definitions
description: 'Coveo Catalog Management API — View Definitions. 2 operations. Lead operation: Get View Definitions for a
Catalog. Self-contained Naftiko capability covering one Coveo business surface.'
tags:
- Coveo
- Catalog Management
- View Definitions
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
COVEO_API_KEY: COVEO_API_KEY
capability:
consumes:
- type: http
namespace: catalog-management-view-definitions
baseUri: https://platform.cloud.coveo.com
description: Coveo Catalog Management API — View Definitions business capability. Self-contained, no shared references.
authentication:
type: bearer
token: '{{env.COVEO_API_KEY}}'
resources:
- name: api-preview-organizations-organizationId-catalog-management-catalogs-catalogId-v
path: /api/preview/organizations/{organizationId}/catalog-management/catalogs/{catalogId}/view-definitions
operations:
- name: getviewdefinitions
method: GET
description: Get View Definitions for a Catalog
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organizationId
in: path
type: string
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:**
`acmecorporation8tp8wu3`
required: true
- name: catalogId
in: path
type: string
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
- name: putviewdefinitions
method: PUT
description: Update View Definitions for a Catalog
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: organizationId
in: path
type: string
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:**
`acmecorporation8tp8wu3`
required: true
- name: catalogId
in: path
type: string
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
exposes:
- type: rest
namespace: catalog-management-view-definitions-rest
port: 8080
description: REST adapter for Coveo Catalog Management API — View Definitions. One Spectral-compliant resource per consumed
operation, prefixed with /v1.
resources:
- path: /v1/organizations/{organizationid}/catalog-management/catalogs/{catalogid}/view-definitions
name: api-preview-organizations-organizationid-catalog-management-catalogs-catalogid-v
description: REST surface for api-preview-organizations-organizationId-catalog-management-catalogs-catalogId-v.
operations:
- method: GET
name: getviewdefinitions
description: Get View Definitions for a Catalog
call: catalog-management-view-definitions.getviewdefinitions
with:
organizationId: rest.organizationId
catalogId: rest.catalogId
outputParameters:
- type: object
mapping: $.
- method: PUT
name: putviewdefinitions
description: Update View Definitions for a Catalog
call: catalog-management-view-definitions.putviewdefinitions
with:
organizationId: rest.organizationId
catalogId: rest.catalogId
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: catalog-management-view-definitions-mcp
port: 9090
transport: http
description: MCP adapter for Coveo Catalog Management API — View Definitions. One tool per consumed operation, routed
inline through this capability's consumes block.
tools:
- name: get-view-definitions-catalog
description: Get View Definitions for a Catalog
hints:
readOnly: true
destructive: false
idempotent: true
call: catalog-management-view-definitions.getviewdefinitions
with:
organizationId: tools.organizationId
catalogId: tools.catalogId
outputParameters:
- type: object
mapping: $.
- name: update-view-definitions-catalog
description: Update View Definitions for a Catalog
hints:
readOnly: false
destructive: false
idempotent: true
call: catalog-management-view-definitions.putviewdefinitions
with:
organizationId: tools.organizationId
catalogId: tools.catalogId
body: tools.body
outputParameters:
- type: object
mapping: $.