# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST User search API
  version: 1.0.0
extends: openapi/jira-user-search-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: 8
- target: $.paths['/rest/api/3/user/assignable/multiProjectSearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users assignable across projects
      effect: read
      questions:
      - Who can be assigned issues in all of several projects?
      - Can I search for assignable users across multiple project keys?
      instructions:
      - text: Find users assignable in projects {projectKeys}.
        slots:
          projectKeys: query.projectKeys
      - text: Find users named {query} who can take issues in projects {projectKeys}.
        slots:
          query: query.query
          projectKeys: query.projectKeys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/assignable/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users assignable to an issue
      effect: read
      questions:
      - Who can be set as the assignee on a particular issue?
      - Can I find who's assignable for a new issue in one project?
      instructions:
      - text: Find users who can be assigned issue {issueKey}.
        slots:
          issueKey: query.issueKey
      - text: List assignable users matching {query} for new issues in project {project}.
        slots:
          query: query.query
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/permission/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users holding given permissions
      effect: read
      questions:
      - Which users have both browse and edit permission in a project?
      - Can I search for users with a specific permission set on an issue?
      instructions:
      - text: Find users with permissions {permissions} in project {projectKey}.
        slots:
          permissions: query.permissions
          projectKey: query.projectKey
      - text: List users who hold {permissions} on issue {issueKey}.
        slots:
          permissions: query.permissions
          issueKey: query.issueKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest users for a user picker
      effect: read
      questions:
      - Can I get user suggestions with the matching text highlighted for a picker field?
      - Is there a way to exclude certain accounts from user picker results?
      instructions:
      - text: Suggest users for a picker matching {query}.
        slots:
          query: query.query
      - text: Show picker matches for {query} excluding accounts {excludeAccountIds}.
        slots:
          query: query.query
          excludeAccountIds: query.excludeAccountIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search active users by name or property
      effect: read
      questions:
      - Can I search active users by name or email?
      - Is it possible to find users by a user property value?
      instructions:
      - text: Search active users matching {query}.
        slots:
          query: query.query
      - text: Find users whose property matches {property}.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/search/query'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users with a structured query
      effect: read
      questions:
      - Can I find users with a structured query like is assignee of a project?
      - What query syntax does the structured user search accept?
      instructions:
      - text: Find user details matching structured query {query}.
        slots:
          query: query.query
      - text: Return users for structured query {query}, {maxResults} per page.
        slots:
          query: query.query
          maxResults: query.maxResults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/search/query/key'].get
  update:
    x-apievangelist-phrasing:
      intent: Find user keys with a structured query
      effect: read
      questions:
      - Can I get only user keys, not full profiles, from a structured user query?
      - Which user keys match a structured query?
      instructions:
      - text: Get the user keys matching structured query {query}.
        slots:
          query: query.query
      - text: Return just the keys of users for query {query} starting at {startAt}.
        slots:
          query: query.query
          startAt: query.startAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/user/viewissue/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users who can view an issue
      effect: read
      questions:
      - Which users are able to browse a specific issue?
      - Can I check who has permission to see issues in a project?
      instructions:
      - text: Find users who can browse issue {issueKey}.
        slots:
          issueKey: query.issueKey
      - text: List users matching {query} who can view issues in project {projectKey}.
        slots:
          query: query.query
          projectKey: query.projectKey
      method: generated
      generated: '2026-09-26'