Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Reservation RSV Stats API

5 actions 5 updates phrasing extends openapi/oracle-hospitality-rsvstats-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 5

$.info
$.paths['/blockReservationStatisticsByDateAndRoomPool'].get
$.paths['/reservations/pace'].get
$.paths['/reservations/statistics'].get
$.paths['/services/rsvStats/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 Reservation RSV Stats API
  version: 1.0.0
extends: openapi/oracle-hospitality-rsvstats-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: 4
- target: $.paths['/blockReservationStatisticsByDateAndRoomPool'].get
  update:
    x-apievangelist-phrasing:
      intent: Get group block reservation stats by date
      effect: read
      questions:
      - How many rooms are picked up in group blocks per day and room pool?
      - Can I leave out blocks that have no quote ID from the block statistics?
      - What is the longest time span block reservation stats will cover?
      instructions:
      - text: Show block reservation statistics by date and room pool from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Get block stats by room pool for {duration} starting {startDate}, excluding blocks without a quote ID.
        slots:
          duration: query.duration
          startDate: query.startDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/pace'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reservation booking pace
      effect: read
      questions:
      - How fast are reservations coming in for a given stay date?
      - Can I break booking pace down by channel and lead days?
      instructions:
      - text: Show reservation pace for hotel {hotelId} for stay date {stayDate}.
        slots:
          hotelId: query.hotelId
          stayDate: query.stayDate
      - text: Get booking pace for {stayDate} at {leadDays} lead days on channels {channels}.
        slots:
          stayDate: query.stayDate
          leadDays: query.leadDays
          channels: query.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reservations/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a reservation statistics report
      effect: read
      questions:
      - What reservation statistics can I pull for a hotel over a date range?
      - Is there a maximum period for a reservation statistics report?
      - Can I run reservation stats for all hotels in a city or chain?
      instructions:
      - text: Run reservation statistics report {reportCode} for hotel {hotelId} from {requestedReportsTypeStartDate} to {requestedReportsTypeEndDate}.
        slots:
          reportCode: query.reportCode
          hotelId: query.hotelId
          requestedReportsTypeStartDate: query.requestedReportsTypeStartDate
          requestedReportsTypeEndDate: query.requestedReportsTypeEndDate
      - text: Get reservation statistics for chain {chainName} hotels in city {hotelCityCode}.
        slots:
          chainName: query.chainName
          hotelCityCode: query.hotelCityCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/rsvStats/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check reservation statistics service version
      effect: read
      questions:
      - Is the reservation statistics service reachable?
      - Which version of the RSV Stats service is running?
      instructions:
      - text: Ping the reservation statistics service.
      - text: Get the RSV Stats service version for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'