# 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 Vmi Notes API
  version: 1.0.0
extends: openapi/optimizely-vmi-notes-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/VmiNotes'].get
  update:
    x-apievangelist-phrasing:
      intent: List vendor-managed inventory notes
      effect: read
      questions:
      - Which notes have been left on my vendor-managed inventory bins?
      - Can I filter VMI notes to one bin?
      instructions:
      - text: List all VMI notes.
      - text: List VMI notes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a VMI bin
      effect: write
      questions:
      - How do I leave a note on a vendor-managed inventory bin?
      - Can a VMI note be set to print on the replenishment order?
      instructions:
      - text: Add note {note} to VMI bin {vmiBinId}.
        slots:
          note: requestBody.note
          vmiBinId: requestBody.vmiBinId
      - text: 'Create a VMI note {note} and include it on the order: {includeOnOrder}.'
        slots:
          note: requestBody.note
          includeOnOrder: requestBody.includeOnOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VMI note
      effect: read
      questions:
      - What does a particular vendor-managed inventory note say?
      - Can I fetch one VMI note by id?
      instructions:
      - text: Get VMI note {id}.
        slots:
          id: path.id
      - text: Fetch bin note {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a VMI note
      effect: write
      questions:
      - How do I overwrite a VMI note record entirely?
      - Can I resend the bin and text to replace a VMI note?
      instructions:
      - text: Replace VMI note {id} with text {note}.
        slots:
          id: path.id
          note: requestBody.note
      - text: Overwrite the full bin note record {id} for bin {vmiBinId}.
        slots:
          id: path.id
          vmiBinId: requestBody.vmiBinId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one VMI note
      effect: destructive
      questions:
      - How do I remove a note from a VMI bin?
      - Can deleting a VMI note be tied to an If-Match ETag?
      instructions:
      - text: Delete VMI note {id}.
        slots:
          id: path.id
      - text: Delete bin note {id} only if its ETag still matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a VMI note
      effect: write
      questions:
      - Can I change only the text of a VMI note?
      - How do I stop a VMI note from appearing on orders?
      instructions:
      - text: Change the text of VMI note {id} to {note}.
        slots:
          id: path.id
          note: requestBody.note
      - text: Set include-on-order for VMI note {id} to {includeOnOrder}.
        slots:
          id: path.id
          includeOnOrder: requestBody.includeOnOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VmiNotes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new VMI note
      effect: read
      questions:
      - What defaults does a new VMI note start with?
      - Is there a blank bin note template?
      instructions:
      - text: Get the default template for a VMI note.
      - text: Fetch an empty bin note with default values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vminotes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete VMI notes
      effect: destructive
      questions:
      - Can I remove many VMI notes in one request?
      - How do I bulk-delete bin notes by id?
      instructions:
      - text: Bulk delete VMI notes {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove every bin note in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/vminotes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a VMI note
      effect: read
      questions:
      - What custom property values are stored on a VMI note?
      - Can I read one custom attribute of a bin note?
      instructions:
      - text: Get custom property {custompropertyKey} on VMI note {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read extra attribute {custompropertyKey} of bin note {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'