# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for spaces Shares API
  version: 1.0.0
extends: openapi/qliksense-shares-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: 5
- target: $.paths['/api/v1/spaces/{spaceId}/shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List shares in a space
      effect: read
      questions:
      - Who has resources in a space shared with them?
      - Can I filter a space's shares by user or group?
      instructions:
      - text: List the shares in space {spaceId}.
        slots:
          spaceId: path.spaceId
      - text: List shares in space {spaceId} for user {userId}.
        slots:
          spaceId: path.spaceId
          userId: query.userId
      - text: List shares of resource {resourceId} in space {spaceId}.
        slots:
          resourceId: query.resourceId
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/spaces/{spaceId}/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a resource in a space
      effect: write
      questions:
      - How do I share an item in a space with a user or group?
      - Which roles can I grant when creating a space share?
      instructions:
      - text: Share {resourceType} {resourceId} in space {spaceId} with {assigneeId} as {roles} using share type {type}.
        slots:
          resourceType: requestBody.resourceType
          resourceId: requestBody.resourceId
          spaceId: path.spaceId
          assigneeId: requestBody.assigneeId
          roles: requestBody.roles
          type: requestBody.type
      - text: Give {assigneeId} the {roles} roles on {resourceType} {resourceId} in space {spaceId} as a {type} share.
        slots:
          assigneeId: requestBody.assigneeId
          roles: requestBody.roles
          resourceType: requestBody.resourceType
          resourceId: requestBody.resourceId
          spaceId: path.spaceId
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/spaces/{spaceId}/shares/{shareId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space share
      effect: read
      questions:
      - How do I look up one share in a space?
      - What roles does a particular space share grant?
      instructions:
      - text: Show share {shareId} in space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      - text: Get the roles granted by share {shareId} in space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/spaces/{spaceId}/shares/{shareId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a space share
      effect: destructive
      questions:
      - How do I stop sharing a resource with someone in a space?
      - Can I delete a link share?
      instructions:
      - text: Delete share {shareId} from space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      - text: Revoke share {shareId} in space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/spaces/{spaceId}/shares/{shareId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a space share
      effect: write
      questions:
      - Can I change the roles on an existing space share?
      - How do I disable a link share without deleting it?
      instructions:
      - text: Update the roles on share {shareId} in space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      - text: Disable link share {shareId} in space {spaceId}.
        slots:
          shareId: path.shareId
          spaceId: path.spaceId
      method: generated
      generated: '2026-09-26'