# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Application Messages API
  version: 1.0.0
extends: openapi/optimizely-application-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: 9
- target: $.paths['/api/v1/admin/ApplicationMessages'].get
  update:
    x-apievangelist-phrasing:
      intent: List application messages
      effect: read
      questions:
      - Which storefront messages and labels are defined in my Optimizely commerce site?
      - Can I filter application messages by name?
      instructions:
      - text: List all application messages.
      - text: List application messages matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application message
      effect: write
      questions:
      - How do I add a new message text that the storefront displays?
      - Can I create an application message for just one website?
      instructions:
      - text: Create application message {name} described as {description} with text {message}.
        slots:
          name: requestBody.name
          description: requestBody.description
          message: requestBody.message
      - text: Add message {name} ({description}) reading {message} for website {websiteId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          message: requestBody.message
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application message
      effect: read
      questions:
      - What text does a particular application message show?
      - How do I fetch one application message by id?
      instructions:
      - text: Get application message {id}.
        slots:
          id: path.id
      - text: Show the text of application message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an application message
      effect: write
      questions:
      - How do I overwrite an application message record entirely?
      - Can I replace a message's name, description and text in one request?
      instructions:
      - text: Replace application message {id} with name {name}, description {description} and text {message}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
          message: requestBody.message
      - text: Fully rewrite application message record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application message
      effect: destructive
      questions:
      - How do I remove an application message?
      - Can I delete a message only if it hasn't changed since I fetched it?
      instructions:
      - text: Delete application message {id}.
        slots:
          id: path.id
      - text: Delete application message {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an application message's text
      effect: write
      questions:
      - How do I change the wording of an existing storefront message?
      - Can I update only the message text and leave the rest alone?
      instructions:
      - text: Change application message {id}'s text to {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Update the description of application message {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationMessages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default application message
      effect: read
      questions:
      - What does an empty application message object contain?
      - Is there a default template for a new application message?
      instructions:
      - text: Get the default template for a new application message.
      - text: Show the blank application message object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/applicationmessages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several application messages
      effect: destructive
      questions:
      - Can I delete a batch of application messages in one request?
      - How do I bulk-remove messages by id?
      instructions:
      - text: Delete application messages {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove the application messages with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/applicationmessages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application message custom property
      effect: read
      questions:
      - How do I read a custom property on an application message?
      - Can application messages carry extra custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of application message {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show application message {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'