# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Appointments API
  version: 1.0.0
extends: openapi/cvent-appointments-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: 16
- target: $.paths['/appointment-attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment attendees
      effect: read
      questions:
      - Who are the attendees taking part in appointments?
      - Can I filter the people booked into appointment events?
      instructions:
      - text: List appointment attendees matching {filter}.
        slots:
          filter: query.filter
      - text: Show appointment attendees updated after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-attendees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment attendee
      effect: read
      questions:
      - What details do you have on a particular appointment attendee?
      - How do I look up an appointment attendee by ID?
      instructions:
      - text: Get appointment attendee {id}.
        slots:
          id: path.id
      - text: Show the profile of appointment attendee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-availability-times'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment availability times
      effect: read
      questions:
      - When have people said they are available for appointments?
      - Can I list availability windows across appointment events?
      instructions:
      - text: List appointment availability times matching {filter}.
        slots:
          filter: query.filter
      - text: Show availability windows added after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-availability-times/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment availability time
      effect: read
      questions:
      - What is the time range on a specific availability record?
      - How do I fetch a single availability window by ID?
      instructions:
      - text: Get availability time {id}.
        slots:
          id: path.id
      - text: Show the availability window {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment events
      effect: read
      questions:
      - Which events have appointment scheduling set up?
      - Can I list appointment events matching a filter?
      instructions:
      - text: List appointment events matching {filter}.
        slots:
          filter: query.filter
      - text: Show appointment events changed after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an appointment event
      effect: read
      questions:
      - What are the settings of a particular appointment event?
      - How do I retrieve one appointment event by ID?
      instructions:
      - text: Get appointment event {id}.
        slots:
          id: path.id
      - text: Show details for appointment event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointment-available-times'].get
  update:
    x-apievangelist-phrasing:
      intent: Find open slots to book an appointment
      effect: read
      questions:
      - What open times and locations can I book an appointment in?
      - Which slots are still free in an appointment event?
      instructions:
      - text: List bookable times in appointment event {id}.
        slots:
          id: path.id
      - text: Find free appointment slots in event {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointment-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment types for an appointment event
      effect: read
      questions:
      - What kinds of appointments can be booked at an appointment event?
      - Which appointment types, like 30-minute meetings, are defined?
      instructions:
      - text: List appointment types in appointment event {id}.
        slots:
          id: path.id
      - text: Show up to {limit} appointment types for event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments'].post
  update:
    x-apievangelist-phrasing:
      intent: Book an appointment
      effect: write
      questions:
      - How do I schedule an appointment between attendees and hosts?
      - Can I book an appointment without sending notification emails?
      instructions:
      - text: Book a {appointmentTypeId} appointment in appointment event {id} from {startTime} to {endTime}.
        slots:
          appointmentTypeId: requestBody.appointmentTypeId
          id: path.id
          startTime: requestBody.startTime
          endTime: requestBody.endTime
      - text: Schedule an appointment of type {appointmentTypeId} in event {id} with attendees {attendees} and hosts {hosts}.
        slots:
          appointmentTypeId: requestBody.appointmentTypeId
          id: path.id
          attendees: requestBody.attendees
          hosts: requestBody.hosts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments/{apptId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a booked appointment
      effect: write
      questions:
      - How do I reschedule or edit an existing appointment?
      - Can I change an appointment quietly without notifying participants?
      instructions:
      - text: Update appointment {apptId} in appointment event {id}.
        slots:
          apptId: path.apptId
          id: path.id
      - text: 'Edit appointment {apptId} in event {id} and suppress notifications: {suppressNotifications}.'
        slots:
          apptId: path.apptId
          id: path.id
          suppressNotifications: query.suppressNotifications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/appointments/{apptId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an appointment
      effect: destructive
      questions:
      - How do I cancel a scheduled appointment?
      - Can I cancel an appointment without emailing the attendees?
      instructions:
      - text: Cancel appointment {apptId} in appointment event {id}.
        slots:
          apptId: path.apptId
          id: path.id
      - text: 'Cancel appointment {apptId} (event {id}) with notifications suppressed: {suppressNotifications}.'
        slots:
          apptId: path.apptId
          id: path.id
          suppressNotifications: query.suppressNotifications
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment locations
      effect: read
      questions:
      - Where can appointments take place in an appointment event?
      - What meeting tables or rooms are set up for appointments?
      instructions:
      - text: List appointment locations in event {id}.
        slots:
          id: path.id
      - text: Show {limit} meeting locations for appointment event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-meeting-interests'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees' meeting interests
      effect: read
      questions:
      - Who do attendees want to meet with?
      - Can I list meeting interest requests across appointment events?
      instructions:
      - text: List meeting interests matching {filter}.
        slots:
          filter: query.filter
      - text: Show meeting interests submitted after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-meeting-interests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attendee's meeting interest
      effect: read
      questions:
      - What meeting interests did a specific attendee express?
      - How do I fetch one meeting interest record by ID?
      instructions:
      - text: Get meeting interest {id}.
        slots:
          id: path.id
      - text: Show who the attendee on interest {id} wants to meet.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointments'].get
  update:
    x-apievangelist-phrasing:
      intent: List booked appointments
      effect: read
      questions:
      - What appointments are on the books?
      - Can I list appointments scheduled after a given date?
      instructions:
      - text: List appointments matching {filter}.
        slots:
          filter: query.filter
      - text: Show appointments created after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an appointment
      effect: read
      questions:
      - What are the time, location and participants of a specific appointment?
      - Which hosts and attendees are in a given booked meeting?
      instructions:
      - text: Get appointment {id}.
        slots:
          id: path.id
      - text: Show the details of appointment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'