Snyk API — BrokerDeployments

naftiko: 1.0.0-alpha2
info:
  label: Snyk API — BrokerDeployments
  description: 'Snyk API — BrokerDeployments. 5 operations. Lead operation: List Broker deployments for tenant. Self-contained
    Naftiko capability covering one Snyk business surface.'
  tags:
  - Snyk
  - BrokerDeployments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SNYK_API_KEY: SNYK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-brokerdeployments
    baseUri: https://api.snyk.io/rest
    description: Snyk API — BrokerDeployments business capability. Self-contained, no shared references.
    resources:
    - name: tenants-tenant_id-brokers-deployments
      path: /tenants/{tenant_id}/brokers/deployments
      operations:
      - name: listbrokerdeploymentsfortenant
        method: GET
        description: List Broker deployments for tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
    - name: tenants-tenant_id-brokers-installs-install_id-deployments
      path: /tenants/{tenant_id}/brokers/installs/{install_id}/deployments
      operations:
      - name: listbrokerdeployments
        method: GET
        description: List Broker deployments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
      - name: createbrokerdeployment
        method: POST
        description: Creates Broker Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id
      path: /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}
      operations:
      - name: deletebrokerdeployment
        method: DELETE
        description: Deletes Broker deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
      - name: updatebrokerdeployment
        method: PATCH
        description: Updates Broker deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: query
          type: string
          description: The requested version of the endpoint to process the request
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SNYK_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-brokerdeployments-rest
    port: 8080
    description: REST adapter for Snyk API — BrokerDeployments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/tenants/{tenant-id}/brokers/deployments
      name: tenants-tenant-id-brokers-deployments
      description: REST surface for tenants-tenant_id-brokers-deployments.
      operations:
      - method: GET
        name: listbrokerdeploymentsfortenant
        description: List Broker deployments for tenant
        call: rest-brokerdeployments.listbrokerdeploymentsfortenant
        with:
          limit: rest.limit
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tenants/{tenant-id}/brokers/installs/{install-id}/deployments
      name: tenants-tenant-id-brokers-installs-install-id-deployments
      description: REST surface for tenants-tenant_id-brokers-installs-install_id-deployments.
      operations:
      - method: GET
        name: listbrokerdeployments
        description: List Broker deployments
        call: rest-brokerdeployments.listbrokerdeployments
        with:
          limit: rest.limit
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbrokerdeployment
        description: Creates Broker Deployment
        call: rest-brokerdeployments.createbrokerdeployment
        with:
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tenants/{tenant-id}/brokers/installs/{install-id}/deployments/{deployment-id}
      name: tenants-tenant-id-brokers-installs-install-id-deployments-deployment-id
      description: REST surface for tenants-tenant_id-brokers-installs-install_id-deployments-deployment_id.
      operations:
      - method: DELETE
        name: deletebrokerdeployment
        description: Deletes Broker deployment
        call: rest-brokerdeployments.deletebrokerdeployment
        with:
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatebrokerdeployment
        description: Updates Broker deployment
        call: rest-brokerdeployments.updatebrokerdeployment
        with:
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-brokerdeployments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Snyk API — BrokerDeployments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-broker-deployments-tenant
      description: List Broker deployments for tenant
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-brokerdeployments.listbrokerdeploymentsfortenant
      with:
        limit: tools.limit
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: list-broker-deployments
      description: List Broker deployments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-brokerdeployments.listbrokerdeployments
      with:
        limit: tools.limit
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-broker-deployment
      description: Creates Broker Deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-brokerdeployments.createbrokerdeployment
      with:
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-broker-deployment
      description: Deletes Broker deployment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-brokerdeployments.deletebrokerdeployment
      with:
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-broker-deployment
      description: Updates Broker deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-brokerdeployments.updatebrokerdeployment
      with:
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.