Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings Login Banner Settings API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-login-banner-settings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/motd-banner-settings'].get
$.paths['/motd-banner-settings'].post
$.paths['/motd-banner-settings/{id}'].get
$.paths['/motd-banner-settings/{id}'].put
$.paths['/motd-banner-settings/{id}'].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 Device Settings Login Banner Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-login-banner-settings-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['/motd-banner-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List login banner settings
      effect: read
      questions:
      - Which login banner and message-of-the-day settings are configured?
      - Can I see login banner settings for one folder or device?
      instructions:
      - text: List all login banner settings.
      - text: List login banner settings in folder {folder}.
        slots:
          folder: query.folder
      - text: Show login banner settings for device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/motd-banner-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create login banner settings
      effect: write
      questions:
      - How do I set a message of the day shown when admins log in?
      - Can I add a login banner warning to my firewalls?
      instructions:
      - text: Create login banner settings with {motd_and_banner}.
        slots:
          motd_and_banner: requestBody.motd_and_banner
      - text: Add a new message of the day and banner {motd_and_banner}.
        slots:
          motd_and_banner: requestBody.motd_and_banner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/motd-banner-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get login banner settings
      effect: read
      questions:
      - What does a particular login banner configuration say?
      - Can I fetch one set of login banner settings by id?
      instructions:
      - text: Get login banner settings {id}.
        slots:
          id: path.id
      - text: Show the message of the day configured in banner settings {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/motd-banner-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update login banner settings
      effect: write
      questions:
      - How do I change the text of an existing login banner?
      - Can I edit the message of the day on existing banner settings?
      instructions:
      - text: Update login banner settings {id} to {motd_and_banner}.
        slots:
          id: path.id
          motd_and_banner: requestBody.motd_and_banner
      - text: Change the banner text in settings {id} to {motd_and_banner}.
        slots:
          id: path.id
          motd_and_banner: requestBody.motd_and_banner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/motd-banner-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete login banner settings
      effect: destructive
      questions:
      - Which call removes a login banner configuration?
      - Is deleting login banner settings permanent?
      instructions:
      - text: Delete login banner settings {id}.
        slots:
          id: path.id
      - text: Remove the banner configuration with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'