Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Customer Relationship Management Profile LOV API

3 actions 3 updates phrasing extends openapi/oracle-hospitality-profilelov-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['/profileListOfValues/availableARAddresses'].get

$.paths['/profileListOfValues/availablePreferences'].get

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 Customer Relationship Management Profile LOV API
  version: 1.0.0
extends: openapi/oracle-hospitality-profilelov-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['/profileListOfValues/availableARAddresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List addresses usable for a profile's AR account
      effect: read
      questions:
      - Which of a profile's addresses can be used as the billing address on an accounts receivable account?
      - Can I see the available AR addresses for a profile at a specific hotel?
      instructions:
      - text: List available AR addresses for profile {profile} at hotel {hotel}.
        slots:
          profile: query.profileId
          hotel: query.hotelId
      - text: Show AR address choices for profile {profile} at hotel {hotel} for account {account}.
        slots:
          profile: query.profileId
          hotel: query.hotelId
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileListOfValues/availablePreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List preferences available for a profile
      effect: read
      questions:
      - What guest preferences can be assigned to a profile?
      - Can I limit how many available preference values come back?
      instructions:
      - text: List available preferences for profile {profile}.
        slots:
          profile: query.id
      - text: Show preference options for profile {profile} at hotel {hotel}.
        slots:
          profile: query.id
          hotel: query.hotelId
      method: generated
      generated: '2026-09-26'