# 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 Punch Out Order Request Messages API
  version: 1.0.0
extends: openapi/optimizely-punch-out-order-request-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/PunchOutOrderRequestMessages'].get
  update:
    x-apievangelist-phrasing:
      intent: List punchout order validation messages
      effect: read
      questions:
      - What validation errors and warnings were logged for punchout orders?
      - Can I filter punchout validation messages by message type?
      - Which punchout orders have validation messages recorded?
      instructions:
      - text: List all punchout order validation messages.
      - text: Find punchout validation messages matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the latest {top} punchout messages ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a punchout order validation message
      effect: write
      questions:
      - How do I record a validation warning against a punchout order request?
      - Can I attach a validation message to one specific item line of a punchout order?
      instructions:
      - text: Log a {validationMessageType} message {message} on punchout order request {punchOutOrderRequestId}.
        slots:
          validationMessageType: requestBody.validationMessageType
          message: requestBody.message
          punchOutOrderRequestId: requestBody.punchOutOrderRequestId
      - text: Record validation message {message} of type {validationMessageType} against punchout item line {punchOutOrderRequestItemOutId}.
        slots:
          message: requestBody.message
          validationMessageType: requestBody.validationMessageType
          punchOutOrderRequestItemOutId: requestBody.punchOutOrderRequestItemOutId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a punchout validation message by ID
      effect: read
      questions:
      - What does a particular punchout validation message say?
      - Which punchout order does a given validation message ID belong to?
      instructions:
      - text: Get punchout validation message record {id}.
        slots:
          id: path.id
      - text: Show the text and type of punchout message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a punchout validation message
      effect: write
      questions:
      - How do I overwrite a punchout validation message record in full?
      - Does replacing a punchout message drop its item link if I omit it?
      instructions:
      - text: Replace punchout message {id} with type {validationMessageType} and text {message}.
        slots:
          id: path.id
          validationMessageType: requestBody.validationMessageType
          message: requestBody.message
      - text: Overwrite punchout validation message {id} in full, linking order request {punchOutOrderRequestId}.
        slots:
          id: path.id
          punchOutOrderRequestId: requestBody.punchOutOrderRequestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a punchout validation message
      effect: destructive
      questions:
      - How do I clear one punchout validation message once it is resolved?
      - Can deleting a punchout message be conditional on its ETag?
      instructions:
      - text: Delete punchout validation message {id}.
        slots:
          id: path.id
      - text: Delete punchout message {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a punchout validation message
      effect: write
      questions:
      - Can I change just the wording of a punchout validation message?
      - How do I downgrade a punchout message from error to warning?
      instructions:
      - text: Change the text of punchout message {id} to {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Set the validation type of punchout message {id} to {validationMessageType}.
        slots:
          id: path.id
          validationMessageType: requestBody.validationMessageType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestMessages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank punchout message template
      effect: read
      questions:
      - What default values does a new punchout validation message start with?
      - Is there an empty punchout message template I can fetch?
      instructions:
      - text: Fetch the default punchout validation message template.
      - text: Show default field values for a new punchout message.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestmessages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete punchout validation messages
      effect: destructive
      questions:
      - How do I clear many punchout validation messages in one go?
      - Can I delete a list of punchout messages by ID?
      instructions:
      - text: Bulk delete punchout validation messages {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these punchout messages together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestmessages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a punchout message
      effect: read
      questions:
      - What value is stored in a custom property on a punchout validation message?
      - Can I read one custom property of a punchout message record?
      instructions:
      - text: Get custom property {custompropertyKey} on punchout message {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show punchout validation message {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'