# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Issue Search API
  version: 1.0.0
extends: openapi/jira-issue-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: 9
- target: $.paths['/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search issues with JQL via /search GET
      effect: read
      questions:
      - Can I run a JQL search as a GET on the unversioned /search path?
      - Which issues match a short JQL query like open bugs in one project?
      instructions:
      - text: Search the unversioned /search path with GET for issues matching {jql}.
        slots:
          jql: query.jql
      - text: Run JQL {jql} as a GET on /search and return only fields {fields}.
        slots:
          jql: query.jql
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search issues with JQL via /search POST
      effect: read
      questions:
      - What if my JQL is too long for a query string on the unversioned /search path?
      - Can I post a large JQL expression to /search in the request body?
      instructions:
      - text: POST JQL {jql} in the body to the unversioned /search path.
        slots:
          jql: requestBody.jql
      - text: Send long JQL {jql} to /search by POST, {maxResults} results per page.
        slots:
          jql: requestBody.jql
          maxResults: requestBody.maxResults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest issues for autocomplete
      effect: read
      questions:
      - How can I build issue autocomplete as a user types a word?
      - Can I get issue suggestions from both history and the current search?
      instructions:
      - text: Suggest issues matching the text {query}.
        slots:
          query: query.query
      - text: Give autocomplete suggestions for {query} within project {currentProjectId}.
        slots:
          query: query.query
          currentProjectId: query.currentProjectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/match'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which issues match JQL queries
      effect: read
      questions:
      - Can I test whether specific issues would be returned by a JQL query?
      - Is there a way to check several issue IDs against several JQL filters at once?
      instructions:
      - text: Check whether issues {issueIds} match 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-09-26'
- target: $.paths['/rest/api/3/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search issues with the retiring JQL GET
      effect: read
      questions:
      - Is the old /rest/api/3/search GET endpoint still usable while it's being removed?
      - Can the legacy v3 search GET fail fast when fields can't be loaded?
      instructions:
      - text: Search issues matching {jql} with the legacy v3 search GET that is being removed.
        slots:
          jql: query.jql
      - text: Run {jql} on the retiring /rest/api/3/search GET starting at result {startAt}.
        slots:
          jql: query.jql
          startAt: query.startAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search issues with the retiring JQL POST
      effect: read
      questions:
      - Does the legacy v3 search POST endpoint still take startAt offsets?
      - What replaces the /rest/api/3/search POST that's being removed?
      instructions:
      - text: POST {jql} to the retiring /rest/api/3/search endpoint.
        slots:
          jql: requestBody.jql
      - text: Use the legacy v3 search POST to fetch {maxResults} issues matching {jql}.
        slots:
          maxResults: requestBody.maxResults
          jql: requestBody.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/search/approximate-count'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate how many issues match JQL
      effect: read
      questions:
      - Roughly how many issues match a bounded JQL query?
      - Can I get an issue count without fetching the issues themselves?
      instructions:
      - text: Estimate how many issues match {jql}.
        slots:
          jql: requestBody.jql
      - text: Give me an approximate count of issues for query {jql}.
        slots:
          jql: requestBody.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/search/jql'].get
  update:
    x-apievangelist-phrasing:
      intent: Search issues with enhanced JQL GET
      effect: read
      questions:
      - Which search endpoint uses nextPageToken paging and can include archived projects?
      - Can I get read-after-write consistent JQL results by reconciling recently edited issues?
      instructions:
      - text: Search issues matching {jql} with the enhanced JQL search GET.
        slots:
          jql: query.jql
      - text: Fetch the next page of enhanced search results for {jql} using token {nextPageToken}.
        slots:
          jql: query.jql
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/search/jql'].post
  update:
    x-apievangelist-phrasing:
      intent: Search issues with enhanced JQL POST
      effect: read
      questions:
      - Can I send an enhanced token-paged JQL search in a POST body?
      - Is there a POST version of the new JQL search that reconciles specific issue IDs?
      instructions:
      - text: POST {jql} to the enhanced JQL search, returning fields {fields}.
        slots:
          jql: requestBody.jql
          fields: requestBody.fields
      - text: Run enhanced search by POST for {jql}, reconciling issues {reconcileIssues}.
        slots:
          jql: requestBody.jql
          reconcileIssues: requestBody.reconcileIssues
      method: generated
      generated: '2026-09-26'