# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ControlUp for Desktops Surveys API
  version: 1.0.0
extends: openapi/controlup-surveys-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/user-sentiment/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List user sentiment surveys
      effect: read
      questions:
      - What user sentiment surveys have we run?
      - Can I filter my survey list with an OpenSearch query?
      instructions:
      - text: List all surveys.
      - text: Find surveys matching {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new survey
      effect: write
      questions:
      - Can I publish a new user sentiment survey through the API?
      - How do I send out a new survey to users?
      instructions:
      - text: Publish a new user sentiment survey.
      - text: Create and launch a new survey.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a survey
      effect: read
      questions:
      - What are the details of a specific survey?
      - Can I look up one survey by its ID?
      instructions:
      - text: Show survey {id}.
        slots:
          id: path.id
      - text: Get the details of survey {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a survey
      effect: destructive
      questions:
      - Can I delete a survey I no longer need?
      - Is there a way to remove a survey entirely?
      instructions:
      - text: Delete survey {id}.
        slots:
          id: path.id
      - text: Remove survey {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a survey
      effect: write
      questions:
      - Can I temporarily pause a running survey?
      - Is it possible to stop a survey for now and resume later?
      instructions:
      - text: Pause survey {id}.
        slots:
          id: path.id
      - text: Temporarily halt survey {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused survey
      effect: write
      questions:
      - Can I restart a survey that I paused?
      - Which call brings a paused survey back live?
      instructions:
      - text: Resume survey {id}.
        slots:
          id: path.id
      - text: Unpause survey {id} so users see it again.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/surveys/{id}/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a survey
      effect: destructive
      questions:
      - Can I close out a survey and mark it complete?
      - Is there a way to end a survey for good once I have enough responses?
      instructions:
      - text: Complete survey {id}.
        slots:
          id: path.id
      - text: Mark survey {id} as finished.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get survey open, start and completion events
      effect: read
      questions:
      - How many users opened, started or completed a survey?
      - Can I include the answers alongside survey completion events?
      instructions:
      - text: Get survey results.
      - text: 'Get survey results with answers included: {include_answers}.'
        slots:
          include_answers: query.include_answers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user-sentiment/results/answers/raw'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw survey answers per user
      effect: read
      questions:
      - What did each user answer on each survey question?
      - Can I export every survey answer per user per device?
      instructions:
      - text: Get all raw survey answers.
      - text: Get raw survey answers matching {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'