CockroachDB Cloud API — EgressRules

naftiko: 1.0.0-alpha2
info:
  label: CockroachDB Cloud API — EgressRules
  description: 'CockroachDB Cloud API — EgressRules. 5 operations. Lead operation: List egress rules. Self-contained Naftiko
    capability covering one Cockroachdb business surface.'
  tags:
  - Cockroachdb
  - EgressRules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COCKROACHDB_API_KEY: COCKROACHDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-egressrules
    baseUri: https://cockroachlabs.cloud
    description: CockroachDB Cloud API — EgressRules business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-clusters-cluster_id-networking-egress-rules
      path: /api/v1/clusters/{cluster_id}/networking/egress-rules
      operations:
      - name: listegressrules
        method: GET
        description: List egress rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addegressrule
        method: POST
        description: Add an egress rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-clusters-cluster_id-networking-egress-rules-rule_id
      path: /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}
      operations:
      - name: getegressrule
        method: GET
        description: Get an egress rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: editegressrule
        method: PATCH
        description: Update an egress rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteegressrule
        method: DELETE
        description: Delete an egress rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: idempotency_key
          in: query
          type: string
          description: Optional key for idempotent deletion.
    authentication:
      type: bearer
      token: '{{env.COCKROACHDB_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-egressrules-rest
    port: 8080
    description: REST adapter for CockroachDB Cloud API — EgressRules. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/clusters/{cluster-id}/networking/egress-rules
      name: api-v1-clusters-cluster-id-networking-egress-rules
      description: REST surface for api-v1-clusters-cluster_id-networking-egress-rules.
      operations:
      - method: GET
        name: listegressrules
        description: List egress rules
        call: cloud-egressrules.listegressrules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addegressrule
        description: Add an egress rule
        call: cloud-egressrules.addegressrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/clusters/{cluster-id}/networking/egress-rules/{rule-id}
      name: api-v1-clusters-cluster-id-networking-egress-rules-rule-id
      description: REST surface for api-v1-clusters-cluster_id-networking-egress-rules-rule_id.
      operations:
      - method: GET
        name: getegressrule
        description: Get an egress rule
        call: cloud-egressrules.getegressrule
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: editegressrule
        description: Update an egress rule
        call: cloud-egressrules.editegressrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteegressrule
        description: Delete an egress rule
        call: cloud-egressrules.deleteegressrule
        with:
          idempotency_key: rest.idempotency_key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-egressrules-mcp
    port: 9090
    transport: http
    description: MCP adapter for CockroachDB Cloud API — EgressRules. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-egress-rules
      description: List egress rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-egressrules.listegressrules
      outputParameters:
      - type: object
        mapping: $.
    - name: add-egress-rule
      description: Add an egress rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-egressrules.addegressrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-egress-rule
      description: Get an egress rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-egressrules.getegressrule
      outputParameters:
      - type: object
        mapping: $.
    - name: update-egress-rule
      description: Update an egress rule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cloud-egressrules.editegressrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-egress-rule
      description: Delete an egress rule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cloud-egressrules.deleteegressrule
      with:
        idempotency_key: tools.idempotency_key
      outputParameters:
      - type: object
        mapping: $.