# 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 Catalogs API
  version: 1.0.0
extends: openapi/microsoft-azure-catalogs-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: 13
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure Sphere catalogs in a subscription
      effect: read
      questions:
      - Which Azure Sphere catalogs exist across my subscription?
      - Can I see every Sphere catalog I own without picking a resource group?
      instructions:
      - text: List all Azure Sphere catalogs in my subscription.
      - text: Show every Sphere catalog across the subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure Sphere catalogs in a resource group
      effect: read
      questions:
      - What Azure Sphere catalogs are in one resource group?
      - Can I narrow the Sphere catalog list to a single resource group?
      instructions:
      - text: List Azure Sphere catalogs in this resource group.
      - text: Show the Sphere catalogs in my resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Sphere catalog
      effect: read
      questions:
      - How can I view the details of one Azure Sphere catalog?
      - What's the provisioning state of a specific Sphere catalog?
      instructions:
      - text: Get Azure Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Show details of Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure Sphere catalog
      effect: write
      questions:
      - How do I create a new Azure Sphere catalog for my devices?
      - Can I create a Sphere catalog through the management API?
      instructions:
      - text: Create Azure Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Set up a new Sphere catalog called {catalogName} with properties {properties}.
        slots:
          catalogName: path.catalogName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure Sphere catalog
      effect: destructive
      questions:
      - Can I delete an Azure Sphere catalog I no longer use?
      - What does removing a Sphere catalog do to its resources?
      instructions:
      - text: Delete Azure Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Remove the Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on an Azure Sphere catalog
      effect: write
      questions:
      - Can I change the tags on an existing Azure Sphere catalog?
      - What can be updated on a Sphere catalog after it's created?
      instructions:
      - text: Update tags on Sphere catalog {catalogName} to {tags}.
        slots:
          catalogName: path.catalogName
          tags: requestBody.tags
      - text: Tag Azure Sphere catalog {catalogName} with {tags}.
        slots:
          catalogName: path.catalogName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices'].post
  update:
    x-apievangelist-phrasing:
      intent: Count devices in an Azure Sphere catalog
      effect: read
      questions:
      - How many devices are registered in my Azure Sphere catalog?
      - Can I get a total device count for a Sphere catalog?
      instructions:
      - text: Count the devices in Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Tell me how many devices catalog {catalogName} holds.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments'].post
  update:
    x-apievangelist-phrasing:
      intent: List deployments in an Azure Sphere catalog
      effect: read
      questions:
      - What image deployments exist across an Azure Sphere catalog?
      - Can I filter and page the deployments in a Sphere catalog?
      instructions:
      - text: List deployments in Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Show the first {top} deployments in catalog {catalogName} matching {filter}.
        slots:
          top: query.$top
          catalogName: path.catalogName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: List device groups in an Azure Sphere catalog
      effect: read
      questions:
      - Which device groups belong to an Azure Sphere catalog?
      - Can I look up device groups in a Sphere catalog by name?
      instructions:
      - text: List device groups in Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Find device group {deviceGroupName} in catalog {catalogName}.
        slots:
          deviceGroupName: requestBody.deviceGroupName
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights'].post
  update:
    x-apievangelist-phrasing:
      intent: List device insights for an Azure Sphere catalog
      effect: read
      questions:
      - Where can I see device insights, like errors reported by devices, for a Sphere catalog?
      - Can I filter device insights across an Azure Sphere catalog?
      instructions:
      - text: List device insights for Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Show device insights in catalog {catalogName} matching {filter}.
        slots:
          catalogName: path.catalogName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices'].post
  update:
    x-apievangelist-phrasing:
      intent: List devices in an Azure Sphere catalog
      effect: read
      questions:
      - Which individual devices are in my Azure Sphere catalog?
      - Can I page through all devices in a Sphere catalog?
      instructions:
      - text: List the devices in Sphere catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Show {top} devices from catalog {catalogName}, skipping {skip}.
        slots:
          top: query.$top
          catalogName: path.catalogName
          skip: query.$skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectName}/catalogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalogs available to a dev center project
      effect: read
      questions:
      - Which environment definition catalogs can my Deployment Environments project use?
      - How can I see the catalogs attached to a dev center project?
      instructions:
      - text: List catalogs available to dev center project {projectName}.
        slots:
          projectName: path.projectName
      - text: Show the environment catalogs for project {projectName}.
        slots:
          projectName: path.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectName}/catalogs/{catalogName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog in a dev center project
      effect: read
      questions:
      - Can I look up one environment catalog within a dev center project?
      - What's in a specific catalog that my project has access to?
      instructions:
      - text: Get catalog {catalogName} in project {projectName}.
        slots:
          catalogName: path.catalogName
          projectName: path.projectName
      - text: Show the environment catalog {catalogName} in my project.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-10-01'