Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Azure Analytics Purview Data Map Atlas API

90 actions 90 updates phrasing extends openapi/microsoft-azure-atlas-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 90 · first 16 shown; the file carries all of them

$.info
$.paths['/atlas/v2/entity'].post
$.paths['/atlas/v2/entity/bulk'].get
$.paths['/atlas/v2/entity/bulk'].post
$.paths['/atlas/v2/entity/bulk'].delete
$.paths['/atlas/v2/entity/bulk/classification'].post
$.paths['/atlas/v2/entity/bulk/setClassifications'].post
$.paths['/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}'].get
$.paths['/atlas/v2/entity/businessmetadata/import'].post
$.paths['/atlas/v2/entity/businessmetadata/import/template'].get
$.paths['/atlas/v2/entity/guid/{guid}'].get
$.paths['/atlas/v2/entity/guid/{guid}'].put
$.paths['/atlas/v2/entity/guid/{guid}'].delete
$.paths['/atlas/v2/entity/guid/{guid}/businessmetadata'].post
$.paths['/atlas/v2/entity/guid/{guid}/businessmetadata'].delete
$.paths['/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}'].post

OpenAPI Overlay

Raw ↑
# 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'


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/overlays/microsoft-azure-atlas-api-phrasing-overlay.yaml

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-atlas-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.