# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Collections API
  version: 1.0.0
extends: openapi/qliksense-collections-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: 11
- target: $.paths['/api/v1/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List collections
      effect: read
      questions:
      - Which collections and tags do I have access to in Qlik Cloud?
      - Can I search collections by name or filter them by type?
      instructions:
      - text: List my collections.
      - text: Find collections named {name}.
        slots:
          name: query.name
      - text: List collections of type {type} created by {creatorId}.
        slots:
          type: query.type
          creatorId: query.creatorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a collection
      effect: write
      questions:
      - How do I create a new collection to group apps and items?
      - Do public collections (tags) need a unique name?
      instructions:
      - text: Create a {type} collection named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create a {type} collection called {name} with description {description}.
        slots:
          type: requestBody.type
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collection
      effect: read
      questions:
      - How do I look up one collection by its ID?
      - What metadata does a single collection return?
      instructions:
      - text: Show collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Get the details of collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a collection
      effect: write
      questions:
      - Can I replace a collection's name and description in one call?
      - How do I clear a collection's description?
      instructions:
      - text: Rename collection {collectionId} to {name}.
        slots:
          collectionId: path.collectionId
          name: requestBody.name
      - text: Set the description of collection {collectionId} to {description}.
        slots:
          collectionId: path.collectionId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection
      effect: destructive
      questions:
      - What happens to the items when I delete a collection?
      - How do I get rid of a collection I no longer use?
      instructions:
      - text: Delete collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Delete collection {collectionId} and remove all its items from it.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Publish or unpublish a collection
      effect: write
      questions:
      - How do I publish a private collection as a public governed collection?
      - Can I turn a publicgoverned collection back into a private one?
      instructions:
      - text: Publish collection {collectionId} as publicgoverned.
        slots:
          collectionId: path.collectionId
      - text: Patch the type of collection {collectionId} back to private.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List items in a collection
      effect: read
      questions:
      - What apps and items are inside a particular collection?
      - Can I filter a collection's items by resource type or space?
      instructions:
      - text: List the items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: List {resourceType} items in collection {collectionId}.
        slots:
          resourceType: query.resourceType
          collectionId: path.collectionId
      - text: Show items in collection {collectionId} from space {spaceId}.
        slots:
          collectionId: path.collectionId
          spaceId: query.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an item to a collection
      effect: write
      questions:
      - How do I add an app or other item to a collection?
      - Can I tag an item by putting it into a public collection?
      instructions:
      - text: Add item {id} to collection {collectionId}.
        slots:
          id: requestBody.id
          collectionId: path.collectionId
      - text: Put item {id} into collection {collectionId}.
        slots:
          id: requestBody.id
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}/items/{itemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an item in a collection
      effect: read
      questions:
      - How do I fetch a single item from within a specific collection?
      - Is a given item part of a certain collection?
      instructions:
      - text: Get item {itemId} from collection {collectionId}.
        slots:
          itemId: path.itemId
          collectionId: path.collectionId
      - text: Look up item {itemId} within collection {collectionId}.
        slots:
          itemId: path.itemId
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/{collectionId}/items/{itemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an item from a collection
      effect: destructive
      questions:
      - How do I take an item out of a collection without deleting the item itself?
      - Can I untag an app by removing it from a collection?
      instructions:
      - text: Remove item {itemId} from collection {collectionId}.
        slots:
          itemId: path.itemId
          collectionId: path.collectionId
      - text: Take item {itemId} out of collection {collectionId}.
        slots:
          itemId: path.itemId
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/collections/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my favorites collection
      effect: read
      questions:
      - Where do I find my favorites collection?
      - Why doesn't my favorites list show up when I list collections?
      instructions:
      - text: Show my favorites collection.
      - text: Get the collection holding my favorited items.
      method: generated
      generated: '2026-09-26'