StackHawk API — Reports

naftiko: 1.0.0-alpha2
info:
  label: StackHawk API — Reports
  description: 'StackHawk API — Reports. 2 operations. Lead operation: Get Scan Report. Self-contained Naftiko capability
    covering one Stackhawk business surface.'
  tags:
  - Stackhawk
  - Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKHAWK_API_KEY: STACKHAWK_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackhawk-reports
    baseUri: https://api.stackhawk.com
    description: StackHawk API — Reports business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-app-appId-env-envId-scan-scanId-report
      path: /api/v1/app/{appId}/env/{envId}/scan/{scanId}/report
      operations:
      - name: getscanreport
        method: GET
        description: Get Scan Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: appId
          in: path
          type: string
          required: true
        - name: envId
          in: path
          type: string
          required: true
        - name: scanId
          in: path
          type: string
          required: true
      - name: requestreport
        method: POST
        description: Request Report Generation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: appId
          in: path
          type: string
          required: true
        - name: envId
          in: path
          type: string
          required: true
        - name: scanId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.STACKHAWK_API_KEY}}'
  exposes:
  - type: rest
    namespace: stackhawk-reports-rest
    port: 8080
    description: REST adapter for StackHawk API — Reports. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/v1/app/{appid}/env/{envid}/scan/{scanid}/report
      name: api-v1-app-appid-env-envid-scan-scanid-report
      description: REST surface for api-v1-app-appId-env-envId-scan-scanId-report.
      operations:
      - method: GET
        name: getscanreport
        description: Get Scan Report
        call: stackhawk-reports.getscanreport
        with:
          appId: rest.appId
          envId: rest.envId
          scanId: rest.scanId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: requestreport
        description: Request Report Generation
        call: stackhawk-reports.requestreport
        with:
          appId: rest.appId
          envId: rest.envId
          scanId: rest.scanId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackhawk-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for StackHawk API — Reports. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-scan-report
      description: Get Scan Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackhawk-reports.getscanreport
      with:
        appId: tools.appId
        envId: tools.envId
        scanId: tools.scanId
      outputParameters:
      - type: object
        mapping: $.
    - name: request-report-generation
      description: Request Report Generation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackhawk-reports.requestreport
      with:
        appId: tools.appId
        envId: tools.envId
        scanId: tools.scanId
      outputParameters:
      - type: object
        mapping: $.