# 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 Housing API
  version: 1.0.0
extends: openapi/cvent-event-cloud-housing-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: 21
- target: $.paths['/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an integration to a housing event
      effect: write
      questions:
      - How do I authorize my integration against a Passkey housing event?
      - What access code do I need from the event owner to connect?
      instructions:
      - text: Create a connection to the housing event using access code {accessCode}.
        slots:
          accessCode: header.Cvent-Access-Code
      - text: Link my integration to the Passkey event with owner-provided code {accessCode}.
        slots:
          accessCode: header.Cvent-Access-Code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List summaries of my housing events
      effect: read
      questions:
      - Which housing events do I have access to?
      - Can I get a quick summary of all my housing events?
      instructions:
      - text: List summaries of my housing events.
      - text: Show housing event summaries matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a housing event's details
      effect: read
      questions:
      - What are the dates and settings of a specific housing event?
      - Can I pull the full details for one housing event?
      instructions:
      - text: Get the details of housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show me everything about housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels'].get
  update:
    x-apievangelist-phrasing:
      intent: List hotels in a housing event
      effect: read
      questions:
      - Which hotels are part of my housing event's room block?
      - Can I get the hotel list in a specific language?
      instructions:
      - text: List the hotels in housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show housing event {housingEventId}'s hotels in locale {locale}.
        slots:
          housingEventId: path.housingEventId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one hotel's details in a housing event
      effect: read
      questions:
      - What information is available about a single hotel in the block?
      - Can I see one participating hotel's address and details?
      instructions:
      - text: Get hotel {hotelId} in housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show details for hotel {hotelId} of housing event {housingEventId} in {locale}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/available-nights'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a hotel's available room nights
      effect: read
      questions:
      - Which nights still have rooms available at a hotel in my block?
      - Can I filter a hotel's availability to certain dates?
      instructions:
      - text: Show available room nights at hotel {hotelId} for housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Check hotel {hotelId} availability in housing event {housingEventId} for {filter}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List a hotel's room types
      effect: read
      questions:
      - What room types does a hotel offer for my housing event?
      - Are suites or doubles available at a hotel in the block?
      instructions:
      - text: List room types at hotel {hotelId} in housing event {housingEventId}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Show hotel {hotelId}'s room types for housing event {housingEventId} matching {filter}.
        slots:
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types/{roomTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a room type's details
      effect: read
      questions:
      - What does a specific room type at a hotel include?
      - Can I look up the description of one hotel room type?
      instructions:
      - text: Get room type {roomTypeId} at hotel {hotelId} in housing event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Describe room type {roomTypeId} of hotel {hotelId}, housing event {housingEventId}, in {locale}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/hotels/{hotelId}/room-types/{roomTypeId}/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a room type's inventory by date
      effect: read
      questions:
      - How many rooms of a given type are blocked on each night?
      - Can I see date-by-date inventory for one room type?
      instructions:
      - text: Show nightly inventory for room type {roomTypeId} at hotel {hotelId}, housing event {housingEventId}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
      - text: Get room type {roomTypeId} inventory at hotel {hotelId} in housing event {housingEventId} for {filter}.
        slots:
          roomTypeId: path.roomTypeId
          hotelId: path.hotelId
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a housing event's inventory by date
      effect: read
      questions:
      - What's the overall room inventory across my whole housing event?
      - Can I see event-wide room block inventory sorted by date?
      instructions:
      - text: Show the date-sorted room inventory for all of housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Get event-wide inventory for housing event {housingEventId} matching {filter}.
        slots:
          housingEventId: path.housingEventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/housing-events/{housingEventId}/reservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List reservations in a housing event
      effect: read
      questions:
      - Who has booked hotel rooms through my housing event?
      - Can I list reservations made after a certain date?
      instructions:
      - text: List reservations for housing event {housingEventId}.
        slots:
          housingEventId: path.housingEventId
      - text: Show housing event {housingEventId} reservations changed after {after}.
        slots:
          housingEventId: path.housingEventId
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a hotel reservation request for a guest
      effect: write
      questions:
      - How do I send a registrant a personal hotel booking link?
      - Can I pre-fill guest details and room type in a reservation request?
      instructions:
      - text: Create a reservation request in housing event {housingEvent} for guests {guests}.
        slots:
          housingEvent: requestBody.housingEvent
          guests: requestBody.guests
      - text: Open a booking request for {guests} at hotel {hotel} in housing event {housingEvent} with special request {specialRequest}.
        slots:
          guests: requestBody.guests
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
          specialRequest: requestBody.specialRequest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reservation request
      effect: read
      questions:
      - What guest details are on a reservation request?
      - Can I check the status and booking link of a reservation request?
      instructions:
      - text: Get reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Show the booking site link and status of reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a reservation request
      effect: write
      questions:
      - If I change a reservation request, does it change the booked reservation too?
      - Can I update guest details on an existing reservation request?
      instructions:
      - text: Update reservation request {reservationRequestsId} with guests {guests}.
        slots:
          reservationRequestsId: path.reservationRequestsId
          guests: requestBody.guests
      - text: Set the status of reservation request {reservationRequestsId} to {status}.
        slots:
          reservationRequestsId: path.reservationRequestsId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a reservation request
      effect: destructive
      questions:
      - Does cancelling a reservation request cancel the hotel booking too?
      - How do I mark a guest's reservation request as cancelled?
      instructions:
      - text: Cancel reservation request {reservationRequestsId}.
        slots:
          reservationRequestsId: path.reservationRequestsId
      - text: Mark the guest booking request {reservationRequestsId} as cancelled.
        slots:
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}/reservations/{reservationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a reservation to a reservation request
      effect: write
      questions:
      - A guest booked by calling the hotel — how do I tie that reservation to their request?
      - Can I attach an existing reservation to a reservation request?
      instructions:
      - text: Link reservation {reservationId} to reservation request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      - text: Attach the phoned-in booking {reservationId} to request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservation-requests/{reservationRequestsId}/reservations/{reservationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a reservation from a reservation request
      effect: destructive
      questions:
      - How do I detach a cancelled reservation so a new one can be linked?
      - Can I remove a reservation from a reservation request without cancelling it?
      instructions:
      - text: Unlink reservation {reservationId} from reservation request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      - text: Detach the cancelled booking {reservationId} from request {reservationRequestsId}.
        slots:
          reservationId: path.reservationId
          reservationRequestsId: path.reservationRequestsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a hotel reservation in a housing event
      effect: write
      questions:
      - How do I book a hotel room directly in a housing event?
      - Can I create a reservation at a specific hotel through the API?
      instructions:
      - text: Book a reservation at hotel {hotel} in housing event {housingEvent}.
        slots:
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
      - text: Create a hotel booking at {hotel} for housing event {housingEvent} with {modifiers}.
        slots:
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
          modifiers: requestBody.modifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hotel reservation
      effect: read
      questions:
      - What are the details of a reservation after a Passkey callback?
      - Can I look up one hotel reservation by its ID?
      instructions:
      - text: Get reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Fetch the booking details for reservation {reservationId} from the callback.
        slots:
          reservationId: path.reservationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a hotel reservation
      effect: write
      questions:
      - Can I change an existing hotel reservation?
      - What do I send to modify a booked room reservation?
      instructions:
      - text: Update reservation {reservationId} at hotel {hotel} in housing event {housingEvent}.
        slots:
          reservationId: path.reservationId
          hotel: requestBody.hotel
          housingEvent: requestBody.housingEvent
      - text: Apply changes {modifiers} to booked reservation {reservationId} for housing event {housingEvent} at {hotel}.
        slots:
          modifiers: requestBody.modifiers
          reservationId: path.reservationId
          housingEvent: requestBody.housingEvent
          hotel: requestBody.hotel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/{reservationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a hotel reservation
      effect: destructive
      questions:
      - How do I cancel a guest's booked hotel room?
      - Can a hotel reservation be cancelled by ID?
      instructions:
      - text: Cancel hotel reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      - text: Cancel the booked room on reservation {reservationId}.
        slots:
          reservationId: path.reservationId
      method: generated
      generated: '2026-09-26'