API Evangelist conversational phrasing for Qliksense Evaluation API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Qliksense Evaluation API
  version: 1.0.0
extends: openapi/qliksense-evaluation-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: 12
- target: $.paths['/api/analytics/apps/{guid}/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's performance evaluations
      effect: read
      questions:
      - Which performance evaluations have been run on my Qlik Sense app over time?
      - Can I get an app's evaluation history as XML with full details included?
      instructions:
      - text: List the historical performance evaluations for app {guid}.
        slots:
          guid: path.guid
      - text: Show {limit} evaluations per page for app {guid} with full details set to {all}.
        slots:
          limit: query.limit
          guid: path.guid
          all: query.all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/analytics/apps/{guid}/evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a performance evaluation for an app
      effect: write
      questions:
      - How do I measure an app's object response times, CPU usage and data model size?
      - Can I override the engine size used when an app evaluation runs?
      instructions:
      - text: Queue a performance and scalability evaluation of app {guid}.
        slots:
          guid: path.guid
      - text: Evaluate app {guid} assuming an engine size of {engineSizeHint} GiB.
        slots:
          guid: path.guid
          engineSizeHint: requestBody.engineSizeHint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare two app evaluations for regressions
      effect: read
      questions:
      - Did my app get slower after the last change, comparing a baseline evaluation to a new one?
      - Can a comparison of two app evaluations include the non-significant differences too?
      instructions:
      - text: Compare baseline evaluation {baselineId} against evaluation {comparisonId}.
        slots:
          baselineId: path.baselineId
          comparisonId: path.comparisonId
      - text: Show every difference between evaluations {baselineId} and {comparisonId}, with all entries set to {all}.
        slots:
          baselineId: path.baselineId
          comparisonId: path.comparisonId
          all: query.all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/analytics/apps/evaluations/{baselineId}/compare/{comparisonId}/actions/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a comparison log of two evaluations
      effect: read
      questions:
      - Where can I download the comparison log between a baseline and a new app evaluation as a file?
      - Is the downloadable evaluation comparison log XML by default, or can I get JSON?
      instructions:
      - text: Download the comparison log for evaluations {baselineId} and {comparisonId}.
        slots:
          baselineId: path.baselineId
          comparisonId: path.comparisonId
      - text: Save the {baselineId} versus {comparisonId} comparison log as {Accept}.
        slots:
          baselineId: path.baselineId
          comparisonId: path.comparisonId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/analytics/apps/evaluations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one app evaluation's results
      effect: read
      questions:
      - What were the results of one specific app evaluation?
      - Can I fetch a single evaluation with its full details in JSON?
      instructions:
      - text: Show the results of app evaluation {id}.
        slots:
          id: path.id
      - text: Get evaluation {id} in {format} format with full details set to {all}.
        slots:
          id: path.id
          format: query.format
          all: query.all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/analytics/apps/evaluations/{id}/actions/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an app evaluation log
      effect: read
      questions:
      - How do I download the log file for a single app evaluation?
      - Can I get an evaluation log file in JSON rather than the default XML?
      instructions:
      - text: Download the log of app evaluation {id}.
        slots:
          id: path.id
      - text: Save the evaluation {id} log file as {Accept}.
        slots:
          id: path.id
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/{guid}/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List app evaluations via the older v1 endpoint
      effect: read
      questions:
      - How do I list an app's evaluations with the legacy /api/v1/apps endpoint?
      - Does the older v1 evaluation list page with next and prev evaluation ids?
      instructions:
      - text: Using the legacy v1 API, list all evaluations for app {guid}.
        slots:
          guid: path.guid
      - text: Through the v1 endpoint, list app {guid} evaluations sorted by {sort}.
        slots:
          guid: path.guid
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/{guid}/evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an app evaluation via the older v1 endpoint
      effect: write
      questions:
      - Can I still queue an app evaluation through the legacy v1 apps endpoint?
      - What does the older v1 queue-evaluation call need besides the app GUID?
      instructions:
      - text: Using the legacy v1 API, queue an evaluation for app {guid}.
        slots:
          guid: path.guid
      - text: Start a v1 evaluation run on app {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare two evaluations via the older v1 endpoint
      effect: read
      questions:
      - How do I compare two evaluations with the legacy v1 compare action?
      - Can the older v1 comparison return non-significant differences as well?
      instructions:
      - text: Using the legacy v1 API, compare evaluation {baseid} with {comparisonid}.
        slots:
          baseid: path.baseid
          comparisonid: path.comparisonid
      - text: Run a v1 comparison of {baseid} and {comparisonid} in {format}.
        slots:
          baseid: path.baseid
          comparisonid: path.comparisonid
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/evaluations/{baseid}/actions/compare/{comparisonid}/actions/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a v1 XML comparison log
      effect: read
      questions:
      - Can I download an XML comparison log of two evaluations from the legacy v1 endpoint?
      - Where is the older v1 download for evaluation differences?
      instructions:
      - text: Using the legacy v1 API, download the XML comparison log for {baseid} and {comparisonid}.
        slots:
          baseid: path.baseid
          comparisonid: path.comparisonid
      - text: Get the v1 difference log file between evaluations {baseid} and {comparisonid}.
        slots:
          baseid: path.baseid
          comparisonid: path.comparisonid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/evaluations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one evaluation via the older v1 endpoint
      effect: read
      questions:
      - How do I retrieve a single evaluation from the legacy /api/v1/apps/evaluations endpoint?
      - Can the older v1 API return an evaluation's full data?
      instructions:
      - text: Using the legacy v1 API, get evaluation {id}.
        slots:
          id: path.id
      - text: Fetch v1 evaluation {id} with full data set to {all}.
        slots:
          id: path.id
          all: query.all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps/evaluations/{id}/actions/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an evaluation's XML log via v1
      effect: read
      questions:
      - Can I download a detailed XML log of one evaluation from the legacy v1 endpoint?
      - Where is the older v1 download for a single evaluation log?
      instructions:
      - text: Using the legacy v1 API, download the detailed XML log of evaluation {id}.
        slots:
          id: path.id
      - text: Save the v1 evaluation log for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'