API Evangelist authentication overlay for Rutter Configs API (webhook configuration)

overlay: 1.0.0
info:
  title: API Evangelist authentication overlay for Rutter Configs API (webhook configuration)
  version: 1.0.0
  x-provenance:
    generated: '2026-11-05'
    method: derived
    source:
    - https://docs.rutter.com/rest/2024-08-31/basics#authorization
    - authentication/rutter-authentication.yml
    note: The published contract declares no securitySchemes; this overlay adds the HTTP Basic + access_token query scheme
      the documentation describes and the X-Rutter-Version header requirement. It never mutates openapi/ files.
extends: openapi/rutter-configs-api-openapi.yml
actions:
- target: $.components
  update:
    securitySchemes:
      basicAuth:
        type: http
        scheme: basic
        description: client_id as username, client_secret as password (dashboard, per environment). https://docs.rutter.com/rest/2024-08-31/basics#authorization
      accessToken:
        type: apiKey
        in: query
        name: access_token
        description: Connection-scoped token obtained from exchangeToken (POST /item/public_token/exchange).
- target: $
  update:
    security:
    - basicAuth: []
    x-apievangelist:
      versioning_header:
        name: X-Rutter-Version
        required: true
        values:
        - '2024-08-31'
        - '2024-04-30'
        - '2023-03-14'
        - '2023-02-07'
      idempotency_header:
        name: Idempotency-Key
        applies_to: POST and PATCH
        docs: https://docs.rutter.com/implementation-guides/making-idempotent-requests