API Evangelist conversational phrasing for ui-config pinned links API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ui-config pinned links API
  version: 1.0.0
extends: openapi/qliksense-pinned-links-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: 7
- target: $.paths['/api/v1/ui-config/pinned-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List pinned links
      effect: read
      questions:
      - Which pinned navigation links are set up in the tenant?
      - How many pinned links can a tenant have?
      instructions:
      - text: List all pinned links in the tenant.
      - text: Show the pinned navigation links.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pinned link
      effect: write
      questions:
      - How do I pin a link to the Qlik Cloud navigation for all users?
      - Where does a newly pinned link appear in the list?
      instructions:
      - text: Pin link {link} named {name} with type {type} and scope {scope}.
        slots:
          link: requestBody.link
          name: requestBody.name
          type: requestBody.type
          scope: requestBody.scope
      - text: Add a pinned link to {link} called {name}, type {type}, scope {scope}.
        slots:
          link: requestBody.link
          name: requestBody.name
          type: requestBody.type
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pinned link
      effect: read
      questions:
      - How do I look up one pinned link by its ID?
      - What URL does a particular pinned link point to?
      instructions:
      - text: Show pinned link {id}.
        slots:
          id: path.id
      - text: Get the URL and name of pinned link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pinned link
      effect: destructive
      questions:
      - How do I unpin a single navigation link?
      - Can I remove just one pinned link and keep the rest?
      instructions:
      - text: Delete pinned link {id}.
        slots:
          id: path.id
      - text: Unpin link {id} and keep the others.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pinned link
      effect: write
      questions:
      - Can I rename or change the URL of an existing pinned link?
      - How do I edit a pinned link with JSON patches?
      instructions:
      - text: Update pinned link {id} with a JSON patch.
        slots:
          id: path.id
      - text: Change the name of pinned link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links/actions/bulk-create-pinned-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several pinned links at once
      effect: write
      questions:
      - Can I add multiple pinned links in one request?
      - Are bulk-created pinned links added in the order I send them?
      instructions:
      - text: Pin these links {links} with type {type} and scope {scope}.
        slots:
          links: requestBody.links
          type: requestBody.type
          scope: requestBody.scope
      - text: Bulk-create pinned links {links} in order, type {type}, scope {scope}.
        slots:
          links: requestBody.links
          type: requestBody.type
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ui-config/pinned-links/actions/delete-all-pinned-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete all pinned links
      effect: destructive
      questions:
      - How do I clear every pinned link in the tenant at once?
      - Is there a way to reset the navigation by removing all pinned links?
      instructions:
      - text: Delete all pinned links in the tenant.
      - text: Remove every pinned navigation link.
      method: generated
      generated: '2026-09-26'