Heroku Platform API — Collaborators

naftiko: 1.0.0-alpha2
info:
  label: Heroku Platform API — Collaborators
  description: 'Heroku Platform API — Collaborators. 3 operations. Lead operation: List collaborators. Self-contained Naftiko
    capability covering one Heroku business surface.'
  tags:
  - Heroku
  - Collaborators
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HEROKU_API_KEY: HEROKU_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-collaborators
    baseUri: https://api.heroku.com
    description: Heroku Platform API — Collaborators business capability. Self-contained, no shared references.
    resources:
    - name: apps-app_id_or_name-collaborators
      path: /apps/{app_id_or_name}/collaborators
      operations:
      - name: listcollaborators
        method: GET
        description: List collaborators
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcollaborator
        method: POST
        description: Create a collaborator
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: apps-app_id_or_name-collaborators-collaborator_email_or_id
      path: /apps/{app_id_or_name}/collaborators/{collaborator_email_or_id}
      operations:
      - name: deletecollaborator
        method: DELETE
        description: Delete a collaborator
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collaborator_email_or_id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.HEROKU_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-collaborators-rest
    port: 8080
    description: REST adapter for Heroku Platform API — Collaborators. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/apps/{app-id-or-name}/collaborators
      name: apps-app-id-or-name-collaborators
      description: REST surface for apps-app_id_or_name-collaborators.
      operations:
      - method: GET
        name: listcollaborators
        description: List collaborators
        call: platform-collaborators.listcollaborators
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcollaborator
        description: Create a collaborator
        call: platform-collaborators.createcollaborator
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apps/{app-id-or-name}/collaborators/{collaborator-email-or-id}
      name: apps-app-id-or-name-collaborators-collaborator-email-or-id
      description: REST surface for apps-app_id_or_name-collaborators-collaborator_email_or_id.
      operations:
      - method: DELETE
        name: deletecollaborator
        description: Delete a collaborator
        call: platform-collaborators.deletecollaborator
        with:
          collaborator_email_or_id: rest.collaborator_email_or_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-collaborators-mcp
    port: 9090
    transport: http
    description: MCP adapter for Heroku Platform API — Collaborators. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-collaborators
      description: List collaborators
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-collaborators.listcollaborators
      outputParameters:
      - type: object
        mapping: $.
    - name: create-collaborator
      description: Create a collaborator
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-collaborators.createcollaborator
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-collaborator
      description: Delete a collaborator
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-collaborators.deletecollaborator
      with:
        collaborator_email_or_id: tools.collaborator_email_or_id
      outputParameters:
      - type: object
        mapping: $.