Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Distribution Outbound Lookup API

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

$.info
$.paths['/hotels/{hotelCode}/externalRoomTypes'].get
$.paths['/hotels/{hotelCode}/externalRatePlans'].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 Distribution Outbound Lookup API
  version: 1.0.0
extends: openapi/oracle-hospitality-lookup-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: 2
- target: $.paths['/hotels/{hotelCode}/externalRoomTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel partner's room types for a hotel
      effect: read
      questions:
      - Which room types does a channel partner map for my hotel in OPERA Cloud Distribution?
      - Can I see a channel's external room type codes in a specific language?
      instructions:
      - text: List the external room types for hotel {hotelCode} from channel {channelCode}, {limit} at a time starting at {offset}.
        slots:
          hotelCode: path.hotelCode
          channelCode: query.channelCode
          limit: query.limit
          offset: query.offset
      - text: Show the first {limit} channel room types for hotel {hotelCode} in language {lang}, offset {offset}.
        slots:
          limit: query.limit
          hotelCode: path.hotelCode
          lang: query.lang
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/externalRatePlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel partner's rate plans for a hotel
      effect: read
      questions:
      - What rate plan codes does a channel partner send for my hotel?
      - Can I filter a channel's external rate plans down to one room type?
      instructions:
      - text: List the external rate plans for hotel {hotelCode} from channel {channelCode}, {limit} per page from offset {offset}.
        slots:
          hotelCode: path.hotelCode
          channelCode: query.channelCode
          limit: query.limit
          offset: query.offset
      - text: Get channel rate plans for hotel {hotelCode} that apply to room type {roomType}, limit {limit}, offset {offset}.
        slots:
          hotelCode: path.hotelCode
          roomType: query.roomType
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'