Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Plans API

2 actions 2 updates phrasing extends openapi/khoros-ai-plans-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Khoros's API. It is a proposal applied on top of the contract, not a document Khoros publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/{environment}/v1/company/{companyId}/initiative/{initiativeId}/plan'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Khoros Ai Plans API
  version: 1.0.0
extends: openapi/khoros-ai-plans-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/{environment}/v1/company/{companyId}/initiative/{initiativeId}/plan'].get
  update:
    x-apievangelist-phrasing:
      intent: List plans through the v1 company API
      effect: read
      questions:
      - What plans exist in an initiative using the v1 company path?
      - Can I filter v1 plans by name?
      instructions:
      - text: List plans in initiative {initiative} for company {company} on {env}.
        slots:
          env: path.environment
          company: path.companyId
          initiative: path.initiativeId
      - text: Find plans named {name} in initiative {initiative}, company {company}, {env}.
        slots:
          env: path.environment
          company: path.companyId
          initiative: path.initiativeId
          name: query.nameFilter
      method: generated
      generated: '2026-10-01'