Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Distribution Content API

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

$.info

$.paths['/hotels'].get

$.paths['/hotels/{hotelCode}'].get

$.paths['/hotels/{hotelCode}/roomTypes'].get

$.paths['/hotels/{hotelCode}/ratePlans'].get

$.paths['/hotels/{hotelCode}/rateRooms'].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 Distribution Content API
  version: 1.0.0
extends: openapi/oracle-hospitality-content-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: 5
- target: $.paths['/hotels'].get
  update:
    x-apievangelist-phrasing:
      intent: List properties mapped to a distribution channel
      effect: read
      questions:
      - Which hotel properties are actively mapped to my distribution channel code?
      - Can I see which properties changed connection status within a date range?
      - How do I page through all properties connected to my channel?
      instructions:
      - text: List all properties mapped to channel {channel}.
        slots:
          channel: header.x-channelCode
      - text: Show properties for channel {channel} with connection status {status}.
        slots:
          channel: header.x-channelCode
          status: query.connectionStatus
      - text: List channel {channel} properties whose connection status changed since {from}.
        slots:
          channel: header.x-channelCode
          from: query.connectionStatusLastChangedFrom
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get content details for one property
      effect: read
      questions:
      - How do I pull the descriptive content for a single hotel through my channel?
      - What property information does OPERA Cloud Distribution return for one hotel code?
      instructions:
      - text: Get property information for hotel {hotel} on channel {channel}.
        slots:
          hotel: path.hotelCode
          channel: header.x-channelCode
      - text: Show me the property profile for {hotel}.
        slots:
          hotel: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/roomTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's room types
      effect: read
      questions:
      - What room types does a hotel offer to my channel?
      - Can I include room amenities when pulling a property's room types?
      instructions:
      - text: List the room types at hotel {hotel}.
        slots:
          hotel: path.hotelCode
      - text: Get room type {room_type} at hotel {hotel} including its amenities.
        slots:
          room_type: query.roomType
          hotel: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/ratePlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's rate plans
      effect: read
      questions:
      - Which rate plans can my channel sell at a given hotel?
      - Can negotiated rates be included when listing a hotel's rate plans?
      instructions:
      - text: List the rate plans for hotel {hotel}, including negotiated rates.
        slots:
          hotel: path.hotelCode
      - text: Get details of rate plan {rate_plan} at hotel {hotel}.
        slots:
          rate_plan: query.ratePlanCode
          hotel: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/rateRooms'].get
  update:
    x-apievangelist-phrasing:
      intent: Map rate plans to room types for a property
      effect: read
      questions:
      - Which room types are sold under each rate plan at a hotel?
      - Can I include inactive rate-to-room mappings for a property?
      instructions:
      - text: Show which room types are mapped to rate plan {rate_plan} at hotel {hotel}.
        slots:
          rate_plan: query.ratePlanCode
          hotel: path.hotelCode
      - text: List the rate plans that sell room type {room_type} at hotel {hotel}, including inactive mappings.
        slots:
          room_type: query.roomType
          hotel: path.hotelCode
      method: generated
      generated: '2026-09-26'