API Evangelist conversational phrasing for Qliksense Apps 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 Apps API
  version: 1.0.0
extends: openapi/qliksense-apps-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: 34
- target: $.paths['/api/analytics/odag-apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List ODAG apps by type
      effect: read
      questions:
      - Which apps are set up as ODAG selection or template apps?
      - Can I list the apps that on-demand generation has created?
      instructions:
      - text: List ODAG apps of type {appType}.
        slots:
          appType: query.appType
      - text: Show all {appType} Analytics Applications used by ODAG.
        slots:
          appType: query.appType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Qlik Sense app
      effect: write
      questions:
      - Can I create a brand-new empty analytics app through the API?
      - What attributes can I set when I first create a Qlik Sense app?
      instructions:
      - text: Create a new app with attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Make a fresh empty Qlik Sense app called by the attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an app
      effect: read
      questions:
      - Where can I see the name, owner and attributes of one specific app?
      - Can I look up an app by its app ID?
      instructions:
      - text: Show me the details of app {appId}.
        slots:
          appId: path.appId
      - text: Fetch the app info record for {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an app's attributes
      effect: write
      questions:
      - Can I rename an existing app or change its description?
      - Which app attributes can be replaced after the app exists?
      instructions:
      - text: Update app {appId} with attributes {attributes}.
        slots:
          appId: path.appId
          attributes: requestBody.attributes
      - text: Rename or redescribe app {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app
      effect: destructive
      questions:
      - Can I permanently remove an analytics app I no longer need?
      - What happens when I delete a whole app?
      instructions:
      - text: Delete app {appId}.
        slots:
          appId: path.appId
      - text: Remove the entire app {appId} from the tenant.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate an app
      effect: write
      questions:
      - Can I make a copy of an existing app to experiment on?
      - Is it possible to give the duplicated app different attributes?
      instructions:
      - text: Copy app {appId}.
        slots:
          appId: path.appId
      - text: Duplicate app {appId} with new attributes {attributes}.
        slots:
          appId: path.appId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/data/lineage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data lineage of an app
      effect: read
      questions:
      - Which sources feed the data loaded into a given app?
      - Can I see the lineage strings describing where an app's data came from?
      instructions:
      - text: Show the data lineage for app {appId}.
        slots:
          appId: path.appId
      - text: List the sources that app {appId} loads its data from.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/data/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's data model metadata
      effect: read
      questions:
      - Where do I find the tables, fields and reload statistics of an app's data model?
      - What does the data model metadata return if the app has none?
      instructions:
      - text: Get the data model metadata for app {appId}.
        slots:
          appId: path.appId
      - text: Show table and field statistics from the last reload of app {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export an app
      effect: write
      questions:
      - Can I export an app as a file to move it elsewhere?
      - Is there a way to export an app without its data?
      instructions:
      - text: Export app {appId}.
        slots:
          appId: path.appId
      - text: Export app {appId} with NoData set to {NoData}.
        slots:
          appId: path.appId
          NoData: query.NoData
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/media/files/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a media file from an app
      effect: read
      questions:
      - Can I download an image stored in an app's media library?
      - What do I get back when I read a media file from an app?
      instructions:
      - text: Download media file {path} from app {appId}.
        slots:
          path: path.path
          appId: path.appId
      - text: Get the bytes of the image at {path} in app {appId}.
        slots:
          path: path.path
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/media/files/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a media file to an app
      effect: write
      questions:
      - Can I upload a logo or image into an app's media library?
      - Will storing a media file fail if a file already exists at that path?
      instructions:
      - text: Upload a media file to {path} in app {appId}.
        slots:
          path: path.path
          appId: path.appId
      - text: Store an image at media path {path} for app {appId}.
        slots:
          path: path.path
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/media/files/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media file or folder from an app
      effect: destructive
      questions:
      - Can I remove an image from an app's media library?
      - Is it possible to delete a whole media directory in one call?
      instructions:
      - text: Delete media file {path} from app {appId}.
        slots:
          path: path.path
          appId: path.appId
      - text: Remove the media directory {path} and everything in it from app {appId}.
        slots:
          path: path.path
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/media/list/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: List media files in an app
      effect: read
      questions:
      - Which images are stored in an app's media library?
      - Can I browse the contents of one media folder in an app?
      instructions:
      - text: List the media content under {path} in app {appId}.
        slots:
          path: path.path
          appId: path.appId
      - text: Browse media folder {path} of app {appId} showing {show}.
        slots:
          path: path.path
          appId: path.appId
          show: query.show
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/media/thumbnail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's thumbnail image
      effect: read
      questions:
      - Can I fetch the image currently used as an app's thumbnail?
      - Where do I get the cover picture shown for an app in the hub?
      instructions:
      - text: Get the thumbnail image of app {appId}.
        slots:
          appId: path.appId
      - text: Download the cover thumbnail for app {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/objects/{objectId}/actions/change-owner'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the owner of an app object
      effect: write
      questions:
      - Can I hand over a sheet or other object inside an app to another user?
      - Who is allowed to change the owner of an app object?
      instructions:
      - text: Make user {ownerId} the owner of object {objectId} in app {appId}.
        slots:
          ownerId: requestBody.ownerId
          objectId: path.objectId
          appId: path.appId
      - text: Transfer sheet {objectId} in app {appId} to a new owner.
        slots:
          objectId: path.objectId
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/owner'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the owner of an app
      effect: write
      questions:
      - Can I transfer ownership of a whole app to a colleague?
      - What do I need to reassign an app to another owner?
      instructions:
      - text: Change the owner of app {appId} to user {ownerId}.
        slots:
          appId: path.appId
          ownerId: requestBody.ownerId
      - text: Transfer the whole app {appId} to {ownerId}.
        slots:
          appId: path.appId
          ownerId: requestBody.ownerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/placement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's engine size override
      effect: read
      questions:
      - Does a given app have a minimum engine size override set?
      - Can I check which engine size an app is pinned to?
      instructions:
      - text: Show the engine size override for app {appId}.
        slots:
          appId: path.appId
      - text: Check the placement setting of app {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/placement'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an app's engine size override
      effect: write
      questions:
      - Can I force a large app onto a bigger engine size?
      - What value sets the minimum engine size for an app?
      instructions:
      - text: Set the minimum engine size of app {appId} to {minEngineSize}.
        slots:
          appId: path.appId
          minEngineSize: requestBody.minEngineSize
      - text: Pin app {appId} to engine size {minEngineSize}.
        slots:
          appId: path.appId
          minEngineSize: requestBody.minEngineSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/placement'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app's engine size override
      effect: destructive
      questions:
      - Can I clear the engine size override so an app uses the default placement?
      - What happens when I remove an app's size override?
      instructions:
      - text: Remove the engine size override from app {appId}.
        slots:
          appId: path.appId
      - text: Reset app {appId} to default engine placement.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Republish an app to a managed space
      effect: write
      questions:
      - Can I push updates from my app to its already-published copy in a managed space?
      - Is there a check that the target was originally published from this app?
      instructions:
      - text: Republish app {appId} over published app {targetId}.
        slots:
          appId: path.appId
          targetId: requestBody.targetId
      - text: Update published copy {targetId} from source app {appId} with data {data}.
        slots:
          targetId: requestBody.targetId
          appId: path.appId
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an app to a managed space
      effect: write
      questions:
      - Can I publish an app for the first time to a managed space?
      - Is it possible to move the app instead of copying it when publishing?
      instructions:
      - text: Publish app {appId} to managed space {spaceId}.
        slots:
          appId: path.appId
          spaceId: requestBody.spaceId
      - text: Publish app {appId} to space {spaceId}, moving it with moveApp {moveApp}.
        slots:
          appId: path.appId
          spaceId: requestBody.spaceId
          moveApp: requestBody.moveApp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/reloads/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's stored reload script logs
      effect: read
      questions:
      - Which reload script logs are stored for an app?
      - Can I see metadata about every script log kept for one app?
      instructions:
      - text: List the stored reload script logs for app {appId}.
        slots:
          appId: path.appId
      - text: Show me all script log entries kept for app {appId}.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/reloads/logs/{reloadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the script log of one reload
      effect: read
      questions:
      - Can I read the full text log of a reload that failed?
      - What format is a single reload log returned in?
      instructions:
      - text: Get the script log text for reload {reloadId} of app {appId}.
        slots:
          reloadId: path.reloadId
          appId: path.appId
      - text: Show why reload {reloadId} in app {appId} failed by reading its log.
        slots:
          reloadId: path.reloadId
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/reloads/metadata/{reloadId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reload metadata for an app
      effect: read
      questions:
      - How long did my recent app reloads take and when did they end?
      - How many past reloads keep metadata for an app?
      instructions:
      - text: Get reload duration and lineage metadata for reload {reloadId} of app {appId}.
        slots:
          reloadId: path.reloadId
          appId: path.appId
      - text: Show the last {limit} reload metadata entries for app {appId} starting at reload {reloadId}.
        slots:
          limit: query.limit
          appId: path.appId
          reloadId: path.reloadId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's script version history
      effect: read
      questions:
      - Can I see every saved version of an app's load script?
      - Is the script history sorted newest first and can I filter it?
      instructions:
      - text: List the script history for app {appId}.
        slots:
          appId: path.appId
      - text: Show {limit} saved script versions of app {appId} matching {filter}.
        slots:
          limit: query.limit
          appId: path.appId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/scripts'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new load script to an app
      effect: write
      questions:
      - Can I replace an app's load script through the API?
      - Is there a way to attach a version message when saving a script?
      instructions:
      - text: Set the load script of app {appId} to {script}.
        slots:
          appId: path.appId
          script: requestBody.script
      - text: Save script {script} to app {appId} with version note {versionMessage}.
        slots:
          script: requestBody.script
          appId: path.appId
          versionMessage: requestBody.versionMessage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/scripts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of an app script
      effect: read
      questions:
      - Can I read the text of an older saved version of a load script?
      - Where do I get the script content for a specific script version?
      instructions:
      - text: Get script version {id} of app {appId}.
        slots:
          id: path.id
          appId: path.appId
      - text: Show the load script text saved as version {id} in app {appId}.
        slots:
          id: path.id
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/scripts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an old script version
      effect: destructive
      questions:
      - Can I remove an outdated version from an app's script history?
      - Why does deleting the current script version fail?
      instructions:
      - text: Delete script version {id} from app {appId}.
        slots:
          id: path.id
          appId: path.appId
      - text: Remove old script version {id} from the history of app {appId}.
        slots:
          id: path.id
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/scripts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a saved script version
      effect: write
      questions:
      - Can I edit the details of a specific saved script version?
      - Is a saved version of a load script modifiable after the fact?
      instructions:
      - text: Update script version {id} of app {appId}.
        slots:
          id: path.id
          appId: path.appId
      - text: Patch the saved script version {id} in app {appId}.
        slots:
          id: path.id
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/space'].put
  update:
    x-apievangelist-phrasing:
      intent: Move an app into a space
      effect: write
      questions:
      - Can I move an app into a shared space?
      - What do I need to assign an app to a different space?
      instructions:
      - text: Move app {appId} into space {spaceId}.
        slots:
          appId: path.appId
          spaceId: requestBody.spaceId
      - text: Set the space of app {appId} to {spaceId}.
        slots:
          appId: path.appId
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/{appId}/space'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app from its space
      effect: destructive
      questions:
      - Can I take an app out of the space it lives in?
      - What happens to an app when its space assignment is removed?
      instructions:
      - text: Remove app {appId} from its space.
        slots:
          appId: path.appId
      - text: Take app {appId} out of its current space and back to personal.
        slots:
          appId: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an app from a file
      effect: write
      questions:
      - Can I import an app file that was uploaded earlier?
      - Is it possible to import an app straight into a specific space without data?
      instructions:
      - text: Import app file {fileId} as {name}.
        slots:
          fileId: query.fileId
          name: query.name
      - text: Import file {fileId} into space {spaceId} with NoData {NoData}.
        slots:
          fileId: query.fileId
          spaceId: query.spaceId
          NoData: query.NoData
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/privileges'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my app privileges
      effect: read
      questions:
      - Am I allowed to create or import apps in this tenant?
      - What app privileges does my current user have?
      instructions:
      - text: Show my app privileges.
      - text: Check whether I can create and import apps.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/apps/validatescript'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a load script
      effect: read
      questions:
      - Can I check a load script for syntax errors before saving it?
      - Does the API tell me whether a script is valid without running it?
      instructions:
      - text: 'Validate this load script: {script}.'
        slots:
          script: requestBody.script
      - text: Check {script} for syntax errors without saving it.
        slots:
          script: requestBody.script
      method: generated
      generated: '2026-10-01'