Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Inventory INV Stats API

5 actions 5 updates phrasing extends openapi/oracle-hospitality-invstats-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['/blockInventoryStatistics'].get

$.paths['/hotels/{hotelId}/blockInventoryStatistics'].get

$.paths['/hotels/{hotelId}/inventoryStatistics'].get

$.paths['/services/invStatsService/status'].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 Inventory INV Stats API
  version: 1.0.0
extends: openapi/oracle-hospitality-invstats-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['/blockInventoryStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get group block inventory across several hotels
      effect: read
      questions:
      - How many rooms are held in group blocks across all my hotels?
      - Can block inventory for several properties include tentative and overbooked rooms?
      instructions:
      - text: Get block inventory statistics for hotels {hotelIds}.
        slots:
          hotelIds: query.hotelIds
      - text: Show block inventory for {hotelIds} from {startDateRange} to {endDateRange}, including tentative.
        slots:
          hotelIds: query.hotelIds
          startDateRange: query.startDateRange
          endDateRange: query.endDateRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/blockInventoryStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get group block inventory for one hotel
      effect: read
      questions:
      - What's the group block room inventory at a single property?
      - Can I filter a hotel's block inventory by block status?
      instructions:
      - text: Get block inventory statistics for hotel {hotelId}.
        slots:
          hotelId: path.hotelId
      - text: Show {hotelId}'s block inventory with status {blockStatusCodes} starting {startDateRange}.
        slots:
          hotelId: path.hotelId
          blockStatusCodes: query.blockStatusCodes
          startDateRange: query.startDateRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/inventoryStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hotel's inventory statistics report
      effect: read
      questions:
      - What's my hotel's room inventory and availability for the next month?
      - Which report code do I need to pull inventory statistics for a date range?
      instructions:
      - text: Get inventory statistics report {reportCode} for hotel {hotelId} from {dateRangeStart} to {dateRangeEnd}.
        slots:
          reportCode: query.reportCode
          hotelId: path.hotelId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      - text: Run the {reportCode} inventory report at {hotelId} for {dateRangeStart} through {dateRangeEnd}.
        slots:
          reportCode: query.reportCode
          hotelId: path.hotelId
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/invStatsService/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the inventory statistics service health
      effect: read
      questions:
      - Is the inventory statistics service up?
      - Can I ping the inventory stats API?
      instructions:
      - text: Ping the inventory statistics service.
      - text: Check inventory stats API health for hotel {hotelid}.
        slots:
          hotelid: header.x-hotelid
      method: generated
      generated: '2026-09-26'