# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitHub v3 REST Search API
  version: 1.0.0
extends: openapi/github-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for code inside files
      effect: read
      questions:
      - How do I find where a function is defined across GitHub repositories?
      - Can I search file contents for a keyword limited to one language and repo?
      - Which files mention a given string in my codebase?
      instructions:
      - text: Search code for {q}.
        slots:
          q: query.q
      - text: Find files whose contents match {q}, showing {per_page} results per page.
        slots:
          q: query.q
          per_page: query.per_page
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/commits'].get
  update:
    x-apievangelist-phrasing:
      intent: Search commits on default branches
      effect: read
      questions:
      - How can I find commits whose message mentions a bug number?
      - Can I sort commit search results by author date?
      instructions:
      - text: Search commits matching {q}.
        slots:
          q: query.q
      - text: Find commits matching {q}, sorted by {sort} in {order} order.
        slots:
          q: query.q
          sort: query.sort
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: Search issues and pull requests
      effect: read
      questions:
      - How do I find open issues mentioning a keyword across repositories?
      - Can I sort issue and pull request search results by number of comments or reactions?
      - Which pull requests match a keyword and state?
      instructions:
      - text: Search issues and pull requests for {q}.
        slots:
          q: query.q
      - text: Find issues and PRs matching {q}, sorted by {sort}.
        slots:
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: Search labels in a repository
      effect: read
      questions:
      - How do I find issue labels in one repository by name or description?
      - Can I sort matching labels by when they were created?
      instructions:
      - text: Search labels in repository {repository_id} for {q}.
        slots:
          repository_id: query.repository_id
          q: query.q
      - text: Find labels matching {q} in repo {repository_id}, sorted by {sort}.
        slots:
          q: query.q
          repository_id: query.repository_id
          sort: query.sort
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: Search repositories
      effect: read
      questions:
      - What are the most-starred repositories for a given topic or language?
      - Can I sort repository search results by forks or help-wanted issues?
      - How do I find GitHub repos whose name or description matches a keyword?
      instructions:
      - text: Search repositories for {q}.
        slots:
          q: query.q
      - text: Find repositories matching {q}, sorted by {sort} in {order} order.
        slots:
          q: query.q
          sort: query.sort
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: Search repository topics
      effect: read
      questions:
      - Which repository topics exist that relate to a keyword?
      - How do I look up topics to tag my repo with?
      instructions:
      - text: Search topics matching {q}.
        slots:
          q: query.q
      - text: Show page {page} of topics that match {q}.
        slots:
          page: query.page
          q: query.q
      method: generated
      generated: '2026-09-24'
- target: $.paths['/search/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Search users
      effect: read
      questions:
      - How do I find GitHub users by login, name or public email?
      - Can I sort user search results by number of followers?
      instructions:
      - text: Search users matching {q}.
        slots:
          q: query.q
      - text: Find users matching {q}, sorted by {sort}.
        slots:
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-09-24'