overlay: 1.0.0
info:
  title: API Evangelist enhancements for VaultRE Aggregator API v1.0
  version: 1.0.0
extends: openapi/vaultre-aggregator-api-v1-0-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-slug: vaultre
    x-apievangelist-enriched: '2026-07-26'
    x-apievangelist-source: https://docs.api.vaultre.com.au/swagger/index.html
    x-apievangelist-harvest: spec downloaded verbatim from the provider, HTTP 200, unmodified
- target: $.info
  update:
    x-access-model:
      pricing: unknown
      onboarding: approval
      trial: false
      public: false
      label: Public docs and specs, approval-gated keys
      steps:
      - Approved integrator registration (reviewed, ~2 business days) yields the X-Api-Key
      - Aggregator registration yields a CRM Key and a Secret Key (separate from core API access)
      signup: https://www.mrisoftware.com/au/products/vault/api-integrations/
- target: $.info
  update:
    x-rate-limits:
    - limit: 10
      unit: requests
      period: second
      scope: per API key
    - limit: 10000
      unit: requests
      period: day
      scope: per API key
      reset: 00:00 UTC
    x-rate-limit-status: 429
    x-rate-limit-docs: https://docs.api.vaultre.com.au/guide.html
- target: $.info
  update:
    x-error-envelope:
      schema: SuccessOrError
      media_type: application/json
      fields:
      - success
      - msg
      - code
      rfc9457: false
      artifact: errors/vaultre-problem-types.yml
- target: $.info
  update:
    x-idempotency:
      supported: false
      note: No Idempotency-Key header or parameter exists anywhere in this specification; retries of write
        operations are not deduplicated.
- target: $.info
  update:
    x-apievangelist-artifacts:
      authentication: authentication/vaultre-authentication.yml
      conventions: conventions/vaultre-conventions.yml
      errors: errors/vaultre-problem-types.yml
      lifecycle: lifecycle/vaultre-lifecycle.yml
      conformance: conformance/vaultre-conformance.yml
      data_model: data-model/vaultre-data-model.yml
      agentic_access: agentic-access/vaultre-agentic-access.yml
- target: $.info
  update:
    x-delivery-model:
      style: queued ingestion
      ack_status: 202
      errors: validation and processing errors are delivered asynchronously to an aggregator-nominated
        webhook URL, not on the request
      separate_from: the core VaultRE API
- target: $.components.securitySchemes
  update:
    x-apievangelist-note: 'Both credentials are required on every request: X-Api-Key identifies the integrator,
      Authorization: Bearer carries the per-account customer token (core API) or a self-signed HS512 JWT
      (integrator and aggregator surfaces).'