# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Platform Identities Service API
  version: 1.0.0
extends: openapi/canonical-identitiesservice-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['/api/v0/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List user identities
      effect: read
      questions:
      - Which user identities exist in the identity platform?
      - Can I find an identity by its credential identifier, like an email?
      instructions:
      - text: List identities, {size} per page.
        slots:
          size: query.size
      - text: Find the identity with credential identifier {credID}.
        slots:
          credID: query.credID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/identities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user identity
      effect: write
      questions:
      - How do I create a new user identity with traits like email and name?
      - Can I set credentials and recovery addresses when creating an identity?
      instructions:
      - text: Create an identity with traits {traits}.
        slots:
          traits: requestBody.traits
      - text: Create an identity using schema {schema_id} with traits {traits} in state {state}.
        slots:
          schema_id: requestBody.schema_id
          traits: requestBody.traits
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/identities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user identity
      effect: read
      questions:
      - What traits and state does a particular identity have?
      - Can I look up one identity by its id?
      instructions:
      - text: Show identity {id}.
        slots:
          id: path.id
      - text: Get the traits and metadata of identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/identities/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user identity
      effect: write
      questions:
      - How do I change a user's traits or deactivate their identity?
      - Can I update admin metadata on an existing identity?
      instructions:
      - text: Set the state of identity {id} to {state}.
        slots:
          id: path.id
          state: requestBody.state
      - text: Update identity {id} traits to {traits}.
        slots:
          id: path.id
          traits: requestBody.traits
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/identities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user identity
      effect: destructive
      questions:
      - How do I permanently delete a user identity?
      - Is removing an identity reversible?
      instructions:
      - text: Delete identity {id}.
        slots:
          id: path.id
      - text: Remove user identity {id} from the platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'