# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public Whiteboard API
  version: 1.0.0
extends: openapi/mapp-whiteboard-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: 8
- target: $.paths['/whiteboard/save'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a whiteboard
      effect: write
      questions:
      - How do I save a customer journey whiteboard in the Audience Interaction Planner?
      - Is a whiteboard checked against the schema when I save it?
      instructions:
      - text: Save this whiteboard diagram.
      - text: Update my welcome journey whiteboard with these changes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a whiteboard
      effect: destructive
      questions:
      - What gets removed along with a whiteboard when I delete it?
      - Can I delete a whiteboard by its ID?
      instructions:
      - text: Delete whiteboard {id}.
        slots:
          id: query.id
      - text: Remove whiteboard {id} with its statistics and labels.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a whiteboard
      effect: write
      questions:
      - How do I make a whiteboard journey live?
      - Is the diagram validated when a whiteboard is published?
      instructions:
      - text: Publish this whiteboard.
      - text: Take my cart abandonment whiteboard live.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a whiteboard with all versions
      effect: read
      questions:
      - Can I see every version of a specific whiteboard?
      - How do I load one whiteboard by its ID?
      instructions:
      - text: Get whiteboard {id} with all its versions.
        slots:
          id: query.id
      - text: Open whiteboard {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/listTemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List whiteboard templates
      effect: read
      questions:
      - What starter templates are available for new whiteboards?
      - Which active whiteboard templates can I build a journey from?
      instructions:
      - text: List the available whiteboard templates.
      - text: Show me the journey templates I can start from.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/find'].get
  update:
    x-apievangelist-phrasing:
      intent: Search whiteboards
      effect: read
      questions:
      - Which whiteboards have we created, most recently updated first?
      - Can I filter my whiteboards by name or status?
      instructions:
      - text: Find whiteboards named {nameFilter}.
        slots:
          nameFilter: query.nameFilter
      - text: List whiteboards with status {statusFilter}, {limit} per page.
        slots:
          statusFilter: query.statusFilter
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the whiteboard JSON schema
      effect: read
      questions:
      - What JSON structure does a whiteboard need to follow?
      - Where can I get the canonical whiteboard schema?
      instructions:
      - text: Get the whiteboard JSON schema.
      - text: Show me the schema a whiteboard diagram must match.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whiteboard/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a whiteboard without saving
      effect: read
      questions:
      - Can I check a whiteboard for errors before saving or publishing it?
      - What validation problems does my journey diagram have?
      instructions:
      - text: Validate this whiteboard and list any errors.
      - text: Run the full validation checks on my whiteboard draft.
      method: generated
      generated: '2026-09-26'