GitHub Repos API — Static Analysis Results Interchange Format

naftiko: 1.0.0-alpha2
info:
  label: GitHub Repos API — Static Analysis Results Interchange Format
  description: 'GitHub Repos API — Static Analysis Results Interchange Format. 2 operations. Lead operation: Upload An Analysis
    As Sarif Data. Self-contained Naftiko capability covering one Github business surface.'
  tags:
  - Github
  - Static Analysis Results Interchange Format
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GITHUB_API_KEY: GITHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: temp-static-analysis-results-interchange-format
    baseUri: ''
    description: GitHub Repos API — Static Analysis Results Interchange Format business capability. Self-contained, no shared
      references.
    resources:
    - name: repos-owner-repo-code-scanning-sarifs
      path: /repos/{owner}/{repo}/code-scanning/sarifs
      operations:
      - name: uploadananalysisassarifdata
        method: POST
        description: Upload An Analysis As Sarif Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: repos-owner-repo-code-scanning-sarifs-sarif_id
      path: /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}
      operations:
      - name: getinformationaboutsarifupload
        method: GET
        description: Get Information About Sarif Upload
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sarif_id
          in: path
          type: string
          description: The SARIF ID obtained after uploading.
          required: true
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.GITHUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: temp-static-analysis-results-interchange-format-rest
    port: 8080
    description: REST adapter for GitHub Repos API — Static Analysis Results Interchange Format. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/repos/{owner}/{repo}/code-scanning/sarifs
      name: repos-owner-repo-code-scanning-sarifs
      description: REST surface for repos-owner-repo-code-scanning-sarifs.
      operations:
      - method: POST
        name: uploadananalysisassarifdata
        description: Upload An Analysis As Sarif Data
        call: temp-static-analysis-results-interchange-format.uploadananalysisassarifdata
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/code-scanning/sarifs/{sarif-id}
      name: repos-owner-repo-code-scanning-sarifs-sarif-id
      description: REST surface for repos-owner-repo-code-scanning-sarifs-sarif_id.
      operations:
      - method: GET
        name: getinformationaboutsarifupload
        description: Get Information About Sarif Upload
        call: temp-static-analysis-results-interchange-format.getinformationaboutsarifupload
        with:
          sarif_id: rest.sarif_id
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: temp-static-analysis-results-interchange-format-mcp
    port: 9090
    transport: http
    description: MCP adapter for GitHub Repos API — Static Analysis Results Interchange Format. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: upload-analysis-sarif-data
      description: Upload An Analysis As Sarif Data
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: temp-static-analysis-results-interchange-format.uploadananalysisassarifdata
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-information-about-sarif-upload
      description: Get Information About Sarif Upload
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: temp-static-analysis-results-interchange-format.getinformationaboutsarifupload
      with:
        sarif_id: tools.sarif_id
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.