CloudZero API — Insights

naftiko: 1.0.0-alpha2
info:
  label: CloudZero API — Insights
  description: 'CloudZero API — Insights. 5 operations. Lead operation: CloudZero Get all insights. Self-contained Naftiko
    capability covering one Cloudzero business surface.'
  tags:
  - Cloudzero
  - Insights
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLOUDZERO_API_KEY: CLOUDZERO_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloudzero-insights
    baseUri: https://api.cloudzero.com
    description: CloudZero API — Insights business capability. Self-contained, no shared references.
    resources:
    - name: v2-insights
      path: /v2/insights
      operations:
      - name: getinsights
        method: GET
        description: CloudZero Get all insights
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number for pagination.
        - name: page_size
          in: query
          type: integer
          description: Number of results per page.
      - name: createinsight
        method: POST
        description: CloudZero Create a new insight
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v2-insights-insight_id
      path: /v2/insights/{insight_id}
      operations:
      - name: getoneinsight
        method: GET
        description: CloudZero Get a single insight
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: insight_id
          in: path
          type: string
          description: Unique identifier for the insight.
          required: true
      - name: updateoneinsight
        method: PUT
        description: CloudZero Update an insight
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: insight_id
          in: path
          type: string
          description: Unique identifier for the insight.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteoneinsight
        method: DELETE
        description: CloudZero Delete an insight
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: insight_id
          in: path
          type: string
          description: Unique identifier for the insight.
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.CLOUDZERO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cloudzero-insights-rest
    port: 8080
    description: REST adapter for CloudZero API — Insights. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/insights
      name: v2-insights
      description: REST surface for v2-insights.
      operations:
      - method: GET
        name: getinsights
        description: CloudZero Get all insights
        call: cloudzero-insights.getinsights
        with:
          page: rest.page
          page_size: rest.page_size
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createinsight
        description: CloudZero Create a new insight
        call: cloudzero-insights.createinsight
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/insights/{insight-id}
      name: v2-insights-insight-id
      description: REST surface for v2-insights-insight_id.
      operations:
      - method: GET
        name: getoneinsight
        description: CloudZero Get a single insight
        call: cloudzero-insights.getoneinsight
        with:
          insight_id: rest.insight_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateoneinsight
        description: CloudZero Update an insight
        call: cloudzero-insights.updateoneinsight
        with:
          insight_id: rest.insight_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteoneinsight
        description: CloudZero Delete an insight
        call: cloudzero-insights.deleteoneinsight
        with:
          insight_id: rest.insight_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloudzero-insights-mcp
    port: 9090
    transport: http
    description: MCP adapter for CloudZero API — Insights. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: cloudzero-get-all-insights
      description: CloudZero Get all insights
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloudzero-insights.getinsights
      with:
        page: tools.page
        page_size: tools.page_size
      outputParameters:
      - type: object
        mapping: $.
    - name: cloudzero-create-new-insight
      description: CloudZero Create a new insight
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloudzero-insights.createinsight
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cloudzero-get-single-insight
      description: CloudZero Get a single insight
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloudzero-insights.getoneinsight
      with:
        insight_id: tools.insight_id
      outputParameters:
      - type: object
        mapping: $.
    - name: cloudzero-update-insight
      description: CloudZero Update an insight
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloudzero-insights.updateoneinsight
      with:
        insight_id: tools.insight_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cloudzero-delete-insight
      description: CloudZero Delete an insight
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloudzero-insights.deleteoneinsight
      with:
        insight_id: tools.insight_id
      outputParameters:
      - type: object
        mapping: $.