Coveo Schema Service API — Salesforce Trial

naftiko: 1.0.0-alpha2
info:
  label: Coveo Schema Service API — Salesforce Trial
  description: 'Coveo Schema Service API — Salesforce Trial. 2 operations. Lead operation: Retrieves the License Status for
    an Organization. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Schema Service
  - Salesforce Trial
  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-trial
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Schema Service API — Salesforce Trial business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-salesforce-trial-licenseStatus
      path: /rest/organizations/{organizationId}/salesforce/trial/licenseStatus
      operations:
      - name: getlicensestatus
        method: GET
        description: Retrieves the License Status for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
    - name: rest-organizations-organizationId-salesforce-trial-provisioningStatus
      path: /rest/organizations/{organizationId}/salesforce/trial/provisioningStatus
      operations:
      - name: getprovisioningstatus
        method: GET
        description: Retrieves the Provisioning Status for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: salesforceOrganizationId
          in: query
          type: string
          description: The ID of the Salesforce organization.
          required: true
        - name: organizationId
          in: path
          type: string
          description: The organization ID
          required: true
  exposes:
  - type: rest
    namespace: schema-service-salesforce-trial-rest
    port: 8080
    description: REST adapter for Coveo Schema Service API — Salesforce Trial. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/salesforce/trial/licensestatus
      name: rest-organizations-organizationid-salesforce-trial-licensestatus
      description: REST surface for rest-organizations-organizationId-salesforce-trial-licenseStatus.
      operations:
      - method: GET
        name: getlicensestatus
        description: Retrieves the License Status for an Organization
        call: schema-service-salesforce-trial.getlicensestatus
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/salesforce/trial/provisioningstatus
      name: rest-organizations-organizationid-salesforce-trial-provisioningstatus
      description: REST surface for rest-organizations-organizationId-salesforce-trial-provisioningStatus.
      operations:
      - method: GET
        name: getprovisioningstatus
        description: Retrieves the Provisioning Status for an Organization
        call: schema-service-salesforce-trial.getprovisioningstatus
        with:
          salesforceOrganizationId: rest.salesforceOrganizationId
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: schema-service-salesforce-trial-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Schema Service API — Salesforce Trial. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-license-status-organization
      description: Retrieves the License Status for an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schema-service-salesforce-trial.getlicensestatus
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-provisioning-status-organization
      description: Retrieves the Provisioning Status for an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schema-service-salesforce-trial.getprovisioningstatus
      with:
        salesforceOrganizationId: tools.salesforceOrganizationId
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.