# 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-registration-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 appointment scheduling?
      - Can I filter appointment attendees updated after a date?
      instructions:
      - text: List appointment attendees.
      - text: List appointment attendees matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-attendees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an appointment attendee
      effect: read
      questions:
      - How do I look up one appointment attendee's details?
      - What does the record for a single appointment attendee contain?
      instructions:
      - text: Get appointment attendee {id}.
        slots:
          id: path.id
      - text: Show details for 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 are people available for appointments across my appointment events?
      - Can I filter the availability time blocks people have set?
      instructions:
      - text: List appointment availability times.
      - text: List availability time blocks matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-availability-times/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an appointment availability time
      effect: read
      questions:
      - How do I fetch one specific availability time block?
      - What are the details of a single availability record?
      instructions:
      - text: Get availability time {id}.
        slots:
          id: path.id
      - text: Show the availability block with ID {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 page through my appointment events?
      instructions:
      - text: List appointment events.
      - text: List appointment events matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an appointment event
      effect: read
      questions:
      - How do I get the settings of one appointment event?
      - What does a single appointment event record look like?
      instructions:
      - text: Get appointment event {id}.
        slots:
          id: path.id
      - text: Show the details of 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 appointment slots and locations
      effect: read
      questions:
      - What times and locations are still open to book appointments in an appointment event?
      - Can I filter available appointment slots before scheduling a meeting?
      instructions:
      - text: List open appointment times in appointment event {id}.
        slots:
          id: path.id
      - text: Find bookable slots in appointment 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 in an appointment event
      effect: read
      questions:
      - What kinds of appointments can be booked in an appointment event?
      - Where do I get the appointment type ID needed to create an appointment?
      instructions:
      - text: List appointment types for appointment event {id}.
        slots:
          id: path.id
      - text: Show the meeting types offered in appointment event {id}.
        slots:
          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 a meeting between attendees in an appointment event?
      - Can I create an appointment without sending notifications to participants?
      - Is it possible to auto-accept an appointment when I book it?
      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: 'Create appointment {subject} of type {appointmentTypeId} in event {id} with attendees {attendees}, silently: {suppressNotifications}.'
        slots:
          subject: requestBody.subject
          appointmentTypeId: requestBody.appointmentTypeId
          id: path.id
          attendees: requestBody.attendees
          suppressNotifications: query.suppressNotifications
      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 change an appointment that's already been booked?
      - Can I update an appointment without notifying the participants?
      instructions:
      - text: Update appointment {apptId} in appointment event {id}.
        slots:
          apptId: path.apptId
          id: path.id
      - text: 'Modify appointment {apptId} in event {id} without 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 a meeting quietly 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}) 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}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment locations
      effect: read
      questions:
      - Which meeting locations are set up for an appointment event?
      - Where can appointments take place in a given appointment event?
      instructions:
      - text: List appointment locations in appointment event {id}.
        slots:
          id: path.id
      - text: Show the meeting spots configured for appointment event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/appointment-meeting-interests'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendee meeting interests
      effect: read
      questions:
      - Who has expressed interest in meeting whom during appointment scheduling?
      - Can I filter appointment meeting interests?
      instructions:
      - text: List appointment meeting interests.
      - text: List meeting interests matching {filter}.
        slots:
          filter: query.filter
      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:
      - How do I look up a single attendee's meeting interests by interest ID?
      - What does one meeting interest record show?
      instructions:
      - text: Get meeting interest {id}.
        slots:
          id: path.id
      - text: Show the attendee meeting interest with ID {id}.
        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 have been booked across my appointment events?
      - Can I list appointments scheduled after a certain date?
      instructions:
      - text: List all booked appointments.
      - text: List appointments changed 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:
      - How do I fetch the details of one appointment by ID?
      - Who is attending a specific appointment and when is it?
      instructions:
      - text: Get appointment {id}.
        slots:
          id: path.id
      - text: Show the time, location and attendees of appointment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'