Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Integration Processor API

3 actions 3 updates phrasing extends openapi/oracle-hospitality-integrationprocessor-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['/externalSystem/{extSystemCode}/businessEvents'].get
$.paths['/externalSystem/{extSystemCode}/hotels/{hotelId}/businessEvents'].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 Integration Processor API
  version: 1.0.0
extends: openapi/oracle-hospitality-integrationprocessor-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['/externalSystem/{extSystemCode}/businessEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: Dequeue business events for an external system chain-wide
      effect: write
      questions:
      - How can my integration pull queued OPERA business events for every hotel in the chain at once?
      - What is the most business event messages I can dequeue in one call across all hotels?
      instructions:
      - text: Dequeue the next business events for external system {system} across all hotels in the chain.
        slots:
          system: path.extSystemCode
      - text: Fetch up to {limit} chain-wide business event messages queued for {system}.
        slots:
          limit: query.limit
          system: path.extSystemCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystem/{extSystemCode}/hotels/{hotelId}/businessEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: Dequeue business events for one hotel
      effect: write
      questions:
      - Can I pull queued business events for just one property instead of the whole chain?
      - Which consumer code setup do I need before fetching property-specific business events?
      instructions:
      - text: Dequeue business events for external system {system} at hotel {hotel}.
        slots:
          system: path.extSystemCode
          hotel: path.hotelId
      - text: Fetch up to {limit} queued business event messages for hotel {hotel} and system {system}.
        slots:
          limit: query.limit
          hotel: path.hotelId
          system: path.extSystemCode
      method: generated
      generated: '2026-09-26'