# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitLab Broadcast Messages API
  version: 1.0.0
extends: openapi/gitlab-broadcast-messages-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: 5
- target: $.paths['/api/v4/broadcast_messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a broadcast message
      effect: read
      questions:
      - How do I view one broadcast banner and its schedule?
      - What audience and dates are set on a specific broadcast message?
      instructions:
      - text: Show broadcast message {id}.
        slots:
          id: path.id
      - text: Get the text and schedule of broadcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/broadcast_messages/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a broadcast message
      effect: write
      questions:
      - How do I change the wording or end date of an existing announcement banner?
      - Can I retarget an existing broadcast to certain access levels or paths?
      instructions:
      - text: Change the text of broadcast message {id} to {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Extend broadcast {id} so it ends at {ends_at}.
        slots:
          id: path.id
          ends_at: requestBody.ends_at
      - text: Limit existing broadcast {id} to pages matching {target_path}.
        slots:
          id: path.id
          target_path: requestBody.target_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/broadcast_messages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a broadcast message
      effect: destructive
      questions:
      - How do I take down an announcement banner from my GitLab instance?
      - Can I permanently delete a broadcast message?
      instructions:
      - text: Delete broadcast message {id}.
        slots:
          id: path.id
      - text: Remove the announcement banner {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/broadcast_messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List all broadcast messages
      effect: read
      questions:
      - What announcement banners are configured on the instance?
      - Where can I see every past and scheduled broadcast message?
      instructions:
      - text: List all broadcast messages.
      - text: Show page {page} of the broadcast messages.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/broadcast_messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a broadcast message
      effect: write
      questions:
      - How do I post a maintenance banner to all users of my GitLab instance?
      - Can I schedule a broadcast to start and end at set times?
      - Is it possible to show a notification-style broadcast that users can dismiss?
      instructions:
      - text: Create a broadcast message saying {message}.
        slots:
          message: requestBody.message
      - text: Broadcast {message} from {starts_at} until {ends_at}.
        slots:
          message: requestBody.message
          starts_at: requestBody.starts_at
          ends_at: requestBody.ends_at
      - text: Post a {broadcast_type} broadcast reading {message}.
        slots:
          broadcast_type: requestBody.broadcast_type
          message: requestBody.message
      method: generated
      generated: '2026-09-26'