Metal API — Memberships

naftiko: 1.0.0-alpha2
info:
  label: Metal API — Memberships
  description: 'Metal API — Memberships. 3 operations. Lead operation: Delete the membership. Self-contained Naftiko capability
    covering one Equinix business surface.'
  tags:
  - Equinix
  - Memberships
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    EQUINIX_API_KEY: EQUINIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: metal-memberships
    baseUri: https://api.equinix.com/metal/v1
    description: Metal API — Memberships business capability. Self-contained, no shared references.
    resources:
    - name: memberships-id
      path: /memberships/{id}
      operations:
      - name: deletemembership
        method: DELETE
        description: Delete the membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Membership UUID
          required: true
      - name: findmembershipbyid
        method: GET
        description: Retrieve a membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Membership UUID
          required: true
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full
      - name: updatemembership
        method: PUT
        description: Update the membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Membership UUID
          required: true
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.EQUINIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: metal-memberships-rest
    port: 8080
    description: REST adapter for Metal API — Memberships. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/memberships/{id}
      name: memberships-id
      description: REST surface for memberships-id.
      operations:
      - method: DELETE
        name: deletemembership
        description: Delete the membership
        call: metal-memberships.deletemembership
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: findmembershipbyid
        description: Retrieve a membership
        call: metal-memberships.findmembershipbyid
        with:
          id: rest.id
          include: rest.include
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemembership
        description: Update the membership
        call: metal-memberships.updatemembership
        with:
          id: rest.id
          include: rest.include
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: metal-memberships-mcp
    port: 9090
    transport: http
    description: MCP adapter for Metal API — Memberships. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: delete-membership
      description: Delete the membership
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: metal-memberships.deletemembership
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-membership
      description: Retrieve a membership
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-memberships.findmembershipbyid
      with:
        id: tools.id
        include: tools.include
      outputParameters:
      - type: object
        mapping: $.
    - name: update-membership
      description: Update the membership
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: metal-memberships.updatemembership
      with:
        id: tools.id
        include: tools.include
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.