# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Azure Analytics Purview Data Map Atlas API
  version: 1.0.0
extends: openapi/microsoft-azure-atlas-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: 89
- target: $.paths['/atlas/v2/entity'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a single data map entity
      effect: write
      questions:
      - How do I register one asset, like a hive table, in the Purview Data Map?
      - Will posting an entity with an existing qualifiedName update it instead of creating a duplicate?
      - Can I move an entity into a different collection while I create or update it?
      instructions:
      - text: 'Create or update this single entity in the data map: {entity}.'
        slots:
          entity: requestBody.entity
      - text: Upsert entity {entity} and place it in collection {collection_id}.
        slots:
          entity: requestBody.entity
          collection_id: query.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several entities by their GUIDs
      effect: read
      questions:
      - Can I pull the full definitions of several data map entities at once if I have their GUIDs?
      - Is there a way to fetch a batch of entities without their relationship attributes?
      instructions:
      - text: Fetch the entities with GUIDs {guids} from the data map.
        slots:
          guids: query.guid
      - text: Get entities {guids} in bulk with minimal info for referred entities and relationships ignored.
        slots:
          guids: query.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many entities in one call
      effect: write
      questions:
      - How do I load a whole batch of assets into the Purview Data Map in one request?
      - Can a bulk entity upsert also move all those entities into a target collection?
      instructions:
      - text: 'Bulk create or update these entities in the data map: {entities}.'
        slots:
          entities: requestBody.entities
      - text: Upsert the entity list {entities} in bulk and move them to collection {collection_id}.
        slots:
          entities: requestBody.entities
          collection_id: query.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many entities by GUID
      effect: destructive
      questions:
      - Can I remove several assets from the data map at once using their GUIDs?
      - What happens when I bulk delete a list of catalog entities?
      instructions:
      - text: Delete the entities with GUIDs {guids} from the data map in one call.
        slots:
          guids: query.guid
      - text: Bulk remove catalog assets {guids}.
        slots:
          guids: query.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk/classification'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply one classification to many entities
      effect: write
      questions:
      - How do I tag a single classification like PII onto a whole list of entities at once?
      - Can one classification be associated with multiple entity GUIDs in the same request?
      instructions:
      - text: Apply classification {classification} to entities {entity_guids}.
        slots:
          classification: requestBody.classification
          entity_guids: requestBody.entityGuids
      - text: Associate the classification {classification} with every entity in {entity_guids} in bulk.
        slots:
          classification: requestBody.classification
          entity_guids: requestBody.entityGuids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk/setClassifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Set classifications on entities in bulk
      effect: write
      questions:
      - Can I set different classifications on many entities with one GUID-to-header map?
      - Which call sets classifications across a batch of entities keyed by GUID?
      instructions:
      - text: Set classifications on entities in bulk using the GUID header map {guid_header_map}.
        slots:
          guid_header_map: requestBody.guidHeaderMap
      - text: Apply per-entity classification sets from {guid_header_map}.
        slots:
          guid_header_map: requestBody.guidHeaderMap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several entities of a type by unique attributes
      effect: read
      questions:
      - How can I look up multiple entities of one type by their qualified names in bulk?
      - Is there a bulk lookup that uses unique attributes instead of GUIDs?
      instructions:
      - text: Get the {type_name} entities whose qualified names are {qualified_name} in bulk.
        slots:
          type_name: path.typeName
          qualified_name: query.attr_N:qualifiedName
      - text: Bulk fetch {type_name} entities by unique attribute, ignoring relationships.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/businessmetadata/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import business metadata definitions from a file
      effect: write
      questions:
      - How do I bulk create business metadata by uploading a file?
      - Can I import business metadata attributes into the data map from a template file?
      instructions:
      - text: Upload {file} to create business metadata in bulk.
        slots:
          file: formData.file
      - text: Import the business metadata file {file} into the data map.
        slots:
          file: formData.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/businessmetadata/import/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the business metadata import template
      effect: read
      questions:
      - Where can I get a sample template for bulk uploading business metadata?
      - What format does the business metadata import file need to follow?
      instructions:
      - text: Download the sample business metadata import template.
      - text: Get me the template file I should fill in before a bulk business metadata upload.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity's full definition by GUID
      effect: read
      questions:
      - How do I see everything the data map knows about one asset if I have its GUID?
      - Can I read an entity's complete definition without pulling its relationship attributes?
      instructions:
      - text: Show the complete definition of entity {guid}.
        slots:
          guid: path.guid
      - text: Get entity {guid} with relationships ignored and minimal referred-entity info.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one attribute of an entity by GUID
      effect: write
      questions:
      - Can I change just one primitive attribute on an entity without resending the whole thing?
      - Does a single-attribute update by GUID support arrays or maps?
      instructions:
      - text: Set attribute {attribute_name} on entity {guid}.
        slots:
          attribute_name: query.name
          guid: path.guid
      - text: Update only the {attribute_name} attribute of the entity with GUID {guid}.
        slots:
          attribute_name: query.name
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entity by GUID
      effect: destructive
      questions:
      - How do I delete a single asset from the Purview Data Map by its GUID?
      - Can I remove one catalog entity if I know its GUID?
      instructions:
      - text: Delete entity {guid} from the data map.
        slots:
          guid: path.guid
      - text: Remove the single catalog asset with GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/businessmetadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Add business metadata to an entity
      effect: write
      questions:
      - How do I attach business metadata to an asset in the data map?
      - Can I overwrite all existing business metadata on an entity instead of merging?
      instructions:
      - text: Add business metadata to entity {guid}.
        slots:
          guid: path.guid
      - text: Replace the business metadata on entity {guid}, overwriting what is there.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/businessmetadata'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove business metadata from an entity
      effect: destructive
      questions:
      - How do I strip business metadata off an entity?
      - Can I clear the business metadata sets attached to one asset?
      instructions:
      - text: Remove business metadata from entity {guid}.
        slots:
          guid: path.guid
      - text: Clear the business metadata sets on the asset with GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set attributes of one business metadata set on an entity
      effect: write
      questions:
      - Can I update the attributes of just one named business metadata set on an entity?
      - How do I fill in attribute values for a specific business metadata definition on an asset?
      instructions:
      - text: Add or update the {business_metadata_name} attributes on entity {guid}.
        slots:
          business_metadata_name: path.businessMetadataName
          guid: path.guid
      - text: Set values for business metadata {business_metadata_name} on asset {guid}.
        slots:
          business_metadata_name: path.businessMetadataName
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete attributes of one business metadata set
      effect: destructive
      questions:
      - How do I delete the attributes of one named business metadata set from an entity?
      - Can I remove a single business metadata group from an asset and keep the others?
      instructions:
      - text: Delete the {business_metadata_name} attributes from entity {guid}.
        slots:
          business_metadata_name: path.businessMetadataName
          guid: path.guid
      - text: Remove business metadata set {business_metadata_name} values from asset {guid}.
        slots:
          business_metadata_name: path.businessMetadataName
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/classification/{classificationName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one classification on an entity
      effect: read
      questions:
      - Is a specific classification applied to this entity, and what are its details?
      - How do I read a single named classification on an asset by GUID?
      instructions:
      - text: Get classification {classification_name} on entity {guid}.
        slots:
          classification_name: path.classificationName
          guid: path.guid
      - text: Show the {classification_name} classification details for asset {guid}.
        slots:
          classification_name: path.classificationName
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/classification/{classificationName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a classification from an entity by GUID
      effect: destructive
      questions:
      - How do I take a classification off an asset when I have its GUID?
      - Can I delete one specific classification from an entity identified by GUID?
      instructions:
      - text: Remove classification {classification_name} from entity {guid}.
        slots:
          classification_name: path.classificationName
          guid: path.guid
      - text: Delete the {classification_name} tag from the asset with GUID {guid}.
        slots:
          classification_name: path.classificationName
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/classifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List all classifications on an entity
      effect: read
      questions:
      - Which classifications are currently applied to this asset?
      - How do I list every classification on an entity by its GUID?
      instructions:
      - text: List the classifications on entity {guid}.
        slots:
          guid: path.guid
      - text: Show all classification tags applied to asset {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/classifications'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing classifications on an entity by GUID
      effect: write
      questions:
      - Can I change the details of classifications already applied to an entity?
      - How do I edit existing classifications on an asset identified by GUID?
      instructions:
      - text: Update the existing classifications on entity {guid}.
        slots:
          guid: path.guid
      - text: Modify the classifications already applied to asset {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/classifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Add classifications to an entity by GUID
      effect: write
      questions:
      - How do I add new classifications to a single asset by GUID?
      - Can I attach several classifications to one entity in one call?
      instructions:
      - text: Add classifications to entity {guid}.
        slots:
          guid: path.guid
      - text: Attach new classification tags to the asset with GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/header'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity's header summary
      effect: read
      questions:
      - Can I get just the lightweight header of an entity instead of its full definition?
      - What summary info comes back in an entity header?
      instructions:
      - text: Get the header for entity {guid}.
        slots:
          guid: path.guid
      - text: Show the short header summary of asset {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Add labels to an entity by GUID
      effect: write
      questions:
      - How do I add labels to an asset without removing the ones already on it?
      - Can I append labels to an entity using its GUID?
      instructions:
      - text: Add labels to entity {guid}, keeping its existing labels.
        slots:
          guid: path.guid
      - text: Append new labels to the asset with GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace the labels on an entity by GUID
      effect: write
      questions:
      - How do I overwrite the full label set on an entity by GUID?
      - Can I set an asset's labels to exactly a given list?
      instructions:
      - text: Set the labels on entity {guid} to exactly the given list.
        slots:
          guid: path.guid
      - text: Replace every label on asset {guid} with the new label set.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/guid/{guid}/labels'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove labels from an entity by GUID
      effect: destructive
      questions:
      - How do I delete specific labels from an entity by GUID?
      - Can I strip certain labels off an asset and leave the rest?
      instructions:
      - text: Remove the given labels from entity {guid}.
        slots:
          guid: path.guid
      - text: Delete selected labels on the asset with GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity by type and qualified name
      effect: read
      questions:
      - How do I find an asset when I know its type and qualifiedName but not its GUID?
      - Can I read an entity's full definition using a unique attribute lookup?
      instructions:
      - text: Get the {type_name} entity whose qualified name is {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Look up the full definition of {type_name} asset {qualified_name} by unique attribute.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Partially update an entity by type and qualified name
      effect: write
      questions:
      - Can I update a subset of an entity's attributes using its qualifiedName instead of GUID?
      - What is the way to patch an asset identified by type and unique attribute?
      instructions:
      - text: Update {type_name} entity {qualified_name} with attributes from {entity}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
          entity: requestBody.entity
      - text: Patch a subset of attributes on {type_name} asset {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entity by type and qualified name
      effect: destructive
      questions:
      - How do I delete an asset when I only know its type and qualifiedName?
      - Can an entity be removed by unique attribute rather than GUID?
      instructions:
      - text: Delete the {type_name} entity with qualified name {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Remove {type_name} asset {qualified_name} from the data map by unique attribute.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a classification from an entity by qualified name
      effect: destructive
      questions:
      - How do I remove a classification from an asset I identify by qualifiedName?
      - Can I untag a classification using type and unique attribute instead of GUID?
      instructions:
      - text: Using its qualified name {qualified_name}, untag classification {classification_name} from that {type_name} asset.
        slots:
          classification_name: path.classificationName
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Untag {classification_name} from the {type_name} asset found by unique attribute.
        slots:
          classification_name: path.classificationName
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications'].put
  update:
    x-apievangelist-phrasing:
      intent: Update classifications on an entity by qualified name
      effect: write
      questions:
      - Can I edit an asset's existing classifications when I know its qualifiedName?
      - How do I change classification details on an entity looked up by unique attribute?
      instructions:
      - text: Update the classifications on {type_name} entity {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Modify existing classification tags on the {type_name} asset found by qualified name.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Add classifications to an entity by qualified name
      effect: write
      questions:
      - How do I classify an asset I identify by type and qualifiedName?
      - Can I add a classification without first looking up the entity's GUID?
      instructions:
      - text: Classify the {type_name} asset whose qualified name is {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Attach new classification tags to the {type_name} asset matched by unique attribute.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Add labels to an entity by qualified name
      effect: write
      questions:
      - How do I append labels to an asset identified by its qualifiedName?
      - If I send an empty label list when adding by unique attribute, does anything change?
      instructions:
      - text: Add labels to {type_name} entity {qualified_name}, keeping existing ones.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Append labels to the {type_name} asset matched by unique attribute.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace labels on an entity by qualified name
      effect: write
      questions:
      - How do I overwrite all labels on an asset I find by type and qualifiedName?
      - Will setting an empty label list by unique attribute clear every existing label?
      instructions:
      - text: Overwrite all labels on the {type_name} asset with qualified name {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Replace every label on the {type_name} asset matched by qualified name.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove labels from an entity by qualified name
      effect: destructive
      questions:
      - How do I delete labels from an asset identified by qualifiedName?
      - What happens if I ask to remove labels that are not on the entity?
      instructions:
      - text: Delete labels from the {type_name} asset whose qualified name is {qualified_name}.
        slots:
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Strip selected labels off the {type_name} asset found by unique attribute.
        slots:
          type_name: path.typeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary'].get
  update:
    x-apievangelist-phrasing:
      intent: List all glossaries
      effect: read
      questions:
      - Which business glossaries exist in my Purview account?
      - Can I page through glossaries and skip loading their terms and categories?
      instructions:
      - text: List all glossaries.
      - text: List {limit} glossaries starting at offset {offset}, without terms and categories.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary
      effect: write
      questions:
      - How do I create a new business glossary in the data map?
      - Can I set a short and long description when I create a glossary?
      instructions:
      - text: Create a glossary named {name}.
        slots:
          name: requestBody.name
      - text: Create glossary {name} with short description {short_description} and language {language}.
        slots:
          name: requestBody.name
          short_description: requestBody.shortDescription
          language: requestBody.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary by GUID
      effect: read
      questions:
      - How do I look up one glossary by its GUID?
      - What basic details are returned for a single glossary?
      instructions:
      - text: Get glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      - text: Show the basic details of the glossary with GUID {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a glossary in full
      effect: write
      questions:
      - How do I replace a glossary's name and descriptions in one full update?
      - Can a full glossary update skip rewriting its terms and categories?
      instructions:
      - text: Update glossary {glossary_id} with name {name} and long description {long_description}.
        slots:
          glossary_id: path.glossaryId
          name: requestBody.name
          long_description: requestBody.longDescription
      - text: Fully replace the definition of glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary and its terms
      effect: destructive
      questions:
      - Does deleting a glossary also delete all its terms and categories?
      - How do I remove a whole business glossary?
      instructions:
      - text: Delete glossary {glossary_id} along with its terms and categories.
        slots:
          glossary_id: path.glossaryId
      - text: Remove the entire glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a glossary's categories in full
      effect: read
      questions:
      - What categories belong to a given glossary, with full details?
      - Can I page through a glossary's categories with limit and offset?
      instructions:
      - text: List the categories in glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      - text: Get {limit} full category records from glossary {glossary_id} starting at {offset}.
        slots:
          limit: query.limit
          glossary_id: path.glossaryId
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/categories/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: List category headers of a glossary
      effect: read
      questions:
      - Can I get just lightweight category headers for a glossary instead of full records?
      - Is there a quick way to list category names and GUIDs in a glossary?
      instructions:
      - text: List the category headers in glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      - text: Get only header info for categories of glossary {glossary_id}, sorted by {sort}.
        slots:
          glossary_id: path.glossaryId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/detailed'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary with full term and category detail
      effect: read
      questions:
      - Can I fetch a glossary together with all its term and category details in one response?
      - Why is the detailed glossary view not recommended for large glossaries?
      instructions:
      - text: Get glossary {glossary_id} with detailed term and category information.
        slots:
          glossary_id: path.glossaryId
      - text: Show the expanded, detailed view of glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/partial'].put
  update:
    x-apievangelist-phrasing:
      intent: Partially update a glossary's descriptions
      effect: write
      questions:
      - Which glossary fields can I change with a partial update?
      - Can I just edit a glossary's usage or language without a full replace?
      instructions:
      - text: Partially update glossary {glossary_id}, changing only its descriptions.
        slots:
          glossary_id: path.glossaryId
      - text: Patch the usage and language fields of glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List a glossary's terms in full
      effect: read
      questions:
      - What terms are defined in a particular glossary?
      - Can I paginate the full term records of a glossary?
      instructions:
      - text: List the terms in glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      - text: Get {limit} full term records from glossary {glossary_id} starting at {offset}.
        slots:
          limit: query.limit
          glossary_id: path.glossaryId
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/{glossaryId}/terms/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: List term headers of a glossary
      effect: read
      questions:
      - Can I list just the term headers of a glossary to keep the response small?
      - Is there a lightweight listing of glossary term names and GUIDs?
      instructions:
      - text: List the term headers in glossary {glossary_id}.
        slots:
          glossary_id: path.glossaryId
      - text: Get only header info for terms of glossary {glossary_id}, sorted by {sort}.
        slots:
          glossary_id: path.glossaryId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create glossary categories in bulk
      effect: write
      questions:
      - How do I create many glossary categories in a single request?
      - Is there a bulk endpoint for adding categories to glossaries?
      instructions:
      - text: Create these glossary categories in bulk.
      - text: Bulk add a batch of new categories to my glossaries.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary category
      effect: write
      questions:
      - How do I add one category to a glossary?
      - Can I nest a new category under a parent category when I create it?
      instructions:
      - text: Create a glossary category named {name} anchored to glossary {anchor}.
        slots:
          name: requestBody.name
          anchor: requestBody.anchor
      - text: Create category {name} under parent category {parent_category}.
        slots:
          name: requestBody.name
          parent_category: requestBody.parentCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary category by GUID
      effect: read
      questions:
      - How do I read one glossary category by its GUID?
      - What does a single category record include, like parent and child categories?
      instructions:
      - text: Get glossary category {category_id}.
        slots:
          category_id: path.categoryId
      - text: Show the details of category {category_id}.
        slots:
          category_id: path.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a glossary category in full
      effect: write
      questions:
      - How do I fully replace a glossary category's definition?
      - Can I change a category's parent or terms with a full category update?
      instructions:
      - text: Update category {category_id} with name {name}.
        slots:
          category_id: path.categoryId
          name: requestBody.name
      - text: Move category {category_id} under parent category {parent_category}.
        slots:
          category_id: path.categoryId
          parent_category: requestBody.parentCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary category
      effect: destructive
      questions:
      - How do I delete a category from a glossary?
      - Can I remove a glossary category by its GUID?
      instructions:
      - text: Delete glossary category {category_id}.
        slots:
          category_id: path.categoryId
      - text: Remove the category with GUID {category_id}.
        slots:
          category_id: path.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}/partial'].put
  update:
    x-apievangelist-phrasing:
      intent: Partially update a category's descriptions
      effect: write
      questions:
      - Can I edit only a category's short or long description?
      - Which category fields does a partial category update accept?
      instructions:
      - text: Partially update category {category_id}, changing only its descriptions.
        slots:
          category_id: path.categoryId
      - text: Patch the short description of category {category_id}.
        slots:
          category_id: path.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}/related'].get
  update:
    x-apievangelist-phrasing:
      intent: List a category's parent and child categories
      effect: read
      questions:
      - How do I see the parent and children of a glossary category?
      - Do limit and offset work when listing related categories?
      instructions:
      - text: List the categories related to category {category_id}.
        slots:
          category_id: path.categoryId
      - text: Show the parent and child categories of {category_id}.
        slots:
          category_id: path.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/category/{categoryId}/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List the terms in a category
      effect: read
      questions:
      - Which glossary terms are filed under a given category?
      - Can I page through the terms assigned to one category?
      instructions:
      - text: List the terms in category {category_id}.
        slots:
          category_id: path.categoryId
      - text: Get {limit} terms associated with category {category_id}.
        slots:
          limit: query.limit
          category_id: path.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/term'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary term
      effect: write
      questions:
      - How do I add a new business term to a glossary?
      - Can I set synonyms, an abbreviation and a status when creating a term?
      instructions:
      - text: Create a glossary term named {name} in glossary {anchor}.
        slots:
          name: requestBody.name
          anchor: requestBody.anchor
      - text: Create term {name} with abbreviation {abbreviation} and status {status}.
        slots:
          name: requestBody.name
          abbreviation: requestBody.abbreviation
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/term/{termId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary term by GUID
      effect: read
      questions:
      - How do I read the definition of one glossary term?
      - What details come back for a single term, like synonyms and assigned entities?
      instructions:
      - text: Get glossary term {term_id}.
        slots:
          term_id: path.termId
      - text: Show the full definition of term {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/term/{termId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a glossary term in full
      effect: write
      questions:
      - How do I fully replace a glossary term's definition?
      - Can I change a term's synonyms or categories with a full term update?
      instructions:
      - text: Update term {term_id} with name {name} and long description {long_description}.
        slots:
          term_id: path.termId
          name: requestBody.name
          long_description: requestBody.longDescription
      - text: Set the synonyms of term {term_id} to {synonyms}.
        slots:
          term_id: path.termId
          synonyms: requestBody.synonyms
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/term/{termId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary term
      effect: destructive
      questions:
      - How do I delete a term from a glossary?
      - Can I remove a glossary term by GUID?
      instructions:
      - text: Delete glossary term {term_id}.
        slots:
          term_id: path.termId
      - text: Remove the term with GUID {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/term/{termId}/partial'].put
  update:
    x-apievangelist-phrasing:
      intent: Partially update a term's description or status
      effect: write
      questions:
      - Can I change just a term's status or abbreviation without a full update?
      - Which term fields does a partial term update support?
      instructions:
      - text: Partially update term {term_id}, changing only its status.
        slots:
          term_id: path.termId
      - text: Patch the usage and abbreviation of term {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create glossary terms in bulk
      effect: write
      questions:
      - How do I import many glossary terms in a single request?
      - Can a bulk term create also return the term hierarchy?
      instructions:
      - text: Create these glossary terms in bulk.
      - text: Bulk add a batch of new terms and include the term hierarchy in the response.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/terms/{termId}/assignedEntities'].get
  update:
    x-apievangelist-phrasing:
      intent: List assets assigned a glossary term
      effect: read
      questions:
      - Which data assets are tagged with a particular glossary term?
      - Can I page through the entities assigned to a term?
      instructions:
      - text: List the entities assigned term {term_id}.
        slots:
          term_id: path.termId
      - text: Show {limit} assets tagged with term {term_id}.
        slots:
          limit: query.limit
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/terms/{termId}/assignedEntities'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a glossary term to assets
      effect: write
      questions:
      - How do I tag a list of data assets with a business glossary term?
      - Is it better to assign a term to entities in small batches?
      instructions:
      - text: Assign term {term_id} to the listed entities.
        slots:
          term_id: path.termId
      - text: Tag these assets with glossary term {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/terms/{termId}/assignedEntities'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a glossary term from assets
      effect: destructive
      questions:
      - How do I remove a glossary term from assets it was assigned to?
      - Can I untag several entities from one term at once?
      instructions:
      - text: Remove the assignment of term {term_id} from the listed entities.
        slots:
          term_id: path.termId
      - text: Untag these assets from glossary term {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/glossary/terms/{termId}/related'].get
  update:
    x-apievangelist-phrasing:
      intent: List terms related to a term
      effect: read
      questions:
      - What other glossary terms are related to this one, such as synonyms or see-also terms?
      - Do pagination parameters work when listing related terms?
      instructions:
      - text: List the terms related to term {term_id}.
        slots:
          term_id: path.termId
      - text: Show synonyms, antonyms and other related terms for {term_id}.
        slots:
          term_id: path.termId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/lineage/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lineage of an entity by GUID
      effect: read
      questions:
      - Where does this dataset's data come from and where does it flow to?
      - Can I limit how many hops of lineage come back for an asset?
      instructions:
      - text: Get the {direction} lineage of entity {guid}.
        slots:
          direction: query.direction
          guid: path.guid
      - text: Show lineage for asset {guid} going {direction} to a depth of {depth}.
        slots:
          guid: path.guid
          direction: query.direction
          depth: query.depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/lineage/uniqueAttribute/type/{typeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lineage of an entity by qualified name
      effect: read
      questions:
      - How do I trace lineage for an asset I know only by type and qualifiedName?
      - Can I get upstream lineage without looking up the entity GUID first?
      instructions:
      - text: Trace {direction} lineage for the {type_name} asset with qualified name {qualified_name}.
        slots:
          direction: query.direction
          type_name: path.typeName
          qualified_name: query.attr:qualifiedName
      - text: Trace {type_name} asset lineage by unique attribute going {direction}, depth {depth}.
        slots:
          type_name: path.typeName
          direction: query.direction
          depth: query.depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a relationship between entities
      effect: write
      questions:
      - How do I modify an existing relationship between two data map entities?
      - Can I change a relationship's attributes or status after it is created?
      instructions:
      - text: Update relationship {guid} with attributes {attributes}.
        slots:
          guid: requestBody.guid
          attributes: requestBody.attributes
      - text: Change the status of existing relationship {guid} to {status}.
        slots:
          guid: requestBody.guid
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a relationship between entities
      effect: write
      questions:
      - How do I link two entities in the data map with a new relationship?
      - What do I need to specify for each end of a new relationship?
      instructions:
      - text: Create a {type_name} relationship between {end1} and {end2}.
        slots:
          type_name: requestBody.typeName
          end1: requestBody.end1
          end2: requestBody.end2
      - text: Link entity {end1} to entity {end2} with a new relationship.
        slots:
          end1: requestBody.end1
          end2: requestBody.end2
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship by GUID
      effect: read
      questions:
      - How do I read the details of one relationship between entities?
      - Can I include extended info about the related entities when fetching a relationship?
      instructions:
      - text: Get relationship {guid}.
        slots:
          guid: path.guid
      - text: Show relationship {guid} with extended info about both ends.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship/guid/{guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a relationship between entities
      effect: destructive
      questions:
      - How do I remove a relationship link between two entities?
      - Can I delete a relationship by its GUID without touching the entities?
      instructions:
      - text: Delete relationship {guid}.
        slots:
          guid: path.guid
      - text: Remove the link with relationship GUID {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/businessmetadatadef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business metadata definition by GUID
      effect: read
      questions:
      - How do I read a business metadata type definition when I have its GUID?
      - What attributes does a given business metadata definition declare?
      instructions:
      - text: Get the business metadata definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show the business metadata typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/businessmetadatadef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business metadata definition by name
      effect: read
      questions:
      - Can I look up a business metadata definition by its unique name?
      - Which attributes are defined in the business metadata type with this name?
      instructions:
      - text: Get the business metadata definition named {name}.
        slots:
          name: path.name
      - text: Show business metadata typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/classificationdef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification definition by GUID
      effect: read
      questions:
      - How do I read a classification type definition from its GUID?
      - What does the classification typedef with a given GUID contain?
      instructions:
      - text: Get the classification definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show classification typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/classificationdef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification definition by name
      effect: read
      questions:
      - Can I look up a classification type such as a sensitivity label by its unique name?
      - What attributes and entity types does a named classification definition allow?
      instructions:
      - text: Get the classification definition named {name}.
        slots:
          name: path.name
      - text: Show classification typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/entitydef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity type definition by GUID
      effect: read
      questions:
      - How do I read an entity type definition when I know its GUID?
      - Which attributes does the entity typedef with this GUID define?
      instructions:
      - text: Get the entity type definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show entity typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/entitydef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an entity type definition by name
      effect: read
      questions:
      - What attributes does an entity type like azure_sql_table define?
      - Can I look up an entity type definition by its unique name?
      instructions:
      - text: Get the entity type definition named {name}.
        slots:
          name: path.name
      - text: Show entity typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/enumdef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an enum definition by GUID
      effect: read
      questions:
      - How do I read an enum type definition from its GUID?
      - What allowed values does the enum typedef with this GUID list?
      instructions:
      - text: Get the enum definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show enum typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/enumdef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an enum definition by name
      effect: read
      questions:
      - Which values are allowed in the enum type with this name?
      - Can I look up an enum definition by its unique name?
      instructions:
      - text: Get the enum definition named {name}.
        slots:
          name: path.name
      - text: Show enum typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/relationshipdef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship type definition by GUID
      effect: read
      questions:
      - How do I read a relationship type definition from its GUID?
      - What end types does the relationship typedef with this GUID connect?
      instructions:
      - text: Get the relationship type definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show relationship typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/relationshipdef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship type definition by name
      effect: read
      questions:
      - Which entity types does the relationship type with this name connect?
      - Can I look up a relationship definition by its unique name?
      instructions:
      - text: Get the relationship type definition named {name}.
        slots:
          name: path.name
      - text: Show relationship typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/structdef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a struct definition by GUID
      effect: read
      questions:
      - How do I read a struct type definition from its GUID?
      - What fields does the struct typedef with this GUID declare?
      instructions:
      - text: Get the struct definition with GUID {guid}.
        slots:
          guid: path.guid
      - text: Show struct typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/structdef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a struct definition by name
      effect: read
      questions:
      - Which fields does the struct type with this name define?
      - Can I look up a struct definition by its unique name?
      instructions:
      - text: Get the struct definition named {name}.
        slots:
          name: path.name
      - text: Show struct typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedef/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get any type definition by GUID
      effect: read
      questions:
      - I have a type GUID but don't know what kind of type it is; how do I read it?
      - Is there a generic typedef lookup by GUID that works for any category?
      instructions:
      - text: Get the type definition of any category with GUID {guid}.
        slots:
          guid: path.guid
      - text: Look up generic typedef {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedef/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get any type definition by name
      effect: read
      questions:
      - Is there a generic lookup that returns a type definition by name whatever its category?
      - How do I read a typedef when I know its name but not whether it is an entity or enum?
      instructions:
      - text: Get the type definition of any category named {name}.
        slots:
          name: path.name
      - text: Look up generic typedef {name} by name.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedef/name/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a type definition by name
      effect: destructive
      questions:
      - How do I delete a single custom type definition by name?
      - Can I remove one typedef without using the bulk type delete?
      instructions:
      - text: Delete the type definition named {name}.
        slots:
          name: path.name
      - text: Remove custom typedef {name} from the data map.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedefs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all type definitions in full
      effect: read
      questions:
      - What type definitions exist in my data map, with their full details?
      - Can I list only one kind of typedef, such as enums, and include term templates?
      instructions:
      - text: List every type definition in the data map.
      - text: List all full {type} type definitions.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedefs'].put
  update:
    x-apievangelist-phrasing:
      intent: Update type definitions in bulk
      effect: write
      questions:
      - How do I push changes to many existing type definitions at once?
      - Will a bulk typedef update persist every change it detects?
      instructions:
      - text: 'Update these entity type definitions in bulk: {entity_defs}.'
        slots:
          entity_defs: requestBody.entityDefs
      - text: Apply changes to existing classification definitions {classification_defs} in one call.
        slots:
          classification_defs: requestBody.classificationDefs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedefs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new type definitions in bulk
      effect: write
      questions:
      - How do I register many new custom types in the data map at once?
      - What happens to changes to existing types when I bulk create typedefs?
      instructions:
      - text: 'Create these new entity type definitions in bulk: {entity_defs}.'
        slots:
          entity_defs: requestBody.entityDefs
      - text: Register new enum definitions {enum_defs} and struct definitions {struct_defs}.
        slots:
          enum_defs: requestBody.enumDefs
          struct_defs: requestBody.structDefs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedefs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete type definitions in bulk
      effect: destructive
      questions:
      - How do I delete many custom type definitions in a single request?
      - Can I bulk remove classification and entity typedefs together?
      instructions:
      - text: 'Delete these entity type definitions in bulk: {entity_defs}.'
        slots:
          entity_defs: requestBody.entityDefs
      - text: Bulk remove classification definitions {classification_defs}.
        slots:
          classification_defs: requestBody.classificationDefs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/types/typedefs/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: List type definition headers
      effect: read
      questions:
      - Can I get a lightweight list of just the type names and GUIDs in my data map?
      - Is there a minimal header listing of typedefs filtered by kind?
      instructions:
      - text: List minimal headers for all type definitions.
      - text: List only the headers of {type} type definitions.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'