API Evangelist conversational phrasing for Things Stack — Integrations Application Pub Sub Registry API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Things Stack — Integrations Application Pub Sub Registry API
  version: 1.0.0
extends: openapi/the-things-network-applicationpubsubregistry-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: 6
- target: $.paths['/as/pubsub-formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported Pub/Sub message formats
      effect: read
      questions:
      - Which message formats can a Pub/Sub integration publish in?
      - What formats are supported for application Pub/Sub?
      instructions:
      - text: List the available Pub/Sub message formats.
      - text: Show which payload formats Pub/Sub integrations support.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/pubsub/{application_ids.application_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's Pub/Sub integrations
      effect: read
      questions:
      - Which Pub/Sub integrations are configured on my application?
      - Can I page through my application's Pub/Sub integrations?
      instructions:
      - text: List Pub/Sub integrations for application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Show page {page} of Pub/Sub integrations in {application_id}.
        slots:
          page: query.page
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/pubsub/{application_ids.application_id}/{pub_sub_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pub/Sub integration
      effect: destructive
      questions:
      - How do I remove a Pub/Sub integration from my application?
      - Can I stop publishing to a broker by deleting its integration?
      instructions:
      - text: Delete Pub/Sub integration {pub_sub_id} from application {application_id}.
        slots:
          pub_sub_id: path.pub_sub_id
          application_id: path.application_ids.application_id
      - text: Remove the {pub_sub_id} Pub/Sub integration in {application_id}.
        slots:
          pub_sub_id: path.pub_sub_id
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/pubsub/{ids.application_ids.application_id}/{ids.pub_sub_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pub/Sub integration
      effect: read
      questions:
      - What broker settings does one of my Pub/Sub integrations use?
      - Can I view a single Pub/Sub integration by ID?
      instructions:
      - text: Show Pub/Sub integration {pub_sub_id} of application {application_id}.
        slots:
          pub_sub_id: path.ids.pub_sub_id
          application_id: path.ids.application_ids.application_id
      - text: Get fields {field_mask} of Pub/Sub {pub_sub_id} in {application_id}.
        slots:
          field_mask: query.field_mask
          pub_sub_id: path.ids.pub_sub_id
          application_id: path.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/pubsub/{pubsub.ids.application_ids.application_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pub/Sub integration
      effect: write
      questions:
      - How do I set up a new Pub/Sub integration to forward my application's messages to a broker?
      - Can I add a Pub/Sub integration without providing its ID in the path?
      instructions:
      - text: Create Pub/Sub integration {pubsub} for application {application_id}.
        slots:
          pubsub: requestBody.pubsub
          application_id: path.pubsub.ids.application_ids.application_id
      - text: Add a new Pub/Sub broker connection to {application_id}.
        slots:
          application_id: path.pubsub.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/pubsub/{pubsub.ids.application_ids.application_id}/{pubsub.ids.pub_sub_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Pub/Sub integration
      effect: write
      questions:
      - How do I change the broker or topics of an existing Pub/Sub integration?
      - Can I update only some fields of a Pub/Sub integration?
      instructions:
      - text: Update Pub/Sub integration {pub_sub_id} in application {application_id} with {pubsub}.
        slots:
          pub_sub_id: path.pubsub.ids.pub_sub_id
          application_id: path.pubsub.ids.application_ids.application_id
          pubsub: requestBody.pubsub
      - text: Change fields {field_mask} of Pub/Sub {pub_sub_id} in {application_id}.
        slots:
          field_mask: requestBody.field_mask
          pub_sub_id: path.pubsub.ids.pub_sub_id
          application_id: path.pubsub.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'