# 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 REST Messages API
  version: 1.0.0
extends: openapi/azure-service-bus-messages-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: 5
- target: $.paths['/{queuePath}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to a queue or topic
      effect: write
      questions:
      - How do I post a message onto an Azure Service Bus queue over REST?
      - Can I publish a message to a topic with the same send call I use for queues?
      - What endpoint puts a new message on a Service Bus entity?
      instructions:
      - text: Send a message to the {queuePath} queue.
        slots:
          queuePath: path.queuePath
      - text: Publish a new message onto the topic at {queuePath}.
        slots:
          queuePath: path.queuePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{queuePath}/messages/head'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive and delete the next queued message
      effect: destructive
      questions:
      - How do I pull the next message off a queue and remove it in one step?
      - Is there a destructive read that takes a message and deletes it right away?
      - What happens to a message once I receive it with receive-and-delete?
      instructions:
      - text: Receive the next message from {queuePath} and delete it immediately.
        slots:
          queuePath: path.queuePath
      - text: Take the head message off queue {queuePath} without locking it, removing it as it is read.
        slots:
          queuePath: path.queuePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{queuePath}/messages/head'].delete
  update:
    x-apievangelist-phrasing:
      intent: Peek and lock the next message for processing
      effect: destructive
      questions:
      - How do I read the next message but keep it on the queue until I finish processing it?
      - Can I lock a message so no other receiver picks it up while I work on it?
      - What call gives me a lock token for the message at the head of the queue?
      instructions:
      - text: Peek-lock the next message on {queuePath} so I can process it.
        slots:
          queuePath: path.queuePath
      - text: Lock the head message of queue {queuePath} and give me its lock token.
        slots:
          queuePath: path.queuePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{queuePath}/messages/{messageId}/{lockToken}'].put
  update:
    x-apievangelist-phrasing:
      intent: Renew the lock on a locked message
      effect: write
      questions:
      - How do I extend the lock on a message that is taking a long time to process?
      - Can I keep a peek-locked message from going back to the queue before I'm done?
      - What do I need to renew a message lock — the message ID and lock token?
      instructions:
      - text: Renew the lock on message {messageId} in {queuePath} using lock token {lockToken}.
        slots:
          messageId: path.messageId
          queuePath: path.queuePath
          lockToken: path.lockToken
      - text: Extend my processing lock for message {messageId} with token {lockToken} on {queuePath}.
        slots:
          messageId: path.messageId
          lockToken: path.lockToken
          queuePath: path.queuePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{queuePath}/messages/{messageId}/{lockToken}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Complete a peek-locked message
      effect: destructive
      questions:
      - How do I mark a locked message as successfully processed so it leaves the queue?
      - Which call settles a peek-locked message once my handler succeeds?
      - Does completing a message remove it permanently from the queue?
      instructions:
      - text: Complete message {messageId} on {queuePath} with lock token {lockToken}.
        slots:
          messageId: path.messageId
          queuePath: path.queuePath
          lockToken: path.lockToken
      - text: Mark locked message {messageId} in {queuePath} as done using token {lockToken} so it is removed.
        slots:
          messageId: path.messageId
          queuePath: path.queuePath
          lockToken: path.lockToken
      method: generated
      generated: '2026-10-01'