API Evangelist enhancements — Loops Transactional emails API

overlay: 1.0.0
info:
  title: API Evangelist enhancements — Loops Transactional emails API
  version: 1.0.0
  x-description: 'OpenAPI Overlay 1.0.0 capturing the enhancements API Evangelist derived for the Loops Transactional emails API. It does NOT modify the provider contract on disk: openapi/loops-transactional-emails-api-openapi.yml is saved verbatim from https://app.loops.so/openapi.json and this overlay is applied on top. Everything added here is sourced from Loops'' own published documentation — the rate-limit tiers and response headers from https://loops.so/docs/api-reference/intro, the error envelope from the spec''s own 4xx schemas, and the Idempotency-Key contract from the header parameter Loops declares on its two send operations. Nothing is invented.'
extends: loops-transactional-emails-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: https://loops.so/docs/api-reference/intro + openapi/_original/loops-openapi.yaml (1.21.6)
actions:
- target: $.info
  description: Attach the public documentation and machine-readable contract locations, which the source document omits.
  update:
    contact:
      name: Loops Support
      url: https://app.loops.so/settings?page=support
      email: help@loops.so
    termsOfService: https://loops.so/terms
    x-api-evangelist:
      provider: loops
      artifact-set: https://github.com/api-evangelist/loops
- target: $
  description: Add externalDocs pointing at the Loops API reference and the canonical published spec.
  update:
    externalDocs:
      description: Loops API reference
      url: https://loops.so/docs/api-reference/intro
- target: $.paths['/transactional'].post
  description: Annotate sendTransactionalEmail with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope and idempotency contract).
  update:
    x-rate-limit:
      limit: 10
      window: 1s
      scope: team
      tier: default
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
    x-idempotency:
      header: Idempotency-Key
      max_length: 100
      retention: 24h
      replay_status: 409
      semantics: Replay protection only — a reused key returns 409 Conflict and does not replay the original response body.
- target: $.paths['/transactional'].get
  description: Annotate listPublishedTransactionalEmails with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 10
      window: 1s
      scope: team
      tier: default
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails'].get
  description: Annotate listTransactionalEmails with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails'].post
  description: Annotate createTransactionalEmail with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails/{transactionalId}'].get
  description: Annotate getTransactionalEmail with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails/{transactionalId}'].post
  description: Annotate updateTransactionalEmail with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails/{transactionalId}/draft'].post
  description: Annotate ensureTransactionalDraft with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false
- target: $.paths['/transactional-emails/{transactionalId}/publish'].post
  description: Annotate publishTransactionalEmail with the published runtime semantics (rate limit tier, rate-limit response headers, error envelope).
  update:
    x-rate-limit:
      limit: 60
      window: 60s
      scope: team
      tier: content-api
    x-rate-limit-headers:
    - x-ratelimit-limit
    - x-ratelimit-remaining
    x-error-envelope:
      format: proprietary-json
      fields:
      - success
      - message
      deprecated_fields:
      - error
      - path
      rfc9457: false