# 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 Schemas Service API
  version: 1.0.0
extends: openapi/canonical-schemasservice-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: 7
- target: $.paths['/api/v0/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity schemas
      effect: read
      questions:
      - Which identity schemas are defined in the Identity Platform?
      - Can I page through identity schemas a few at a time?
      instructions:
      - text: List all identity schemas.
      - text: List {size} identity schemas starting from page {page_token}.
        slots:
          size: query.size
          page_token: query.page_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity schema
      effect: write
      questions:
      - How do I add a new identity schema that defines user traits?
      - Can I choose the ID of a new identity schema myself?
      instructions:
      - text: Create identity schema {id} with definition {schema}.
        slots:
          id: requestBody.id
          schema: requestBody.schema
      - text: 'Add a new identity schema using this JSON schema: {schema}.'
        slots:
          schema: requestBody.schema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity schema
      effect: read
      questions:
      - What traits does a particular identity schema define?
      - Can I view the JSON of one identity schema by its ID?
      instructions:
      - text: Show identity schema {id}.
        slots:
          id: path.id
      - text: Get the JSON definition of schema {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity schema
      effect: destructive
      questions:
      - How do I delete an identity schema that's no longer used?
      - Can an identity schema be removed permanently?
      instructions:
      - text: Delete identity schema {id}.
        slots:
          id: path.id
      - text: Remove schema {id} from the Identity Platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an identity schema
      effect: write
      questions:
      - How do I change the definition of an existing identity schema?
      - Can I edit a schema's traits after identities already use it?
      instructions:
      - text: Update identity schema {id} to {schema}.
        slots:
          id: path.id
          schema: requestBody.schema
      - text: Patch schema {id} with a revised definition {schema}.
        slots:
          id: path.id
          schema: requestBody.schema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default identity schema
      effect: read
      questions:
      - Which identity schema is used by default for new identities?
      - What is the current default schema in the Identity Platform?
      instructions:
      - text: Show the default identity schema.
      - text: Tell me which schema new identities get by default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/schemas/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the default identity schema
      effect: write
      questions:
      - How do I switch which identity schema is the default?
      - Can I make a schema I just created the default for new identities?
      instructions:
      - text: Make schema {id} the default.
        slots:
          id: requestBody.id
      - text: Set the default identity schema to {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'