# 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 Cosmos DB for MongoDB vCore Mongo…
  version: 1.0.0
extends: openapi/microsoft-azure-mongoclusters-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List all mongo clusters in a subscription
      effect: read
      questions:
      - Which Cosmos DB mongo clusters are running across my whole subscription?
      - Can I see every mongo cluster I own regardless of resource group?
      instructions:
      - text: List every mongo cluster in my subscription.
      - text: Show all mongo clusters across all of my resource groups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List the mongo clusters in a resource group
      effect: read
      questions:
      - What mongo clusters live in one particular resource group?
      - Can I scope my mongo cluster inventory to a single resource group?
      instructions:
      - text: List the mongo clusters in this resource group.
      - text: Show only the mongo clusters that belong to my current resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a mongo cluster
      effect: read
      questions:
      - What's the configuration and state of a specific mongo cluster?
      - Can I look up one mongo cluster by name?
      instructions:
      - text: Show mongo cluster {mongoClusterName}.
        slots:
          mongoClusterName: path.mongoClusterName
      - text: Get the provisioning state and settings of {mongoClusterName}.
        slots:
          mongoClusterName: path.mongoClusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or fully replace a mongo cluster
      effect: write
      questions:
      - How do I provision a new mongo cluster?
      - Does a full create-or-update overwrite every property of the cluster?
      instructions:
      - text: Create mongo cluster {mongoClusterName} with properties {properties}.
        slots:
          mongoClusterName: path.mongoClusterName
          properties: requestBody.properties
      - text: Overwrite the whole definition of {mongoClusterName} with {properties}.
        slots:
          mongoClusterName: path.mongoClusterName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mongo cluster
      effect: destructive
      questions:
      - Can I tear down a mongo cluster I don't need anymore?
      - Is deleting a mongo cluster reversible?
      instructions:
      - text: Delete mongo cluster {mongoClusterName}.
        slots:
          mongoClusterName: path.mongoClusterName
      - text: Remove the {mongoClusterName} cluster and its data.
        slots:
          mongoClusterName: path.mongoClusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a mongo cluster
      effect: write
      questions:
      - Can I change just a couple of properties on an existing mongo cluster?
      - How do I retag a mongo cluster without resending its full definition?
      instructions:
      - text: Patch mongo cluster {mongoClusterName} with {properties}.
        slots:
          mongoClusterName: path.mongoClusterName
          properties: requestBody.properties
      - text: Set the tags on existing cluster {mongoClusterName} to {tags}.
        slots:
          mongoClusterName: path.mongoClusterName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/checkMongoClusterNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a mongo cluster name is available
      effect: read
      questions:
      - Is the mongo cluster name I want already taken in that region?
      - Can I validate a cluster name before provisioning it?
      instructions:
      - text: Check whether my proposed mongo cluster name is available in {location}.
        slots:
          location: path.location
      - text: Verify a new mongo cluster name is free in the target location before I create it.
      method: generated
      generated: '2026-10-01'