Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Front Desk Operations Service FOF Stats API

8 actions 8 updates phrasing extends openapi/oracle-hospitality-fofstats-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}'].get
$.paths['/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}'].get
$.paths['/hotels/{hotelId}/houseKeepingStatistics'].get
$.paths['/hotels/{hotelId}/queueReservationsStatistics'].get
$.paths['/hotels/{hotelId}/reservationStatusStatistics'].get
$.paths['/hotels/{hotelId}/roomStatusStatistics'].get
$.paths['/services/fofStats/status'].get

OpenAPI Overlay

Raw ↑
# 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 Front Desk Operations Service FOF Stats API
  version: 1.0.0
extends: openapi/oracle-hospitality-fofstats-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: 7
- target: $.paths['/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get front office statistics for a date
      effect: read
      questions:
      - What are today's front office numbers, like arrivals and occupancy, for my hotel?
      - Can I break a front office statistic down by room class for a single date?
      instructions:
      - text: Get front office statistic {stat_code} for hotel {hotel} on {date}.
        slots:
          stat_code: path.statisticsCode
          hotel: path.hotelId
          date: query.date
      - text: Show {stat_code} statistics at hotel {hotel} for room classes {room_classes}.
        slots:
          stat_code: path.statisticsCode
          hotel: path.hotelId
          room_classes: query.roomClasses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get front office statistics over a date range
      effect: read
      questions:
      - How did front office statistics trend across a range of dates at my property?
      - Can I pull a front office statistic from a start date through an end date?
      instructions:
      - text: Get front office statistic {stat_code} for hotel {hotel} from {start} to {end}.
        slots:
          stat_code: path.statisticsCode
          hotel: path.hotelId
          start: query.date
          end: query.endDate
      - text: Show the {stat_code} range statistics at hotel {hotel} through {end}.
        slots:
          stat_code: path.statisticsCode
          hotel: path.hotelId
          end: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/houseKeepingStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get housekeeping task sheet statistics
      effect: read
      questions:
      - How are housekeeping task sheets progressing at my property today?
      - Can I include task sheet details or filter housekeeping stats by task code?
      instructions:
      - text: Show housekeeping statistics for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Get housekeeping task sheet stats for task {task_code} at hotel {hotel}.
        slots:
          task_code: query.taskCode
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/queueReservationsStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reservation queue statistics
      effect: read
      questions:
      - How many reservations are waiting in the room queue at my hotel?
      - What do the queue reservation statistics look like right now?
      instructions:
      - text: Show reservation queue statistics for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Count queued reservations at hotel {hotel}.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/reservationStatusStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Count reservations by status per room type
      effect: read
      questions:
      - How many reservations in a given status are there for each room type?
      - Can I see due-in or in-house counts broken down by room type?
      instructions:
      - text: Count {status} reservations per room type at hotel {hotel}.
        slots:
          status: query.reservationStatus
          hotel: path.hotelId
      - text: Show reservation status statistics for {status} at hotel {hotel}.
        slots:
          status: query.reservationStatus
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/roomStatusStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Count rooms by housekeeping and front office status
      effect: read
      questions:
      - How many rooms are clean, dirty or inspected right now, grouped by room type?
      - Can I filter room status counts by front office status like vacant or occupied?
      instructions:
      - text: Count rooms by housekeeping status at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Show room status counts for {fo_status} rooms at hotel {hotel}.
        slots:
          fo_status: query.frontOfficeStatus
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/fofStats/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the front office statistics service
      effect: read
      questions:
      - Is the front office statistics service reachable?
      - How do I health-check the FOF stats service?
      instructions:
      - text: Ping the front office stats service.
      - text: Check FOF stats service status for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'