# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies Institutions API
  version: 1.0.0
extends: openapi/mx-technologies-institutions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/institutions'].get
  update:
    x-apievangelist-phrasing:
      intent: Search institutions by name or capability
      effect: read
      questions:
      - Which banks can I connect to, and can I search them by name?
      - Can I find only institutions that support account verification or statements?
      - Can I narrow the institution search to one country?
      instructions:
      - text: Search institutions named {name}.
        slots:
          name: query.name
      - text: List institutions in {country} that support transaction history.
        slots:
          country: query.iso_country_code
      - text: Find institutions where account verification support is {supports_verification}.
        slots:
          supports_verification: query.supports_account_verification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/institutions/favorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorite institutions
      effect: read
      questions:
      - Which institutions have been set as our favorites, sorted by popularity?
      - Can I limit our favorite institutions list to a country?
      instructions:
      - text: List our favorite institutions.
      - text: Show favorite institutions in country {country}.
        slots:
          country: query.iso_country_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/institutions/{institution_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one institution by code
      effect: read
      questions:
      - What details does MX have on a specific institution code?
      - Can I look up an institution's name and URL from its code?
      instructions:
      - text: Get institution {institution_code}.
        slots:
          institution_code: path.institution_code
      - text: Show details for the bank with code {institution_code}.
        slots:
          institution_code: path.institution_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/institutions/{institution_code}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List login fields for an institution code
      effect: read
      questions:
      - What login fields does a user need to fill in to connect to a given institution code?
      - Does an invalid institution code return a 404 on the credentials lookup?
      instructions:
      - text: List required credentials for institution code {institution_code}.
        slots:
          institution_code: path.institution_code
      - text: Show the login fields needed to create a member at {institution_code}.
        slots:
          institution_code: path.institution_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/institutions/{institution_identifier}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List institution login fields (versioned)
      effect: read
      questions:
      - On the versioned API, which credentials do I collect before connecting to an institution identifier?
      - Can I look up required credential fields using an institution identifier and Accept-Version?
      instructions:
      - text: List credentials for institution {institution} on API version {api_version}.
        slots:
          institution: path.institution_identifier
          api_version: header.Accept-Version
      - text: Show the fields a user must enter for institution identifier {institution}.
        slots:
          institution: path.institution_identifier
      method: generated
      generated: '2026-09-26'