Coveo Platform API — License

naftiko: 1.0.0-alpha2
info:
  label: Coveo Platform API — License
  description: 'Coveo Platform API — License. 3 operations. Lead operation: Show Organization License. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Platform
  - License
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-license
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Platform API — License business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-license
      path: /rest/organizations/{organizationId}/license
      operations:
      - name: getlicense
        method: GET
        description: Show Organization License
        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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
    - name: rest-organizations-organizationId-license-entitlements
      path: /rest/organizations/{organizationId}/license/entitlements
      operations:
      - name: getentitlements
        method: GET
        description: Show Organization Entitlements
        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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
    - name: rest-organizations-organizationId-license-sectionName
      path: /rest/organizations/{organizationId}/license/{sectionName}
      operations:
      - name: getlicensesection
        method: GET
        description: Show Organization License Section
        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/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sectionName
          in: path
          type: string
          description: The name of the target license section.</br>**Example:** `content`
          required: true
  exposes:
  - type: rest
    namespace: platform-license-rest
    port: 8080
    description: REST adapter for Coveo Platform API — License. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/license
      name: rest-organizations-organizationid-license
      description: REST surface for rest-organizations-organizationId-license.
      operations:
      - method: GET
        name: getlicense
        description: Show Organization License
        call: platform-license.getlicense
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/license/entitlements
      name: rest-organizations-organizationid-license-entitlements
      description: REST surface for rest-organizations-organizationId-license-entitlements.
      operations:
      - method: GET
        name: getentitlements
        description: Show Organization Entitlements
        call: platform-license.getentitlements
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/license/{sectionname}
      name: rest-organizations-organizationid-license-sectionname
      description: REST surface for rest-organizations-organizationId-license-sectionName.
      operations:
      - method: GET
        name: getlicensesection
        description: Show Organization License Section
        call: platform-license.getlicensesection
        with:
          organizationId: rest.organizationId
          sectionName: rest.sectionName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-license-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Platform API — License. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: show-organization-license
      description: Show Organization License
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-license.getlicense
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: show-organization-entitlements
      description: Show Organization Entitlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-license.getentitlements
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: show-organization-license-section
      description: Show Organization License Section
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-license.getlicensesection
      with:
        organizationId: tools.organizationId
        sectionName: tools.sectionName
      outputParameters:
      - type: object
        mapping: $.