Metal API — Capacity

naftiko: 1.0.0-alpha2
info:
  label: Metal API — Capacity
  description: 'Metal API — Capacity. 6 operations. Lead operation: View capacity. Self-contained Naftiko capability covering
    one Equinix business surface.'
  tags:
  - Equinix
  - Capacity
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    EQUINIX_API_KEY: EQUINIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: metal-capacity
    baseUri: https://api.equinix.com/metal/v1
    description: Metal API — Capacity business capability. Self-contained, no shared references.
    resources:
    - name: capacity
      path: /capacity
      operations:
      - name: findcapacityforfacility
        method: GET
        description: View capacity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: checkcapacityforfacility
        method: POST
        description: Check capacity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: capacity-metros
      path: /capacity/metros
      operations:
      - name: findcapacityformetro
        method: GET
        description: View capacity for metros
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: checkcapacityformetro
        method: POST
        description: Check capacity for a metro
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-id-capacity
      path: /organizations/{id}/capacity
      operations:
      - name: findorganizationcapacityperfacility
        method: GET
        description: View available hardware plans per Facility for given organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Organization UUID
          required: true
    - name: organizations-id-capacity-metros
      path: /organizations/{id}/capacity/metros
      operations:
      - name: findorganizationcapacitypermetro
        method: GET
        description: View available hardware plans per Metro for given organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Organization UUID
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.EQUINIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: metal-capacity-rest
    port: 8080
    description: REST adapter for Metal API — Capacity. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/capacity
      name: capacity
      description: REST surface for capacity.
      operations:
      - method: GET
        name: findcapacityforfacility
        description: View capacity
        call: metal-capacity.findcapacityforfacility
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: checkcapacityforfacility
        description: Check capacity
        call: metal-capacity.checkcapacityforfacility
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/capacity/metros
      name: capacity-metros
      description: REST surface for capacity-metros.
      operations:
      - method: GET
        name: findcapacityformetro
        description: View capacity for metros
        call: metal-capacity.findcapacityformetro
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: checkcapacityformetro
        description: Check capacity for a metro
        call: metal-capacity.checkcapacityformetro
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{id}/capacity
      name: organizations-id-capacity
      description: REST surface for organizations-id-capacity.
      operations:
      - method: GET
        name: findorganizationcapacityperfacility
        description: View available hardware plans per Facility for given organization
        call: metal-capacity.findorganizationcapacityperfacility
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{id}/capacity/metros
      name: organizations-id-capacity-metros
      description: REST surface for organizations-id-capacity-metros.
      operations:
      - method: GET
        name: findorganizationcapacitypermetro
        description: View available hardware plans per Metro for given organization
        call: metal-capacity.findorganizationcapacitypermetro
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: metal-capacity-mcp
    port: 9090
    transport: http
    description: MCP adapter for Metal API — Capacity. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: view-capacity
      description: View capacity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-capacity.findcapacityforfacility
      outputParameters:
      - type: object
        mapping: $.
    - name: check-capacity
      description: Check capacity
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: metal-capacity.checkcapacityforfacility
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-capacity-metros
      description: View capacity for metros
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-capacity.findcapacityformetro
      outputParameters:
      - type: object
        mapping: $.
    - name: check-capacity-metro
      description: Check capacity for a metro
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: metal-capacity.checkcapacityformetro
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-available-hardware-plans-per
      description: View available hardware plans per Facility for given organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-capacity.findorganizationcapacityperfacility
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: view-available-hardware-plans-per-2
      description: View available hardware plans per Metro for given organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-capacity.findorganizationcapacitypermetro
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.