Heroku Platform API — Formation

naftiko: 1.0.0-alpha2
info:
  label: Heroku Platform API — Formation
  description: 'Heroku Platform API — Formation. 3 operations. Lead operation: List formation. Self-contained Naftiko capability
    covering one Heroku business surface.'
  tags:
  - Heroku
  - Formation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HEROKU_API_KEY: HEROKU_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-formation
    baseUri: https://api.heroku.com
    description: Heroku Platform API — Formation business capability. Self-contained, no shared references.
    resources:
    - name: apps-app_id_or_name-formation
      path: /apps/{app_id_or_name}/formation
      operations:
      - name: listformation
        method: GET
        description: List formation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: batchupdateformation
        method: PATCH
        description: Batch update formation
        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-formation-formation_id_or_type
      path: /apps/{app_id_or_name}/formation/{formation_id_or_type}
      operations:
      - name: updateformation
        method: PATCH
        description: Update a process type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: formation_id_or_type
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.HEROKU_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-formation-rest
    port: 8080
    description: REST adapter for Heroku Platform API — Formation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/apps/{app-id-or-name}/formation
      name: apps-app-id-or-name-formation
      description: REST surface for apps-app_id_or_name-formation.
      operations:
      - method: GET
        name: listformation
        description: List formation
        call: platform-formation.listformation
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: batchupdateformation
        description: Batch update formation
        call: platform-formation.batchupdateformation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apps/{app-id-or-name}/formation/{formation-id-or-type}
      name: apps-app-id-or-name-formation-formation-id-or-type
      description: REST surface for apps-app_id_or_name-formation-formation_id_or_type.
      operations:
      - method: PATCH
        name: updateformation
        description: Update a process type
        call: platform-formation.updateformation
        with:
          formation_id_or_type: rest.formation_id_or_type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-formation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Heroku Platform API — Formation. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-formation
      description: List formation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-formation.listformation
      outputParameters:
      - type: object
        mapping: $.
    - name: batch-update-formation
      description: Batch update formation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-formation.batchupdateformation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-process-type
      description: Update a process type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-formation.updateformation
      with:
        formation_id_or_type: tools.formation_id_or_type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.