Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Price Availability Rate Async Availability…

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

$.info

$.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions'].post

$.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions/{requestId}'].get

$.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions/{requestId}'].head

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 Price Availability Rate Async Availability…
  version: 1.0.0
extends: openapi/oracle-hospitality-availabilityasync-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: 3
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions'].post
  update:
    x-apievangelist-phrasing:
      intent: Send restrictions to OPERA Cloud asynchronously
      effect: write
      questions:
      - How do I push a batch of rate and inventory restrictions into OPERA Cloud from my external system?
      - Can an external system submit restrictions for a hotel and process them in the background?
      instructions:
      - text: Submit these restrictions for hotel {hotelId} from external system {extSystemCode}.
        slots:
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      - text: Send restriction set {restrictions} to OPERA for hotel {hotelId} via {extSystemCode}.
        slots:
          restrictions: requestBody.restrictions
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the processing result of submitted restrictions
      effect: read
      questions:
      - What happened to the restrictions request I sent to OPERA — was it processed and what came back?
      - Where can I read the full response for an async restrictions request by its request id?
      instructions:
      - text: Fetch the result of restrictions request {requestId} for hotel {hotelId} from {extSystemCode}.
        slots:
          requestId: path.requestId
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      - text: Show me the returned details for async restrictions request {requestId} at hotel {hotelId}, system {extSystemCode}.
        slots:
          requestId: path.requestId
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{hotelId}/restrictions/{requestId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check if a restrictions request has finished
      effect: read
      questions:
      - Is there a lightweight HEAD check to see whether my restrictions request is done processing?
      - Can I poll just the status of an async restrictions job without downloading the response body?
      instructions:
      - text: Poll with a HEAD request whether restrictions job {requestId} for hotel {hotelId} via {extSystemCode} is complete.
        slots:
          requestId: path.requestId
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      - text: Just check the processing status header of request {requestId} for {hotelId} from {extSystemCode}, no body.
        slots:
          requestId: path.requestId
          hotelId: path.hotelId
          extSystemCode: path.extSystemCode
      method: generated
      generated: '2026-09-26'