# 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 Code Scanning API
  version: 1.0.0
extends: openapi/github-code-scanning-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: 13
- target: $.paths['/enterprises/{enterprise}/code-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List code scanning alerts across an enterprise
      effect: read
      questions:
      - What code scanning alerts are open across every organization in our enterprise?
      - Can I narrow enterprise-wide code scanning alerts to one analysis tool like CodeQL?
      instructions:
      - text: List code scanning alerts across enterprise {enterprise}.
        slots:
          enterprise: path.enterprise
      - text: Show {state} code scanning alerts in enterprise {enterprise} from tool {tool_name}.
        slots:
          enterprise: path.enterprise
          state: query.state
          tool_name: query.tool_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/code-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List code scanning alerts across an organization
      effect: read
      questions:
      - Which repositories in our organization have critical code scanning alerts on the default branch?
      - Can I see every open code scanning alert across an org sorted by when it was last updated?
      instructions:
      - text: List code scanning alerts for all repositories in {org}.
        slots:
          org: path.org
      - text: Show {severity} code scanning alerts in organization {org} that are {state}.
        slots:
          org: path.org
          severity: query.severity
          state: query.state
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List code scanning alerts in a repository
      effect: read
      questions:
      - What code scanning alerts does a repository have right now?
      - Can I list the alerts found on a specific branch or pull request ref?
      - Which high-severity code issues are still open in one repo?
      instructions:
      - text: List code scanning alerts for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show code scanning alerts in {owner}/{repo} on ref {ref}.
        slots:
          owner: path.owner
          repo: path.repo
          ref: query.ref
      - text: List {state} {severity} code scanning alerts in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          state: query.state
          severity: query.severity
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one code scanning alert
      effect: read
      questions:
      - What rule triggered a specific code scanning alert and where in the code is it?
      - Can I look up a single code scanning alert by its number?
      instructions:
      - text: Show code scanning alert {alert_number} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      - text: 'Get the rule and location for code scanning alert #{alert_number} in {owner}/{repo}.'
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Dismiss or reopen a code scanning alert
      effect: write
      questions:
      - How do I dismiss a code scanning alert as a false positive?
      - Can I reopen a code scanning alert I dismissed earlier?
      instructions:
      - text: Dismiss code scanning alert {alert_number} in {owner}/{repo} as {dismissed_reason}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
          dismissed_reason: requestBody.dismissed_reason
      - text: Set code scanning alert {alert_number} in {owner}/{repo} to state {state} with comment {dismissed_comment}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
          state: requestBody.state
          dismissed_comment: requestBody.dismissed_comment
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List where a code scanning alert occurs
      effect: read
      questions:
      - On which branches and files does a single code scanning alert show up?
      - Is a particular code scanning alert present on my feature branch?
      instructions:
      - text: List the instances of code scanning alert {alert_number} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      - text: Show where alert {alert_number} occurs in {owner}/{repo} on ref {ref}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
          ref: query.ref
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/analyses'].get
  update:
    x-apievangelist-phrasing:
      intent: List code scanning analyses for a repository
      effect: read
      questions:
      - When did code scanning last analyze my repository, and with which tool?
      - Which analyses came from a particular SARIF upload?
      instructions:
      - text: List recent code scanning analyses for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show analyses in {owner}/{repo} for ref {ref} run by {tool_name}.
        slots:
          owner: path.owner
          repo: path.repo
          ref: query.ref
          tool_name: query.tool_name
      - text: List the analyses in {owner}/{repo} produced by SARIF upload {sarif_id}.
        slots:
          owner: path.owner
          repo: path.repo
          sarif_id: query.sarif_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one code scanning analysis
      effect: read
      questions:
      - What did a single code scanning analysis find, and can I download it as SARIF?
      - Which commit and tool produced a given analysis?
      instructions:
      - text: Show code scanning analysis {analysis_id} for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          analysis_id: path.analysis_id
      - text: Get the commit, tool and results count of analysis {analysis_id} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          analysis_id: path.analysis_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a code scanning analysis
      effect: destructive
      questions:
      - Can I delete a bad code scanning analysis that was uploaded by mistake?
      - Why can't I delete the last analysis in a set without extra confirmation?
      instructions:
      - text: Delete code scanning analysis {analysis_id} from {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          analysis_id: path.analysis_id
      - text: Delete the final analysis {analysis_id} in its set in {owner}/{repo} with confirm_delete {confirm_delete}.
        slots:
          owner: path.owner
          repo: path.repo
          analysis_id: path.analysis_id
          confirm_delete: query.confirm_delete
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/default-setup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's code scanning default setup
      effect: read
      questions:
      - Is code scanning default setup turned on for my repository, and which query suite does it use?
      - What languages does the default code scanning setup cover in a repo?
      instructions:
      - text: Show the code scanning default setup for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Check whether default setup is configured in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/default-setup'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn code scanning default setup on or off
      effect: write
      questions:
      - How do I enable CodeQL default setup on a repository without writing a workflow?
      - Can I switch default setup to the extended query suite?
      instructions:
      - text: Set code scanning default setup in {owner}/{repo} to {state}.
        slots:
          owner: path.owner
          repo: path.repo
          state: requestBody.state
      - text: Configure default setup for {owner}/{repo} as {state} using the {query_suite} query suite.
        slots:
          owner: path.owner
          repo: path.repo
          state: requestBody.state
          query_suite: requestBody.query_suite
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/sarifs'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload SARIF results from a code scanning tool
      effect: write
      questions:
      - How do I get results from a third-party static analysis tool to show up as code scanning alerts?
      - What commit and ref do I need to supply when uploading a SARIF file?
      instructions:
      - text: Upload SARIF data {sarif} to {owner}/{repo} for commit {commit_sha} on {ref}.
        slots:
          owner: path.owner
          repo: path.repo
          sarif: requestBody.sarif
          commit_sha: requestBody.commit_sha
          ref: requestBody.ref
      - text: Submit {tool_name} results {sarif} to {owner}/{repo} for commit {commit_sha} on ref {ref}.
        slots:
          owner: path.owner
          repo: path.repo
          tool_name: requestBody.tool_name
          sarif: requestBody.sarif
          commit_sha: requestBody.commit_sha
          ref: requestBody.ref
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the processing status of a SARIF upload
      effect: read
      questions:
      - Has my SARIF upload finished processing, or did it fail?
      - Which analysis was created from a SARIF file I uploaded?
      instructions:
      - text: Check the processing status of SARIF upload {sarif_id} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          sarif_id: path.sarif_id
      - text: Get the analysis link for SARIF upload {sarif_id} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          sarif_id: path.sarif_id
      method: generated
      generated: '2026-09-24'