# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Entity Identities API
  version: 1.0.0
extends: openapi/methodfi-entity-identities-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/entities/{entityId}/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity records for an entity
      effect: read
      questions:
      - Which identity retrievals have been run on this person?
      - Can I list an entity's identity records in a date window?
      instructions:
      - text: List identity records for entity {entity}.
        slots:
          entity: path.entityId
      - text: Show identity records for entity {entity} between {from_date} and {to_date}.
        slots:
          entity: path.entityId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/identities'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve identity data for an entity
      effect: write
      questions:
      - How do I pull identity information for a person in Method?
      - Can I start a new identity retrieval for an entity?
      instructions:
      - text: Retrieve identity data for entity {entity}.
        slots:
          entity: path.entityId
      - text: Start an identity lookup on entity {entity}.
        slots:
          entity: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/identities/{idnId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one identity record
      effect: read
      questions:
      - What did a specific identity retrieval return?
      - Can I fetch an identity record by its ID?
      instructions:
      - text: Get identity record {identity} for entity {entity}.
        slots:
          identity: path.idnId
          entity: path.entityId
      - text: Show the result of identity retrieval {identity} on entity {entity}.
        slots:
          identity: path.idnId
          entity: path.entityId
      method: generated
      generated: '2026-10-01'