Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Distribution Onboarding API

3 actions 3 updates phrasing extends openapi/oracle-hospitality-onboarding-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}/propertyStatus'].get

$.paths['/hotels/{hotelCode}/propertyStatus'].put

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 Onboarding API
  version: 1.0.0
extends: openapi/oracle-hospitality-onboarding-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}/propertyStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a property's onboarding status on a channel
      effect: read
      questions:
      - Is my hotel's connection to this distribution channel live yet?
      - What onboarding status does OPERA Cloud show for a property on my channel?
      instructions:
      - text: Get the property status for hotel {hotel} on channel {channel}.
        slots:
          hotel: path.hotelCode
          channel: header.x-channelCode
      - text: Check whether {hotel} is connected to my channel yet.
        slots:
          hotel: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/propertyStatus'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a property's connection status on a channel
      effect: write
      questions:
      - How do I mark a hotel as connected to my distribution channel?
      - Can I record notes explaining why a property's channel connection status changed?
      instructions:
      - text: Set the connection status of hotel {hotel} on channel {channel} to {status}.
        slots:
          hotel: path.hotelCode
          channel: header.x-channelCode
          status: requestBody.connectionStatus
      - text: Update {hotel}'s channel connection status to {status} with the note {notes}.
        slots:
          hotel: path.hotelCode
          status: requestBody.connectionStatus
          notes: requestBody.connectionNotes
      method: generated
      generated: '2026-09-26'