API Evangelist conversational phrasing for data-governance/data-products Data Product 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-governance/data-products Data Product API
  version: 1.0.0
extends: openapi/qliksense-data-product-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: 6
- target: $.paths['/api/data-governance/data-products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data product
      effect: write
      questions:
      - How do I package related datasets into a governed data product?
      - Can I add key contacts and glossary terms to a new data product?
      instructions:
      - text: Create a data product named {name}.
        slots:
          name: requestBody.name
      - text: Create data product {name} in space {spaceId} with datasets {datasetIds}.
        slots:
          name: requestBody.name
          spaceId: requestBody.spaceId
          datasetIds: requestBody.datasetIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/data-products/{dataProductId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data product
      effect: read
      questions:
      - What datasets and contacts belong to a data product?
      - Is a given data product activated?
      instructions:
      - text: Get data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      - text: Show the details of data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/data-products/{dataProductId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data product
      effect: destructive
      questions:
      - Does deleting a data product also delete its datasets?
      - How do I permanently remove a data product?
      instructions:
      - text: Delete data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      - text: Permanently remove data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/data-products/{dataProductId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a data product
      effect: write
      questions:
      - Can I add datasets or change tags on an existing data product?
      - Are edits to a data product tracked in its changelog?
      instructions:
      - text: Update data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      - text: Change the description and tags of data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/data-products/{dataProductId}/actions/export-documentation'].get
  update:
    x-apievangelist-phrasing:
      intent: Export data product documentation
      effect: read
      questions:
      - How do I export a data product's documentation as Markdown?
      - Can I generate docs for a data product to share?
      instructions:
      - text: Export documentation for data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      - text: Generate Markdown docs of data product {dataProductId}.
        slots:
          dataProductId: path.dataProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/data-governance/data-products/{dataProductId}/actions/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a data product to another space
      effect: write
      questions:
      - How do I move a data product into a different space?
      - What permissions do I need to relocate a data product?
      instructions:
      - text: Move data product {dataProductId} to space {spaceId}.
        slots:
          dataProductId: path.dataProductId
          spaceId: requestBody.spaceId
      - text: Relocate data product {dataProductId} into space {spaceId}.
        slots:
          dataProductId: path.dataProductId
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-09-26'