Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Distribution Book Reservation Request API

6 actions 6 updates phrasing extends openapi/oracle-hospitality-reservation-request-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/{hotelCode}/reservations'].post

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

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

$.paths['/hotels/{hotelCode}/reservations/{confirmationNum}/cancellations'].post

$.paths['/hotels/{hotelCode}/reservations/{confirmationNum}/status'].post

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 Book Reservation Request API
  version: 1.0.0
extends: openapi/oracle-hospitality-reservation-request-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/{hotelCode}/reservations'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a new hotel reservation from a channel
      effect: write
      questions:
      - How do I create a new hotel booking through the OPERA distribution channel API?
      - Can a channel partner push a new reservation straight into a hotel?
      - What do I need to send to book a room for a guest at a specific hotel?
      instructions:
      - text: Create a reservation at hotel {hotelCode} from channel {channel} with {reservations}.
        slots:
          hotelCode: path.hotelCode
          channel: header.x-channelCode
          reservations: requestBody.reservations
      - text: Book a new stay at hotel {hotelCode}.
        slots:
          hotelCode: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/reservations/{confirmationNum}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a reservation by confirmation number
      effect: read
      questions:
      - How can I pull up a booking using its confirmation number?
      - Can a channel retrieve the current details of a reservation it made?
      instructions:
      - text: Get reservation {confirmationNum} at hotel {hotelCode}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
      - text: Show the details of booking {confirmationNum} for channel {channel} at hotel {hotelCode}.
        slots:
          confirmationNum: path.confirmationNum
          channel: header.x-channelCode
          hotelCode: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/reservations/{confirmationNum}'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an existing reservation
      effect: write
      questions:
      - How do I change the dates or room on a booking a channel already made?
      - Can I update an existing reservation by its confirmation number?
      instructions:
      - text: Modify reservation {confirmationNum} at hotel {hotelCode} with {reservations}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
          reservations: requestBody.reservations
      - text: Update the stay details on booking {confirmationNum} at hotel {hotelCode}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/reservations/{confirmationNum}/cancellations'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a reservation
      effect: destructive
      questions:
      - How do I cancel a guest's hotel booking from a channel?
      - What does a channel send to cancel a reservation by confirmation number?
      instructions:
      - text: Cancel reservation {confirmationNum} at hotel {hotelCode}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
      - text: Cancel booking {confirmationNum} at hotel {hotelCode} using cancellation details {reservations}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
          reservations: requestBody.reservations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelCode}/reservations/{confirmationNum}/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit or ignore an on-hold reservation
      effect: write
      questions:
      - How do I confirm a reservation that is sitting on hold?
      - Can I release an on-hold booking instead of committing it?
      instructions:
      - text: Commit on-hold reservation {confirmationNum} at hotel {hotelCode}.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
      - text: Ignore the on-hold booking {confirmationNum} at hotel {hotelCode} so it is not committed.
        slots:
          confirmationNum: path.confirmationNum
          hotelCode: path.hotelCode
      method: generated
      generated: '2026-09-26'