GitHub v3 REST API — Secret-Scanning

naftiko: 1.0.0-alpha2
info:
  label: GitHub v3 REST API — Secret-Scanning
  description: 'GitHub v3 REST API — Secret-Scanning. 6 operations. Lead operation: GitHub List Secret Scanning Alerts for
    an Enterprise. Self-contained Naftiko capability covering one Github business surface.'
  tags:
  - Github
  - Secret-Scanning
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GITHUB_API_KEY: GITHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: github-secret-scanning
    baseUri: ''
    description: GitHub v3 REST API — Secret-Scanning business capability. Self-contained, no shared references.
    resources:
    - name: enterprises-enterprise-secret-scanning-alerts
      path: /enterprises/{enterprise}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsforenterprise
        method: GET
        description: GitHub List Secret Scanning Alerts for an Enterprise
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-org-secret-scanning-alerts
      path: /orgs/{org}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsfororg
        method: GET
        description: GitHub List Secret Scanning Alerts for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: repos-owner-repo-secret-scanning-alerts
      path: /repos/{owner}/{repo}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsforrepo
        method: GET
        description: GitHub List Secret Scanning Alerts for a Repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: repos-owner-repo-secret-scanning-alerts-alert_number
      path: /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
      operations:
      - name: secretscanninggetalert
        method: GET
        description: GitHub Get a Secret Scanning Alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: secretscanningupdatealert
        method: PATCH
        description: GitHub Update a Secret Scanning Alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: repos-owner-repo-secret-scanning-alerts-alert_number-locations
      path: /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
      operations:
      - name: secretscanninglistlocationsforalert
        method: GET
        description: GitHub List Locations for a Secret Scanning Alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: github-secret-scanning-rest
    port: 8080
    description: REST adapter for GitHub v3 REST API — Secret-Scanning. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/enterprises/{enterprise}/secret-scanning/alerts
      name: enterprises-enterprise-secret-scanning-alerts
      description: REST surface for enterprises-enterprise-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsforenterprise
        description: GitHub List Secret Scanning Alerts for an Enterprise
        call: github-secret-scanning.secretscanninglistalertsforenterprise
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/secret-scanning/alerts
      name: orgs-org-secret-scanning-alerts
      description: REST surface for orgs-org-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsfororg
        description: GitHub List Secret Scanning Alerts for an Organization
        call: github-secret-scanning.secretscanninglistalertsfororg
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts
      name: repos-owner-repo-secret-scanning-alerts
      description: REST surface for repos-owner-repo-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsforrepo
        description: GitHub List Secret Scanning Alerts for a Repository
        call: github-secret-scanning.secretscanninglistalertsforrepo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts/{alert-number}
      name: repos-owner-repo-secret-scanning-alerts-alert-number
      description: REST surface for repos-owner-repo-secret-scanning-alerts-alert_number.
      operations:
      - method: GET
        name: secretscanninggetalert
        description: GitHub Get a Secret Scanning Alert
        call: github-secret-scanning.secretscanninggetalert
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: secretscanningupdatealert
        description: GitHub Update a Secret Scanning Alert
        call: github-secret-scanning.secretscanningupdatealert
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts/{alert-number}/locations
      name: repos-owner-repo-secret-scanning-alerts-alert-number-locations
      description: REST surface for repos-owner-repo-secret-scanning-alerts-alert_number-locations.
      operations:
      - method: GET
        name: secretscanninglistlocationsforalert
        description: GitHub List Locations for a Secret Scanning Alert
        call: github-secret-scanning.secretscanninglistlocationsforalert
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: github-secret-scanning-mcp
    port: 9090
    transport: http
    description: MCP adapter for GitHub v3 REST API — Secret-Scanning. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: github-list-secret-scanning-alerts
      description: GitHub List Secret Scanning Alerts for an Enterprise
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsforenterprise
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-secret-scanning-alerts-2
      description: GitHub List Secret Scanning Alerts for an Organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsfororg
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-secret-scanning-alerts-3
      description: GitHub List Secret Scanning Alerts for a Repository
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsforrepo
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-secret-scanning-alert
      description: GitHub Get a Secret Scanning Alert
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninggetalert
      outputParameters:
      - type: object
        mapping: $.
    - name: github-update-secret-scanning-alert
      description: GitHub Update a Secret Scanning Alert
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanningupdatealert
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-locations-secret-scanning
      description: GitHub List Locations for a Secret Scanning Alert
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistlocationsforalert
      outputParameters:
      - type: object
        mapping: $.