Speakeasy API — Reports

naftiko: 1.0.0-alpha2
info:
  label: Speakeasy API — Reports
  description: 'Speakeasy API — Reports. 3 operations. Lead operation: Upload a Report. Self-contained Naftiko capability
    covering one Speakeasy business surface.'
  tags:
  - Speakeasy
  - Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SPEAKEASY_API_KEY: SPEAKEASY_API_KEY
capability:
  consumes:
  - type: http
    namespace: speakeasy-reports
    baseUri: https://api.prod.speakeasy.com
    description: Speakeasy API — Reports business capability. Self-contained, no shared references.
    resources:
    - name: v1-reports
      path: /v1/reports
      operations:
      - name: uploadreport
        method: POST
        description: Upload a Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-reports-changes-documentChecksum
      path: /v1/reports/changes/{documentChecksum}
      operations:
      - name: getchangesreportsignedurl
        method: GET
        description: Get the Signed Access URL for the Change Reports for a Particular Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentChecksum
          in: path
          type: string
          description: The checksum of the document to retrieve the signed access url for.
          required: true
    - name: v1-reports-linting-documentChecksum
      path: /v1/reports/linting/{documentChecksum}
      operations:
      - name: getlintingreportsignedurl
        method: GET
        description: Get the Signed Access URL for the Linting Reports for a Particular Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentChecksum
          in: path
          type: string
          description: The checksum of the document to retrieve the signed access url for.
          required: true
    authentication:
      type: bearer
      token: '{{env.SPEAKEASY_API_KEY}}'
  exposes:
  - type: rest
    namespace: speakeasy-reports-rest
    port: 8080
    description: REST adapter for Speakeasy API — Reports. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/reports
      name: v1-reports
      description: REST surface for v1-reports.
      operations:
      - method: POST
        name: uploadreport
        description: Upload a Report
        call: speakeasy-reports.uploadreport
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/reports/changes/{documentchecksum}
      name: v1-reports-changes-documentchecksum
      description: REST surface for v1-reports-changes-documentChecksum.
      operations:
      - method: GET
        name: getchangesreportsignedurl
        description: Get the Signed Access URL for the Change Reports for a Particular Document
        call: speakeasy-reports.getchangesreportsignedurl
        with:
          documentChecksum: rest.documentChecksum
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/reports/linting/{documentchecksum}
      name: v1-reports-linting-documentchecksum
      description: REST surface for v1-reports-linting-documentChecksum.
      operations:
      - method: GET
        name: getlintingreportsignedurl
        description: Get the Signed Access URL for the Linting Reports for a Particular Document
        call: speakeasy-reports.getlintingreportsignedurl
        with:
          documentChecksum: rest.documentChecksum
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: speakeasy-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for Speakeasy API — Reports. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: upload-report
      description: Upload a Report
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-reports.uploadreport
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-signed-access-url-change
      description: Get the Signed Access URL for the Change Reports for a Particular Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-reports.getchangesreportsignedurl
      with:
        documentChecksum: tools.documentChecksum
      outputParameters:
      - type: object
        mapping: $.
    - name: get-signed-access-url-linting
      description: Get the Signed Access URL for the Linting Reports for a Particular Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-reports.getlintingreportsignedurl
      with:
        documentChecksum: tools.documentChecksum
      outputParameters:
      - type: object
        mapping: $.