Coveo Schema Service API — Salesforce Organizations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Schema Service API — Salesforce Organizations
  description: 'Coveo Schema Service API — Salesforce Organizations. 3 operations. Lead operation: Flushes the Cached Data
    for a Salesforce Organization. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Schema Service
  - Salesforce Organizations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: schema-service-salesforce-organizations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Schema Service API — Salesforce Organizations business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-salesforce-schema
      path: /rest/salesforce/schema/
      operations:
      - name: flushcache
        method: DELETE
        description: Flushes the Cached Data for a Salesforce Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceUri
          in: query
          type: string
          description: The instance URI of the Salesforce organization
          required: true
        - name: sessionId
          in: query
          type: string
          description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
          required: true
        - name: version
          in: query
          type: string
          description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        - name: presets
          in: query
          type: string
          description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        - name: X-Salesforce-Session-ID
          in: header
          type: string
          description: The Salesforce session ID to use
          required: true
    - name: rest-salesforce-schema-objects
      path: /rest/salesforce/schema/objects
      operations:
      - name: loadobjects
        method: POST
        description: Loads the Object Data for a List of Salesforce Objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
        - name: instanceUri
          in: query
          type: string
          description: The instance URI of the Salesforce organization
          required: true
        - name: sessionId
          in: query
          type: string
          description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
          required: true
        - name: version
          in: query
          type: string
          description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        - name: presets
          in: query
          type: string
          description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        - name: X-Salesforce-Session-ID
          in: header
          type: string
          description: The Salesforce session ID to use
          required: true
    - name: rest-salesforce-schema-organization
      path: /rest/salesforce/schema/organization
      operations:
      - name: loadorganization
        method: GET
        description: Loads the Organization Data for a Salesforce Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceUri
          in: query
          type: string
          description: The instance URI of the Salesforce organization
          required: true
        - name: sessionId
          in: query
          type: string
          description: Deprecated, use the appropriate 'X-Salesforce-Session-ID' header instead
          required: true
        - name: version
          in: query
          type: string
          description: 'The schema version to use. Allowed values: ["0" (CloudV1), "1" (Legacy), "2" (Current)]'
        - name: presets
          in: query
          type: string
          description: 'The schema presets to apply. Allowed values: ["servicecloud", "knowledge", "content", "chatter"]'
        - name: X-Salesforce-Session-ID
          in: header
          type: string
          description: The Salesforce session ID to use
          required: true
  exposes:
  - type: rest
    namespace: schema-service-salesforce-organizations-rest
    port: 8080
    description: REST adapter for Coveo Schema Service API — Salesforce Organizations. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/salesforce/schema
      name: rest-salesforce-schema
      description: REST surface for rest-salesforce-schema.
      operations:
      - method: DELETE
        name: flushcache
        description: Flushes the Cached Data for a Salesforce Organization
        call: schema-service-salesforce-organizations.flushcache
        with:
          instanceUri: rest.instanceUri
          sessionId: rest.sessionId
          version: rest.version
          presets: rest.presets
          X-Salesforce-Session-ID: rest.X-Salesforce-Session-ID
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/salesforce/schema/objects
      name: rest-salesforce-schema-objects
      description: REST surface for rest-salesforce-schema-objects.
      operations:
      - method: POST
        name: loadobjects
        description: Loads the Object Data for a List of Salesforce Objects.
        call: schema-service-salesforce-organizations.loadobjects
        with:
          body: rest.body
          instanceUri: rest.instanceUri
          sessionId: rest.sessionId
          version: rest.version
          presets: rest.presets
          X-Salesforce-Session-ID: rest.X-Salesforce-Session-ID
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/salesforce/schema/organization
      name: rest-salesforce-schema-organization
      description: REST surface for rest-salesforce-schema-organization.
      operations:
      - method: GET
        name: loadorganization
        description: Loads the Organization Data for a Salesforce Organization.
        call: schema-service-salesforce-organizations.loadorganization
        with:
          instanceUri: rest.instanceUri
          sessionId: rest.sessionId
          version: rest.version
          presets: rest.presets
          X-Salesforce-Session-ID: rest.X-Salesforce-Session-ID
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: schema-service-salesforce-organizations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Schema Service API — Salesforce Organizations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: flushes-cached-data-salesforce-organization
      description: Flushes the Cached Data for a Salesforce Organization
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: schema-service-salesforce-organizations.flushcache
      with:
        instanceUri: tools.instanceUri
        sessionId: tools.sessionId
        version: tools.version
        presets: tools.presets
        X-Salesforce-Session-ID: tools.X-Salesforce-Session-ID
      outputParameters:
      - type: object
        mapping: $.
    - name: loads-object-data-list-salesforce
      description: Loads the Object Data for a List of Salesforce Objects.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: schema-service-salesforce-organizations.loadobjects
      with:
        body: tools.body
        instanceUri: tools.instanceUri
        sessionId: tools.sessionId
        version: tools.version
        presets: tools.presets
        X-Salesforce-Session-ID: tools.X-Salesforce-Session-ID
      outputParameters:
      - type: object
        mapping: $.
    - name: loads-organization-data-salesforce-organization
      description: Loads the Organization Data for a Salesforce Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schema-service-salesforce-organizations.loadorganization
      with:
        instanceUri: tools.instanceUri
        sessionId: tools.sessionId
        version: tools.version
        presets: tools.presets
        X-Salesforce-Session-ID: tools.X-Salesforce-Session-ID
      outputParameters:
      - type: object
        mapping: $.