Coveo Security Cache API — Security Providers Schedules

naftiko: 1.0.0-alpha2
info:
  label: Coveo Security Cache API — Security Providers Schedules
  description: 'Coveo Security Cache API — Security Providers Schedules. 2 operations. Lead operation: Get Security Provider
    Schedules. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Security Cache
  - Security Providers Schedules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: security-cache-security-providers-schedules
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Security Cache API — Security Providers Schedules business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-securityproviders-securityProviderId-schedules
      path: /rest/organizations/{organizationId}/securityproviders/{securityProviderId}/schedules
      operations:
      - name: getschedules
        method: GET
        description: Get Security Provider Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: securityProviderId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-securityproviders-securityProviderId-schedules
      path: /rest/organizations/{organizationId}/securityproviders/{securityProviderId}/schedules/{scheduleId}
      operations:
      - name: updateschedule
        method: PUT
        description: Update a Security Provider Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: securityProviderId
          in: path
          type: string
          required: true
        - name: scheduleId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: security-cache-security-providers-schedules-rest
    port: 8080
    description: REST adapter for Coveo Security Cache API — Security Providers Schedules. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/securityproviders/{securityproviderid}/schedules
      name: rest-organizations-organizationid-securityproviders-securityproviderid-schedules
      description: REST surface for rest-organizations-organizationId-securityproviders-securityProviderId-schedules.
      operations:
      - method: GET
        name: getschedules
        description: Get Security Provider Schedules
        call: security-cache-security-providers-schedules.getschedules
        with:
          organizationId: rest.organizationId
          securityProviderId: rest.securityProviderId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/securityproviders/{securityproviderid}/schedules/{scheduleid}
      name: rest-organizations-organizationid-securityproviders-securityproviderid-schedules
      description: REST surface for rest-organizations-organizationId-securityproviders-securityProviderId-schedules.
      operations:
      - method: PUT
        name: updateschedule
        description: Update a Security Provider Schedule
        call: security-cache-security-providers-schedules.updateschedule
        with:
          organizationId: rest.organizationId
          securityProviderId: rest.securityProviderId
          scheduleId: rest.scheduleId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: security-cache-security-providers-schedules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Security Cache API — Security Providers Schedules. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-security-provider-schedules
      description: Get Security Provider Schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: security-cache-security-providers-schedules.getschedules
      with:
        organizationId: tools.organizationId
        securityProviderId: tools.securityProviderId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-security-provider-schedule
      description: Update a Security Provider Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: security-cache-security-providers-schedules.updateschedule
      with:
        organizationId: tools.organizationId
        securityProviderId: tools.securityProviderId
        scheduleId: tools.scheduleId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.