API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Search API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Search API
  version: 1.0.0
extends: openapi/atlassian-issue-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/rest/api/3/issue/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest issues as a user types
      effect: read
      questions:
      - How do I build an autocomplete that suggests Jira issues as someone types?
      - Can issue suggestions include my recently viewed issues and exclude subtasks?
      instructions:
      - text: Suggest issues matching {query}.
        slots:
          query: query.query
      - text: Autocomplete issues for {query} within JQL {currentJQL}.
        slots:
          query: query.query
          currentJQL: query.currentJQL
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/jql/match'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which issues match JQL queries
      effect: read
      questions:
      - Would these specific issues be returned by a given JQL filter?
      - Can I test several issue ids against multiple JQL queries at once?
      instructions:
      - text: Check whether issues {issueIds} match the JQL {jqls}.
        slots:
          issueIds: requestBody.issueIds
          jqls: requestBody.jqls
      - text: Tell me which of issues {issueIds} each of these queries {jqls} would return.
        slots:
          issueIds: requestBody.issueIds
          jqls: requestBody.jqls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search issues with a short JQL query
      effect: read
      questions:
      - How do I search Jira issues with JQL in a simple GET request?
      - Can I choose which fields come back when searching issues by JQL in the URL?
      instructions:
      - text: Search issues with JQL {jql} passed in the query string.
        slots:
          jql: query.jql
      - text: Find up to {maxResults} issues for {jql} returning only fields {fields}.
        slots:
          maxResults: query.maxResults
          jql: query.jql
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search issues with a long JQL query in the body
      effect: read
      questions:
      - What do I do when my JQL is too long to fit in a URL?
      - Can I send a large JQL search in a request body and still pick fields?
      instructions:
      - text: 'Run this long JQL search in the request body: {jql}.'
        slots:
          jql: requestBody.jql
      - text: Search issues by body JQL {jql} starting at {startAt} and including fields {fields}.
        slots:
          jql: requestBody.jql
          startAt: requestBody.startAt
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/search/id'].post
  update:
    x-apievangelist-phrasing:
      intent: Get only the ids of issues matching JQL
      effect: read
      questions:
      - Is there a faster search that returns just issue ids for a JQL query?
      - How do I page through matching issue ids with a next-page token?
      instructions:
      - text: Return only the issue ids matching {jql}.
        slots:
          jql: requestBody.jql
      - text: Get the next page of issue ids for {jql} using token {nextPageToken}.
        slots:
          jql: requestBody.jql
          nextPageToken: requestBody.nextPageToken
      method: generated
      generated: '2026-10-01'