overlay: 1.0.0
info:
  title: API Evangelist enhancements for Form3 Public API
  version: 1.0.0
extends: openapi/form3-payments.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: form3
    x-apievangelist-family: payments
    x-apievangelist-json-api: true
    x-apievangelist-idempotency:
      mechanism: client-generated-resource-id
      conflict-status: 409
      note: >-
        Creates are idempotent via a client-supplied UUID id; a duplicate returns 409 with
        the stored resource (ApiErrorWithActualResource). No Idempotency-Key header.
    x-apievangelist-auth:
      types: [oauth2-client-credentials, http-message-signatures, mutual-tls]
      token-url: https://api.form3.tech/v1/oauth2/token
    x-apievangelist-events:
      surface: webhooks
      manage-path: /notification/subscriptions
    x-apievangelist-compliance: [SOC 2, ISO 27001, ISO 27017, ISO 27018, PSD2]
    x-apievangelist-schemes: [Faster Payments, Bacs, CHAPS, SEPA Credit Transfer,
      SEPA Instant, SEPA Direct Debit]