# 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 Secret Scanning API
  version: 1.0.0
extends: openapi/github-secret-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: 6
- target: $.paths['/enterprises/{enterprise}/secret-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List leaked-secret alerts across an enterprise
      effect: read
      questions:
      - Where have secrets been leaked across all the organizations in our enterprise?
      - Can I filter enterprise-wide secret scanning alerts by secret type?
      instructions:
      - text: List secret scanning alerts across enterprise {enterprise}.
        slots:
          enterprise: path.enterprise
      - text: Show {state} secret scanning alerts of type {secret_type} in enterprise {enterprise}.
        slots:
          enterprise: path.enterprise
          state: query.state
          secret_type: query.secret_type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/secret-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List leaked-secret alerts across an organization
      effect: read
      questions:
      - Which repositories in our organization have exposed credentials that are still open?
      - Can I see org secret alerts that were resolved as false positives?
      instructions:
      - text: List secret scanning alerts for all repositories in {org}.
        slots:
          org: path.org
      - text: Show secret alerts in organization {org} resolved as {resolution}.
        slots:
          org: path.org
          resolution: query.resolution
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/secret-scanning/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List leaked-secret alerts in a repository
      effect: read
      questions:
      - Has anyone committed an API key or token to this repository?
      - What's the way to list only open secret scanning alerts in one repo, newest first?
      instructions:
      - text: List secret scanning alerts for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show {state} secret alerts of type {secret_type} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          state: query.state
          secret_type: query.secret_type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one secret scanning alert
      effect: read
      questions:
      - What kind of secret triggered a specific alert, and has it been resolved?
      - Can I pull up a single leaked-secret alert by its number?
      instructions:
      - text: Show secret scanning alert {alert_number} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      - text: 'Get the secret type and resolution of 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}/secret-scanning/alerts/{alert_number}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resolve or reopen a secret scanning alert
      effect: write
      questions:
      - How do I close a secret scanning alert after I've rotated the leaked credential?
      - Can I mark a leaked-secret alert as used only in tests, with a comment?
      instructions:
      - text: Resolve secret alert {alert_number} in {owner}/{repo} as {resolution}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
          resolution: requestBody.resolution
      - text: Set secret scanning alert {alert_number} in {owner}/{repo} to {state} with comment {resolution_comment}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
          state: requestBody.state
          resolution_comment: requestBody.resolution_comment
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List where a leaked secret was found
      effect: read
      questions:
      - In which files and commits was a leaked secret found?
      - Where exactly does the secret behind an alert appear in the repository history?
      instructions:
      - text: List the locations of secret alert {alert_number} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      - text: Show the files and commits containing the secret for alert {alert_number} in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
          alert_number: path.alert_number
      method: generated
      generated: '2026-09-24'