Azure Service Bus · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure Service Bus Management Topics API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].delete

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 Azure Service Bus Management Topics API
  version: 1.0.0
extends: openapi/azure-service-bus-topics-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: 4
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List the topics in a namespace
      effect: read
      questions:
      - Which topics are defined in my Service Bus namespace?
      - Can I page through a namespace's topics using skip and top?
      instructions:
      - text: List the topics in namespace {namespaceName}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the first {top} topics in namespace {namespaceName} ({resourceGroupName}, subscription {subscriptionId}).
        slots:
          top: query.$top
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a topic's description
      effect: read
      questions:
      - How do I check how a single Service Bus topic is configured?
      - What properties does my topic currently have?
      instructions:
      - text: Get topic {topicName} in namespace {namespaceName}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Describe the {topicName} topic of namespace {namespaceName} in {resourceGroupName} (subscription {subscriptionId}).
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a topic
      effect: write
      questions:
      - How do I add a new publish-subscribe topic to a Service Bus namespace?
      - Can I change the properties of a topic that already exists?
      instructions:
      - text: Create topic {topicName} in namespace {namespaceName}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Update topic {topicName} in {namespaceName} ({resourceGroupName}, subscription {subscriptionId}) with properties {properties}.
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a topic
      effect: destructive
      questions:
      - How do I remove a topic from a Service Bus namespace?
      - What happens to a topic's subscriptions when the topic is deleted?
      instructions:
      - text: Delete topic {topicName} from namespace {namespaceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the {topicName} topic from {namespaceName} (resource group {resourceGroupName}, subscription {subscriptionId}).
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'