Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Hospitality Inventory API

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

$.info
$.paths['/hotels/{hotelId}/channel/sellLimits'].get
$.paths['/hotels/{hotelId}/channelSellLimits'].put
$.paths['/hotels/{hotelId}/channelSellLimits/{Id}'].delete
$.paths['/hotels/{hotelId}/channels/{channelId}/channelSellLimitsByDateRange'].put
$.paths['/hotels/{hotelId}/hotelInventory'].get
$.paths['/hotels/{hotelId}/itemInventory'].get
$.paths['/hotels/{hotelId}/itemInventoryHold'].get
$.paths['/hotels/{hotelId}/itemInventoryHold'].put
$.paths['/hotels/{hotelId}/itemInventoryHold'].post
$.paths['/hotels/{hotelId}/sellLimits'].put
$.paths['/hotels/{hotelId}/sellLimitsByDateRange'].put
$.paths['/releasedItemInventory'].put
$.paths['/services/inventory/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 Oracle Hospitality Inventory API
  version: 1.0.0
extends: openapi/oracle-hospitality-inventory-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: 13
- target: $.paths['/hotels/{hotelId}/channel/sellLimits'].get
  update:
    x-apievangelist-phrasing:
      intent: Review daily sell limits for a channel
      effect: read
      questions:
      - How many rooms is a booking channel allowed to sell at my hotel each day?
      - Can I see a channel's daily sell limits for one channel room type?
      instructions:
      - text: Show channel sell limits for hotel {hotel} starting {from}.
        slots:
          hotel: path.hotelId
          from: query.fromDate
      - text: Get daily sell limits for channel {channel} at {hotel} from {from} for room type {roomType}.
        slots:
          channel: query.bookingChannelCode
          hotel: path.hotelId
          from: query.fromDate
          roomType: query.channelRoomType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/channelSellLimits'].put
  update:
    x-apievangelist-phrasing:
      intent: Set channel sell limits on specific dates
      effect: write
      questions:
      - How do I change a channel's sell limit for individual dates?
      - Can I adjust overlapping schedules when I update channel sell limits by date?
      instructions:
      - text: Update channel sell limits at hotel {hotel} for specific dates with {limits}.
        slots:
          hotel: path.hotelId
          limits: requestBody.sellLimits
      - text: Set per-date channel sell limits for {hotel} and adjust overlapping schedules.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/channelSellLimits/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel sell limit mapping
      effect: destructive
      questions:
      - How do I remove a channel sell limit mapping I no longer need?
      - Can I delete one channel's sell limit entry for a hotel?
      instructions:
      - text: Delete channel sell limit {id} at hotel {hotel}.
        slots:
          id: path.Id
          hotel: path.hotelId
      - text: Remove the channel sell limit mapping {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/channels/{channelId}/channelSellLimitsByDateRange'].put
  update:
    x-apievangelist-phrasing:
      intent: Set channel sell limits over a date range
      effect: write
      questions:
      - How do I apply the same sell limit to a channel across a whole date range?
      - Can I cap a channel's allotment for a season in one update?
      instructions:
      - text: Set sell limits for channel {channel} at hotel {hotel} across a date range with {limits}.
        slots:
          channel: path.channelId
          hotel: path.hotelId
          limits: requestBody.sellLimits
      - text: Apply a date-range sell limit for channel {channel} at {hotel}.
        slots:
          channel: path.channelId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/hotelInventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get room inventory for a hotel
      effect: read
      questions:
      - How many rooms does my hotel have available over a set of dates?
      - Can I include tentative inventory and overbooking when checking hotel availability?
      - What does the hotel's room inventory look like by room class?
      instructions:
      - text: Get room inventory for hotel {hotel} from {start} to {end} for {rooms} rooms.
        slots:
          hotel: path.hotelId
          start: query.dateRangeStart
          end: query.dateRangeEnd
          rooms: query.roomCountRequested
      - text: Show daily inventory at {hotel} for room types {roomTypes} between {start} and {end} needing {rooms} rooms.
        slots:
          hotel: path.hotelId
          roomTypes: query.roomTypes
          start: query.dateRangeStart
          end: query.dateRangeEnd
          rooms: query.roomCountRequested
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/itemInventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get item inventory for a date range
      effect: read
      questions:
      - How many rollaway beds or other inventory items are free at my hotel next week?
      - Can I check item inventory filtered by item class or item pool?
      instructions:
      - text: Show item inventory at hotel {hotel} from {start} to {end}.
        slots:
          hotel: path.hotelId
          start: query.startDate
          end: query.endDate
      - text: Check availability of item {item} at {hotel} starting {start}.
        slots:
          item: query.itemCode
          hotel: path.hotelId
          start: query.startDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/itemInventoryHold'].get
  update:
    x-apievangelist-phrasing:
      intent: List item inventory currently on hold
      effect: read
      questions:
      - Which inventory items are currently being held at my hotel?
      - Can I look up a specific item hold by its hold id?
      instructions:
      - text: List held item inventory at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Get item hold {hold} at {hotel}.
        slots:
          hold: query.itemHoldId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/itemInventoryHold'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing item inventory hold
      effect: write
      questions:
      - How do I modify the quantity or dates of items I already put on hold?
      - Can I edit an item inventory hold after it was created?
      instructions:
      - text: Update the existing item hold at hotel {hotel} with {holdInfo}.
        slots:
          hotel: path.hotelId
          holdInfo: requestBody.holdItemInfo
      - text: Change the dates on an item inventory hold at {hotel}.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/itemInventoryHold'].post
  update:
    x-apievangelist-phrasing:
      intent: Place item inventory on hold
      effect: write
      questions:
      - How do I reserve inventory items like cribs so nobody else books them?
      - Is the item hold id generated for me when I create a new hold?
      instructions:
      - text: Put a new item inventory hold at hotel {hotel} with {holdInfo}.
        slots:
          hotel: path.hotelId
          holdInfo: requestBody.holdItemInfo
      - text: Hold two rollaway beds at {hotel} for this stay.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/sellLimits'].put
  update:
    x-apievangelist-phrasing:
      intent: Set hotel sell limits on specific dates
      effect: write
      questions:
      - How do I cap how many rooms my hotel sells on particular dates?
      - Can I create house sell limits one date at a time?
      instructions:
      - text: Set hotel sell limits by date for {hotel} with {limits}.
        slots:
          hotel: path.hotelId
          limits: requestBody.sellLimitsByDate
      - text: Create per-date sell limits at {hotel} for New Year's Eve.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/sellLimitsByDateRange'].put
  update:
    x-apievangelist-phrasing:
      intent: Set hotel sell limits over a date range
      effect: write
      questions:
      - Can I apply one sell limit to every night in a date range at my hotel?
      - How do I set house sell limits for a whole season at once?
      instructions:
      - text: Set hotel sell limits across a date range for {hotel} with {limits}.
        slots:
          hotel: path.hotelId
          limits: requestBody.sellLimitsByDateRange
      - text: Create a date-range sell limit at {hotel} for the summer season.
        slots:
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/releasedItemInventory'].put
  update:
    x-apievangelist-phrasing:
      intent: Release held item inventory
      effect: write
      questions:
      - How do I give back inventory items I had put on hold?
      - Can I release a held item by its item code for certain dates?
      instructions:
      - text: Release item hold {hold} at hotel {hotel}.
        slots:
          hold: requestBody.itemHoldId
          hotel: requestBody.hotelId
      - text: Release held item {item} for dates {dates}.
        slots:
          item: requestBody.itemCode
          dates: requestBody.reserveDates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/inventory/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the inventory service is up
      effect: read
      questions:
      - Is the OPERA inventory service responding right now?
      - What version of the inventory service am I talking to?
      instructions:
      - text: Ping the inventory service.
      - text: Check the health of the inventory API for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'