Oracle Hospitality · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for OPERA Cloud Service Housekeeping API
61 actions
61 updates
phrasing
extends
openapi/oracle-hospitality-housekeeping-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Hospitality's API. It is a proposal applied on top of the contract, not a document Oracle Hospitality publishes.
What the actions change
x-apievangelist-phrasing
Targets 61 · first 16 shown; the file carries all of them
$.info
$.paths['/hotels/{hotelId}/attendants/houseKeepingTasks'].get
$.paths['/hotels/{hotelId}/attendants/houseKeepingTasks'].delete
$.paths['/hotels/{hotelId}/autoTaskSheets'].post
$.paths['/hotels/{hotelId}/conditions'].get
$.paths['/hotels/{hotelId}/conditions'].put
$.paths['/hotels/{hotelId}/forecastTaskSchedules'].get
$.paths['/hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId}'].delete
$.paths['/hotels/{hotelId}/houseKeepingtasks'].get
$.paths['/hotels/{hotelId}/housekeepingDiscrepancies'].get
$.paths['/hotels/{hotelId}/housekeepingOverview'].get
$.paths['/hotels/{hotelId}/maintenances/{mainteananceId}'].delete
$.paths['/hotels/{hotelId}/maintenances/{mainteananceId}/resolve'].put
$.paths['/hotels/{hotelId}/maintenances/{mainteananceId}/unResolve'].put
$.paths['/hotels/{hotelId}/moveTaskRooms'].put
$.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for OPERA Cloud Service Housekeeping API
version: 1.0.0
extends: openapi/oracle-hospitality-housekeeping-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: 60
- target: $.paths['/hotels/{hotelId}/attendants/houseKeepingTasks'].get
update:
x-apievangelist-phrasing:
intent: View the housekeeping attendants' work schedule
effect: read
questions:
- Which housekeeping attendants are scheduled to work at my hotel next week?
- Can I see the attendant schedule for up to a 30-day date range?
instructions:
- text: Show the housekeeping attendant schedule for hotel {hotelId} starting {scheduleStartDate}.
slots:
hotelId: path.hotelId
scheduleStartDate: query.scheduleStartDate
- text: List which attendants are rostered at {hotelId} between {scheduleStartDate} and {scheduleEndDate}.
slots:
hotelId: path.hotelId
scheduleStartDate: query.scheduleStartDate
scheduleEndDate: query.scheduleEndDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/attendants/houseKeepingTasks'].delete
update:
x-apievangelist-phrasing:
intent: Remove an attendant's schedule for a day
effect: destructive
questions:
- How do I take a housekeeping attendant off the schedule for a specific day?
- Can I delete one attendant's shift without touching the rest of the roster?
instructions:
- text: Delete attendant {attendantId}'s housekeeping schedule on {scheduleDate} at hotel {hotelId}.
slots:
attendantId: query.attendantId
scheduleDate: query.scheduleDate
hotelId: path.hotelId
- text: Unschedule attendant {attendantId} for {scheduleDate}.
slots:
attendantId: query.attendantId
scheduleDate: query.scheduleDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTaskSheets'].post
update:
x-apievangelist-phrasing:
intent: Automatically generate housekeeping task sheets
effect: write
questions:
- Can OPERA build the day's housekeeping task sheets for me automatically?
- Is there a way to auto-split rooms into attendant task sheets instead of making them by hand?
instructions:
- text: Auto-generate today's housekeeping task sheets for hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Automatically create attendant task sheets for {hotelId} using the default criteria.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/conditions'].get
update:
x-apievangelist-phrasing:
intent: List rooms that have a room condition set
effect: read
questions:
- Which rooms at my hotel currently have a condition like show room or set aside?
- Can I filter rooms by condition, floor or room type to see which ones are flagged?
instructions:
- text: List rooms with a condition set at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Show rooms on floor {floors} at {hotelId} that carry condition {roomConditions}.
slots:
floors: query.floors
hotelId: path.hotelId
roomConditions: query.roomConditions
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/conditions'].put
update:
x-apievangelist-phrasing:
intent: Set, change or clear a condition on rooms
effect: write
questions:
- How do I mark a room as set aside for a show or special use?
- Can I change or clear the condition that's on a room?
instructions:
- text: Set a room condition on the selected rooms at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Clear the existing condition from the rooms I specify at {hotelId}.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/forecastTaskSchedules'].get
update:
x-apievangelist-phrasing:
intent: Forecast housekeeping attendants and tasks needed
effect: read
questions:
- How many housekeeping attendants will I need over the next few days?
- Can I forecast facility tasks for a future start date and duration?
instructions:
- text: Get the housekeeping facility forecast for hotel {hotelId} from {startDate} to {endDate}.
slots:
hotelId: path.hotelId
startDate: query.startDate
endDate: query.endDate
- text: Forecast attendant and task needs at {hotelId} for {duration} days starting {startDate}.
slots:
hotelId: path.hotelId
duration: query.duration
startDate: query.startDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/houseKeepingTasks/{taskCodesBreakOutId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete every task sheet in a task sheet set
effect: destructive
questions:
- Can I wipe out all task sheets in a task sheet set at once?
- What happens if I delete a whole task sheet set's sheets and need to regenerate them?
instructions:
- text: Delete all task sheets in task sheet set {taskCodesBreakOutId} at hotel {hotelId}.
slots:
taskCodesBreakOutId: path.taskCodesBreakOutId
hotelId: path.hotelId
- text: Remove every sheet belonging to break-out set {taskCodesBreakOutId}.
slots:
taskCodesBreakOutId: path.taskCodesBreakOutId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/houseKeepingtasks'].get
update:
x-apievangelist-phrasing:
intent: Get the existing housekeeping task sheets for a date
effect: read
questions:
- What task sheets have been created for housekeeping today?
- Can I get the task sheets sorted by cleaning sequence with reservation info included?
instructions:
- text: Show the housekeeping task sheets for hotel {hotelId} on {taskDate}.
slots:
hotelId: path.hotelId
taskDate: query.taskDate
- text: Get {taskDate}'s task sheets for task code {taskCodes}, sorted by cleaning sequence.
slots:
taskDate: query.taskDate
taskCodes: query.taskCodes
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/housekeepingDiscrepancies'].get
update:
x-apievangelist-phrasing:
intent: Find rooms with housekeeping status discrepancies
effect: read
questions:
- Which rooms have a mismatch between housekeeping and front office status, like a skip or sleep?
- Can I list discrepant rooms on one floor or only those due out?
instructions:
- text: List housekeeping discrepant rooms at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Show rooms with discrepancy status {roomDiscrepancyStatus} on floor {floor}.
slots:
roomDiscrepancyStatus: query.roomDiscrepancyStatus
floor: query.floor
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/housekeepingOverview'].get
update:
x-apievangelist-phrasing:
intent: Get an overview of room housekeeping statuses
effect: read
questions:
- What's the current clean, dirty or inspected status of every room in the hotel?
- Can I see turndown and service request status alongside room status in one view?
instructions:
- text: Give me the housekeeping rooms overview for hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Show rooms at {hotelId} whose housekeeping status is {housekeepingRoomStatus}.
slots:
hotelId: path.hotelId
housekeepingRoomStatus: query.housekeepingRoomStatus
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/maintenances/{mainteananceId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a room maintenance record
effect: destructive
questions:
- How do I delete a maintenance entry that was logged against a room by mistake?
- Can a room maintenance request be removed entirely rather than resolved?
instructions:
- text: Delete maintenance {mainteananceId} at hotel {hotelId}.
slots:
mainteananceId: path.mainteananceId
hotelId: path.hotelId
- text: Remove room maintenance record {mainteananceId} permanently.
slots:
mainteananceId: path.mainteananceId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/maintenances/{mainteananceId}/resolve'].put
update:
x-apievangelist-phrasing:
intent: Mark a room maintenance request as resolved
effect: write
questions:
- How do I close out a room maintenance issue once engineering has fixed it?
- Can I mark a maintenance request on a room as resolved?
instructions:
- text: Resolve maintenance {mainteananceId} at hotel {hotelId}.
slots:
mainteananceId: path.mainteananceId
hotelId: path.hotelId
- text: Mark room maintenance {mainteananceId} as fixed.
slots:
mainteananceId: path.mainteananceId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/maintenances/{mainteananceId}/unResolve'].put
update:
x-apievangelist-phrasing:
intent: Reopen a resolved room maintenance request
effect: write
questions:
- What if a maintenance issue was marked resolved but the problem came back?
- Can I undo the resolved status on a room maintenance request?
instructions:
- text: Unresolve maintenance {mainteananceId} at hotel {hotelId}.
slots:
mainteananceId: path.mainteananceId
hotelId: path.hotelId
- text: Reopen resolved room maintenance {mainteananceId}.
slots:
mainteananceId: path.mainteananceId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/moveTaskRooms'].put
update:
x-apievangelist-phrasing:
intent: Move rooms between housekeeping task sheets
effect: write
questions:
- Can I move a room from one attendant's task sheet to another's?
- How would I rebalance rooms across task sheets after they're generated?
instructions:
- text: Move the selected task sheet rooms to another sheet at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Reassign rooms between attendants' task sheets at {hotelId}.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes'].get
update:
x-apievangelist-phrasing:
intent: Read a guest's housekeeping instructions
effect: read
questions:
- Did this guest leave any housekeeping instructions, like do not disturb or service times?
- What housekeeping notes are on a reservation?
instructions:
- text: Show the guest housekeeping instructions on reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Get housekeeping notes for reservation {reservationId}.
slots:
reservationId: path.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingNotes'].put
update:
x-apievangelist-phrasing:
intent: Set a guest's housekeeping instructions
effect: write
questions:
- How do I record that a guest wants housekeeping only in the afternoon?
- Can I add housekeeping instructions to a reservation?
instructions:
- text: Set housekeeping instructions {guestHousekeepingInstructions} on reservation {reservationId}.
slots:
guestHousekeepingInstructions: requestBody.guestHousekeepingInstructions
reservationId: path.reservationId
- text: Save guest housekeeping notes for reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules'].get
update:
x-apievangelist-phrasing:
intent: View a reservation's housekeeping schedule
effect: read
questions:
- When is housekeeping scheduled to service this guest's room during their stay?
- Can I see a reservation's cleaning schedule between two dates?
instructions:
- text: Show the housekeeping schedule for reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Get reservation {reservationId}'s housekeeping tasks from {beginDate} to {endDate}.
slots:
reservationId: path.reservationId
beginDate: query.beginDate
endDate: query.endDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules'].put
update:
x-apievangelist-phrasing:
intent: Update a reservation's scheduled housekeeping tasks
effect: write
questions:
- Can I change the housekeeping tasks already scheduled for a guest's stay?
- How would I edit the cleaning frequency on an existing reservation schedule?
instructions:
- text: Update the existing housekeeping tasks on reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Change reservation {reservationId}'s housekeeping schedule to {housekeepingSchedule}.
slots:
reservationId: path.reservationId
housekeepingSchedule: requestBody.housekeepingSchedule
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules'].post
update:
x-apievangelist-phrasing:
intent: Add housekeeping tasks to a reservation
effect: write
questions:
- How do I schedule extra housekeeping tasks for a guest's reservation?
- Can I create a new cleaning task schedule for a reservation that has none?
instructions:
- text: Create housekeeping tasks for reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Add a new housekeeping schedule {housekeepingSchedule} to reservation {reservationId}.
slots:
housekeepingSchedule: requestBody.housekeepingSchedule
reservationId: path.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules'].delete
update:
x-apievangelist-phrasing:
intent: Delete a housekeeping task from a reservation
effect: destructive
questions:
- Can I remove a scheduled housekeeping task from a guest's stay?
- What do I specify to delete one facility task on a reservation by task code and date?
instructions:
- text: Delete the housekeeping task on reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Remove task {facilityTaskCode} on {taskDate} from reservation {reservationId}.
slots:
facilityTaskCode: query.facilityTaskCode
taskDate: query.taskDate
reservationId: path.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/reset'].put
update:
x-apievangelist-phrasing:
intent: Reset a reservation's housekeeping schedule
effect: write
questions:
- How do I put a reservation's cleaning schedule back to the default?
- Can I undo custom housekeeping changes on a guest's stay?
instructions:
- text: Reset the housekeeping schedule for reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Restore reservation {reservationId}'s default cleaning schedule.
slots:
reservationId: path.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservations/{reservationId}/houseKeepingTaskSchedules/shift'].put
update:
x-apievangelist-phrasing:
intent: Shift a reservation's housekeeping schedule
effect: write
questions:
- The guest's dates moved; can I shift their housekeeping schedule to match?
- Is it possible to push a reservation's cleaning days later?
instructions:
- text: Shift the housekeeping schedule for reservation {reservationId} at hotel {hotelId}.
slots:
reservationId: path.reservationId
hotelId: path.hotelId
- text: Move reservation {reservationId}'s cleaning days forward.
slots:
reservationId: path.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/cleaningPriority'].delete
update:
x-apievangelist-phrasing:
intent: Remove a room's cleaning priority
effect: destructive
questions:
- How do I take a room off the priority cleaning list?
- Can I clear the rush-clean priority once a room no longer needs it?
instructions:
- text: Remove the cleaning priority from room {roomId} at hotel {hotelId}.
slots:
roomId: query.roomId
hotelId: path.hotelId
- text: Clear priority cleaning on room {roomId}.
slots:
roomId: query.roomId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/maintenanceCodes/{maintenanceCode}'].post
update:
x-apievangelist-phrasing:
intent: Log a maintenance request against rooms
effect: write
questions:
- How do I report a broken AC or leaky tap as a maintenance issue on a room?
- Can I log the same maintenance code on several rooms at once?
instructions:
- text: Create a maintenance request with code {maintenanceCode} for rooms at hotel {hotelId}.
slots:
maintenanceCode: path.maintenanceCode
hotelId: path.hotelId
- text: Log maintenance {maintenanceCode} on the rooms I list.
slots:
maintenanceCode: path.maintenanceCode
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/maintenances'].get
update:
x-apievangelist-phrasing:
intent: List rooms with maintenance requests
effect: read
questions:
- Which rooms have open maintenance issues right now?
- Can I filter room maintenance by code, status or who it's assigned to?
instructions:
- text: List rooms with maintenance at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Show room maintenance with status {roomMaintenanceStatus} and code {maintenanceCodes}.
slots:
roomMaintenanceStatus: query.roomMaintenanceStatus
maintenanceCodes: query.maintenanceCodes
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfOrderRooms'].get
update:
x-apievangelist-phrasing:
intent: List rooms that are Out of Order
effect: read
questions:
- Which rooms are Out of Order and can't be sold right now?
- Can I narrow the Out of Order list by room class or room type?
instructions:
- text: List Out of Order rooms at hotel {hotelId} from {startDate}.
slots:
hotelId: path.hotelId
startDate: query.startDate
- text: Show Out of Order rooms of type {roomTypes} between {startDate} and {endDate}.
slots:
roomTypes: query.roomTypes
startDate: query.startDate
endDate: query.endDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfOrderRooms'].put
update:
x-apievangelist-phrasing:
intent: Return Out of Order rooms to service
effect: write
questions:
- How do I put an Out of Order room back into inventory once it's repaired?
- What status does a room get when it's no longer Out of Order?
instructions:
- text: Complete the Out of Order period on the rooms I specify at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Release Out of Order rooms at {hotelId} and mark them available for guests.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfOrderRooms'].post
update:
x-apievangelist-phrasing:
intent: Set rooms to Out of Order
effect: write
questions:
- How do I take several rooms Out of Order for a renovation?
- Can I update an existing Out of Order period on a room?
instructions:
- text: Set the rooms I list to Out of Order at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Put rooms at {hotelId} Out of Order for the dates and reason I give.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfServiceRooms'].get
update:
x-apievangelist-phrasing:
intent: List rooms that are Out of Service
effect: read
questions:
- Which rooms are Out of Service at the moment?
- Can I see Out of Service rooms for a date range, filtered by room class?
instructions:
- text: List Out of Service rooms at hotel {hotelId} from {startDate}.
slots:
hotelId: path.hotelId
startDate: query.startDate
- text: Show Out of Service rooms in class {roomClasses} between {startDate} and {endDate}.
slots:
roomClasses: query.roomClasses
startDate: query.startDate
endDate: query.endDate
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfServiceRooms'].put
update:
x-apievangelist-phrasing:
intent: Return Out of Service rooms to use
effect: write
questions:
- How do I end the Out of Service status on a room that's ready again?
- What housekeeping status should a room take when it comes back from Out of Service?
instructions:
- text: Complete the Out of Service period on the rooms I specify at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Bring Out of Service rooms at {hotelId} back into use.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/outOfServiceRooms'].post
update:
x-apievangelist-phrasing:
intent: Set rooms to Out of Service
effect: write
questions:
- Can I mark a few rooms Out of Service rather than Out of Order?
- How do I change the dates on an existing Out of Service room?
instructions:
- text: Set the rooms I list to Out of Service at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Mark rooms at {hotelId} Out of Service, not Out of Order, for the dates and reason I give.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/status'].put
update:
x-apievangelist-phrasing:
intent: Update housekeeping status for multiple rooms
effect: write
questions:
- How do I mark a batch of rooms as clean or inspected?
- Can I update turndown status along with the housekeeping status?
instructions:
- text: Set rooms {roomList} to housekeeping status {housekeepingRoomStatus}.
slots:
roomList: requestBody.roomList
housekeepingRoomStatus: requestBody.housekeepingRoomStatus
- text: Mark the rooms I list at hotel {hotelId} as dirty.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/cleaningPriority'].put
update:
x-apievangelist-phrasing:
intent: Give a room cleaning priority
effect: write
questions:
- How do I flag a room so housekeeping cleans it first?
- Can I rush a room for an early arrival?
instructions:
- text: Set cleaning priority on room {roomId} at hotel {hotelId}.
slots:
roomId: path.roomId
hotelId: path.hotelId
- text: Make room {roomId} a priority clean.
slots:
roomId: path.roomId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/maintenances/{maintenanceId}'].put
update:
x-apievangelist-phrasing:
intent: Change a maintenance request on a room
effect: write
questions:
- Can I edit the details of a maintenance request already logged on a room?
- How would I reassign or update an existing room maintenance entry?
instructions:
- text: Update maintenance {maintenanceId} on room {roomId} at hotel {hotelId}.
slots:
maintenanceId: path.maintenanceId
roomId: path.roomId
hotelId: path.hotelId
- text: Change the details of room {roomId}'s maintenance {maintenanceId}.
slots:
roomId: path.roomId
maintenanceId: path.maintenanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}'].put
update:
x-apievangelist-phrasing:
intent: Cancel servicing of a room on a task sheet
effect: write
questions:
- An attendant started a room by mistake; can I cancel the servicing?
- How do I cancel service on a room that's on a task sheet?
instructions:
- text: Cancel servicing of room {roomId} on task sheet {sheetNumber} at hotel {hotelId}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
hotelId: path.hotelId
- text: Stop the in-progress service on room {roomId}, sheet {sheetNumber}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/complete'].put
update:
x-apievangelist-phrasing:
intent: Mark a task sheet room as serviced
effect: write
questions:
- How does an attendant record that they finished cleaning a room?
- Can I complete a room on a task sheet from a mobile app?
instructions:
- text: Complete servicing of room {roomId} on task sheet {sheetNumber} at hotel {hotelId}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
hotelId: path.hotelId
- text: Mark room {roomId} on sheet {sheetNumber} as done.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/skip'].put
update:
x-apievangelist-phrasing:
intent: Skip a room on a housekeeping task sheet
effect: write
questions:
- What if the attendant can't get into a room; can they skip it?
- Can I skip a room on a task sheet and come back later?
instructions:
- text: Skip room {roomId} on task sheet {sheetNumber} at hotel {hotelId}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
hotelId: path.hotelId
- text: Pass over room {roomId} on sheet {sheetNumber} for now.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/rooms/{roomId}/sheets/{sheetNumber}/start'].put
update:
x-apievangelist-phrasing:
intent: Start servicing a room on a task sheet
effect: write
questions:
- How does an attendant clock in to a room when they begin cleaning?
- Can I record that servicing has started on a task sheet room?
instructions:
- text: Start servicing room {roomId} on task sheet {sheetNumber} at hotel {hotelId}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
hotelId: path.hotelId
- text: Begin cleaning room {roomId} on sheet {sheetNumber}.
slots:
roomId: path.roomId
sheetNumber: path.sheetNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/schedules/houseKeepingTasks'].post
update:
x-apievangelist-phrasing:
intent: Schedule housekeeping attendants
effect: write
questions:
- How do I roster housekeeping attendants for upcoming days?
- Can I add attendants to the housekeeping work schedule?
instructions:
- text: Create a housekeeping attendant schedule at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Add attendant shifts {attendantsScheduleInfo} to the housekeeping roster.
slots:
attendantsScheduleInfo: requestBody.attendantsScheduleInfo
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/serviceRequests'].put
update:
x-apievangelist-phrasing:
intent: Set guest housekeeping service requests on rooms
effect: write
questions:
- How do I mark a room as Do Not Disturb or Make Up Room?
- Can I record a guest's housekeeping service request status?
instructions:
- text: Set the guest housekeeping service request on the rooms I list at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Flag the given rooms at {hotelId} as Make Up Room.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/sheets/{sheetNumber}'].get
update:
x-apievangelist-phrasing:
intent: Get an attendant's task companion view of a sheet
effect: read
questions:
- What rooms does an attendant still have left on their task sheet?
- Can the task companion include maintenance and queue details for each room?
instructions:
- text: Open the task companion for sheet {sheetNumber} with task code {taskCodes} at hotel {hotelId}.
slots:
sheetNumber: path.sheetNumber
taskCodes: query.taskCodes
hotelId: path.hotelId
- text: Show attendant sheet {sheetNumber}'s rooms for task {taskCodes} on {taskDate}, including completed rooms.
slots:
sheetNumber: path.sheetNumber
taskCodes: query.taskCodes
taskDate: query.taskDate
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/overlays/oracle-hospitality-housekeeping-api-phrasing-overlay.yaml