Oracle Hospitality · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/oracle-hospitality-profilestatistics-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['/profileMembershipStatistics'].get

$.paths['/profileStatistics'].get

$.paths['/services/profileStats/status'].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…
  version: 1.0.0
extends: openapi/oracle-hospitality-profilestatistics-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['/profileMembershipStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's membership points statistics
      effect: read
      questions:
      - How many loyalty points has a guest earned on a membership card?
      - Can I see each membership transaction and its points within a 90-day window?
      instructions:
      - text: Get membership statistics for profile {profile}, card {card}, type {membership_type}.
        slots:
          profile: query.profileId
          card: query.membershipCardNo
          membership_type: query.membershipType
      - text: Show membership points transactions for profile {profile} card {card} ({membership_type}) from {start} to {end}.
        slots:
          profile: query.profileId
          card: query.membershipCardNo
          membership_type: query.membershipType
          start: query.startDate
          end: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest profile's stay and revenue statistics
      effect: read
      questions:
      - How much revenue and how many stays has a guest profile generated at my hotels?
      - Can I get summary or detail stay statistics for a profile over a 90-day span?
      instructions:
      - text: Get {report_type} statistics for profile {profile} at hotels {hotels}.
        slots:
          report_type: query.reportType
          profile: query.profileId
          hotels: query.hotelIds
      - text: Show {report_type} stats for profile {profile} at {hotels} for stays from {stay_from} to {stay_to}.
        slots:
          report_type: query.reportType
          profile: query.profileId
          hotels: query.hotelIds
          stay_from: query.stayFrom
          stay_to: query.stayTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/profileStats/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the profile statistics service status
      effect: read
      questions:
      - Is the profile statistics service responding?
      - How can I health-check the profile stats API?
      instructions:
      - text: Ping the profile statistics service.
      - text: Check profile statistics service status for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'