# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for data-stores Data Store API
  version: 1.0.0
extends: openapi/qliksense-datastore-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: 10
- target: $.paths['/api/v1/data-stores'].get
  update:
    x-apievangelist-phrasing:
      intent: List data stores
      effect: read
      questions:
      - Which data stores are registered in my tenant?
      - Can I page and sort the list of data stores?
      instructions:
      - text: List all data stores.
      - text: Show page {page} of data stores sorted by {sort}.
        slots:
          page: query.page
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new data store
      effect: write
      questions:
      - How do I register a new data store?
      - What fields are required to save a data store?
      instructions:
      - text: Create a data store named {technicalName} of type {type}.
        slots:
          technicalName: requestBody.technicalName
          type: requestBody.type
      - text: Save a new {type} data store {technicalName} in space {spaceId}.
        slots:
          type: requestBody.type
          technicalName: requestBody.technicalName
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete empty data stores in bulk
      effect: destructive
      questions:
      - Can I delete several data stores at once?
      - Why won't a data store with data assets delete?
      instructions:
      - text: Delete data stores {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk remove the empty data stores {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data store
      effect: read
      questions:
      - How do I look up a single data store by its ID?
      - What properties does a given data store have?
      instructions:
      - text: Get data store {data-store-id}.
        slots:
          data-store-id: path.data-store-id
      - text: Show details of data store {data-store-id}.
        slots:
          data-store-id: path.data-store-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a data store's definition
      effect: write
      questions:
      - How do I fully overwrite a data store's definition?
      - Can I replace every field on a data store at once?
      instructions:
      - text: Replace data store {data-store-id} with type {type} and name {technicalName}.
        slots:
          data-store-id: path.data-store-id
          type: requestBody.type
          technicalName: requestBody.technicalName
      - text: Overwrite the full definition of data store {data-store-id}.
        slots:
          data-store-id: path.data-store-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a data store
      effect: write
      questions:
      - Can I change just one field on a data store?
      - How do I patch a data store without resending everything?
      instructions:
      - text: Patch data store {data-store-id}.
        slots:
          data-store-id: path.data-store-id
      - text: Change only some fields of data store {data-store-id}.
        slots:
          data-store-id: path.data-store-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-ids}/data-assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List data assets in data stores
      effect: read
      questions:
      - What data assets belong to a data store?
      - Can I list data assets across several data stores?
      instructions:
      - text: List data assets in data store {data-store-ids}.
        slots:
          data-store-ids: path.data-store-ids
      - text: Show page {page} of data assets for stores {data-store-ids}.
        slots:
          page: query.page
          data-store-ids: path.data-store-ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-ids}/data-assets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all data assets in data stores
      effect: destructive
      questions:
      - How do I clear out every data asset in a data store?
      - Does deleting a store's data assets also delete their data sets?
      instructions:
      - text: Delete all data assets in data store {data-store-ids}.
        slots:
          data-store-ids: path.data-store-ids
      - text: Wipe the data assets and child data sets of stores {data-store-ids}.
        slots:
          data-store-ids: path.data-store-ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List data sets in data assets
      effect: read
      questions:
      - What data sets sit under a given data asset?
      - Can I list data sets for a data store and data asset together?
      instructions:
      - text: List data sets in data asset {data-asset-ids} of store {data-store-ids}.
        slots:
          data-asset-ids: path.data-asset-ids
          data-store-ids: path.data-store-ids
      - text: Show data sets for assets {data-asset-ids} in stores {data-store-ids} sorted by {sort}.
        slots:
          data-asset-ids: path.data-asset-ids
          data-store-ids: path.data-store-ids
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete data sets under data assets
      effect: destructive
      questions:
      - How do I delete the data sets of a data asset but keep the asset?
      - Can I remove data sets by store and asset IDs?
      instructions:
      - text: Delete data sets in data asset {data-asset-ids} of store {data-store-ids}.
        slots:
          data-asset-ids: path.data-asset-ids
          data-store-ids: path.data-store-ids
      - text: Remove every data set under assets {data-asset-ids} in stores {data-store-ids}.
        slots:
          data-asset-ids: path.data-asset-ids
          data-store-ids: path.data-store-ids
      method: generated
      generated: '2026-10-01'