Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stream-api Compare.json?streams={content}&target={number}&pr…

2 actions 2 updates phrasing extends openapi/khoros-ai-compare-json-streams-content-target-number-precision-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['/compare.json?streams={content}&target={number}&precision'].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 stream-api Compare.json?streams={content}&target={number}&pr…
  version: 1.0.0
extends: openapi/khoros-ai-compare-json-streams-content-target-number-precision-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['/compare.json?streams={content}&target={number}&precision'].get
  update:
    x-apievangelist-phrasing:
      intent: Set decimals on target-progress percentages
      effect: read
      questions:
      - How many decimal places can a stream target percentage have?
      - Can I round the percent-toward-target result for compared streams?
      instructions:
      - text: Compare streams {content} against target {number} with {precision} decimal places.
        slots:
          content: path.content
          number: path.number
          precision: query.precision
      - text: Return progress of {content} toward {number} rounded to {precision} decimals.
        slots:
          content: path.content
          number: path.number
          precision: query.precision
      method: generated
      generated: '2026-10-01'