Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Front Desk Operations Outbound Front Office…

3 actions 3 updates phrasing extends openapi/oracle-hospitality-frontofficeexternal-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/{hotelId}/externalRoomKeys'].post

$.paths['/hotels/{hotelId}/roomKeysOutbound'].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 Front Desk Operations Outbound Front Office…
  version: 1.0.0
extends: openapi/oracle-hospitality-frontofficeexternal-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/{hotelId}/externalRoomKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Request door lock room keys from an encoder
      effect: write
      questions:
      - How do I have a door lock system encode new room keys when a guest checks in?
      - Can I request duplicate or replacement keys for a room with a validity window?
      - What do I need to send to cut keys at a specific encoder terminal?
      instructions:
      - text: Encode {noOfKeys} new keys for room {roomId} at hotel {hotelId} on encoder {encoderId}, terminal {encoderTerminal}, key type {keyType}.
        slots:
          noOfKeys: requestBody.noOfKeys
          roomId: requestBody.roomId
          hotelId: path.hotelId
          encoderId: requestBody.encoderId
          encoderTerminal: requestBody.encoderTerminal
          keyType: requestBody.keyType
      - text: Request a {keyType} room key for hotel {hotelId} from encoder {encoderId} at {encoderTerminal}, valid until {keyValidityEnd}.
        slots:
          keyType: requestBody.keyType
          hotelId: path.hotelId
          encoderId: requestBody.encoderId
          encoderTerminal: requestBody.encoderTerminal
          keyValidityEnd: requestBody.keyValidityEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/roomKeysOutbound'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an outbound room key request with user and time
      effect: write
      questions:
      - How do I send an outbound key request that records the request time and which user asked for it?
      - Can the outbound room key message say whether the key is for a guest or a staff user type?
      instructions:
      - text: 'Send an outbound {roomKeyType} key request for hotel {hotelId}: encoder {encoderId}/{encoderTerminal}, {keyType}, user type {keyUserType}, at {keyRequestTime}.'
        slots:
          roomKeyType: requestBody.roomKeyType
          hotelId: path.hotelId
          encoderId: requestBody.encoderId
          encoderTerminal: requestBody.encoderTerminal
          keyType: requestBody.keyType
          keyUserType: requestBody.keyUserType
          keyRequestTime: requestBody.keyRequestTime
      - text: Log outbound key request by user {userId} for room {roomId} at hotel {hotelId}.
        slots:
          userId: requestBody.userId
          roomId: requestBody.roomId
          hotelId: path.hotelId
      method: generated
      generated: '2026-09-26'