API Evangelist conversational phrasing for data-sets Data Set API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for data-sets Data Set API
  version: 1.0.0
extends: openapi/qliksense-dataset-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: 5
- target: $.paths['/api/v1/data-sets'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new data set
      effect: write
      questions:
      - How do I register a new data set in the catalog?
      - What identifiers are required to save a new data set?
      instructions:
      - text: Save a new data set {technicalName} with QRI {qri}, secure QRI {secureQri} and asset info {dataAssetInfo}.
        slots:
          technicalName: requestBody.technicalName
          qri: requestBody.qri
          secureQri: requestBody.secureQri
          dataAssetInfo: requestBody.dataAssetInfo
      - text: Create data set {technicalName} in space {spaceId}.
        slots:
          technicalName: requestBody.technicalName
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several data sets at once
      effect: destructive
      questions:
      - Can I delete multiple data sets in one request?
      - What's the bulk option for removing data sets?
      instructions:
      - text: Delete data sets {ids}.
        slots:
          ids: requestBody.ids
      - text: Batch remove the data sets with IDs {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{data-set-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data set
      effect: read
      questions:
      - Where can I see one data set's schema and properties?
      - Can I request only certain fields of a data set with projections?
      instructions:
      - text: Get data set {data-set-id}.
        slots:
          data-set-id: path.data-set-id
      - text: Show data set {data-set-id} with projections {projections}.
        slots:
          data-set-id: path.data-set-id
          projections: query.projections
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{data-set-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Fully replace a data set
      effect: write
      questions:
      - Can I replace every attribute of a data set, including its owner?
      - Who is allowed to do a full update of a data set in a space?
      instructions:
      - text: Replace data set {data-set-id} with name {technicalName}, QRI {qri}, secure QRI {secureQri} and asset info {dataAssetInfo}.
        slots:
          data-set-id: path.data-set-id
          technicalName: requestBody.technicalName
          qri: requestBody.qri
          secureQri: requestBody.secureQri
          dataAssetInfo: requestBody.dataAssetInfo
      - text: Fully update data set {data-set-id} with owner {ownerId}.
        slots:
          data-set-id: path.data-set-id
          ownerId: requestBody.ownerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-sets/{data-set-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a data set with JSON Patch
      effect: write
      questions:
      - Can I change just one field of a data set using JSON Patch operations?
      - Is there a partial update for a data set's ownership attributes?
      instructions:
      - text: Apply a JSON Patch to data set {data-set-id}.
        slots:
          data-set-id: path.data-set-id
      - text: Partially update the description on data set {data-set-id}.
        slots:
          data-set-id: path.data-set-id
      method: generated
      generated: '2026-10-01'