# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BlueConic REST API v2 Objectives API
  version: 1.0.0
extends: openapi/blueconic-objectives-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: 2
- target: $.paths['/objectives'].get
  update:
    x-apievangelist-phrasing:
      intent: List all objectives
      effect: read
      questions:
      - Which consent objectives are defined in BlueConic?
      - Can I page through the objectives?
      instructions:
      - text: List all objectives.
      - text: Show {count} objectives starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objectives/{objective}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single objective
      effect: read
      questions:
      - What does one particular objective cover?
      - Can I retrieve an objective's details by ID?
      instructions:
      - text: Get objective {objective}.
        slots:
          objective: path.objective
      - text: Show me the details of objective {objective}.
        slots:
          objective: path.objective
      method: generated
      generated: '2026-10-01'