API Evangelist conversational phrasing for Microsoft Purview Type API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Type API
  version: 1.0.0
extends: openapi/microsoft-purview-type-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: 8
- target: $.paths['/api/atlas/v2/types/typedefs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all type definitions
      effect: read
      questions:
      - What entity, classification and relationship types are defined in the catalog?
      - Can I include term templates when listing type definitions?
      instructions:
      - text: List all type definitions in full.
      - text: List full type definitions of kind {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedefs'].put
  update:
    x-apievangelist-phrasing:
      intent: Update type definitions in bulk
      effect: write
      questions:
      - How do I change several existing type definitions at once?
      - Can I update entity and classification definitions in one call?
      instructions:
      - text: Update existing entity type definitions {defs}.
        slots:
          defs: requestBody.entityDefs
      - text: Bulk update classification definitions {defs}.
        slots:
          defs: requestBody.classificationDefs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create type definitions in bulk
      effect: write
      questions:
      - How do I define custom entity types for the catalog?
      - Can I create classification and business metadata types together?
      instructions:
      - text: Create new entity type definitions {defs}.
        slots:
          defs: requestBody.entityDefs
      - text: Create business metadata definitions {defs}.
        slots:
          defs: requestBody.businessMetadataDefs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedefs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete type definitions in bulk
      effect: destructive
      questions:
      - Can I delete several custom type definitions at once?
      - How do I remove a batch of entity and enum types?
      instructions:
      - text: Delete the entity type definitions {defs}.
        slots:
          defs: requestBody.entityDefs
      - text: Bulk remove enum definitions {defs}.
        slots:
          defs: requestBody.enumDefs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedefs/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: List type definition headers
      effect: read
      questions:
      - Is there a lightweight list of type names and categories?
      - Can I get just the headers of every type definition?
      instructions:
      - text: List the headers of all type definitions.
      - text: List type headers of kind {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a type definition by GUID
      effect: read
      questions:
      - How do I look up a type definition when I only have its GUID?
      - What attributes does the type with a given GUID define?
      instructions:
      - text: Get the type definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show type {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a type definition by name
      effect: read
      questions:
      - What attributes does a named type like azure_sql_table have?
      - Can I fetch a type definition using its unique name?
      instructions:
      - text: Get the type definition named {name}.
        slots:
          name: path.name
      - text: Show the attributes of type {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/types/typedef/name/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a type definition by name
      effect: destructive
      questions:
      - Can I delete one custom type by its name?
      - What is the way to remove a single type definition?
      instructions:
      - text: Delete the type definition named {name}.
        slots:
          name: path.name
      - text: Remove custom type {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'