Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud API for Service Customer Management API

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

$.info
$.paths['/hotels/{hotelId}/trackItems'].get
$.paths['/hotels/{hotelId}/trackItems'].put
$.paths['/hotels/{hotelId}/trackItems'].post
$.paths['/hotels/{hotelId}/trackItems'].delete
$.paths['/hotels/{hotelId}/trackItems/searches'].post
$.paths['/services/customerManagement/status'].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 API for Service Customer Management API
  version: 1.0.0
extends: openapi/oracle-hospitality-customer-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/hotels/{hotelId}/trackItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List Track It items for a property
      effect: read
      questions:
      - Which guest luggage, parcels or valet cars are we currently holding?
      - Can I look up Track It items by ticket number or guest surname?
      instructions:
      - text: List Track It items at hotel {hotelId}.
        slots:
          hotelId: path.hotelId
      - text: Find the Track It item with ticket {ticketId} at {hotelId}.
        slots:
          ticketId: query.ticketId
          hotelId: path.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/trackItems'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Track It item
      effect: write
      questions:
      - How do I update a stored bag or parcel record, like marking it delivered?
      - Can I change the location of a Track It item?
      instructions:
      - text: Update the Track It item details at hotel {hotelId}.
        slots:
          hotelId: path.hotelId
      - text: Change Track It item {trackItItemsInfo} at {hotelId}.
        slots:
          trackItItemsInfo: requestBody.trackItItemsInfo
          hotelId: path.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/trackItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a new Track It item
      effect: write
      questions:
      - How do I log a guest's luggage for storage or a parcel that arrived for them?
      - Can a new Track It item be linked to a reservation?
      instructions:
      - text: Create a Track It item at hotel {hotelId}.
        slots:
          hotelId: path.hotelId
      - text: Log new Track It item {trackItItemsInfo} for a guest at {hotelId}.
        slots:
          trackItItemsInfo: requestBody.trackItItemsInfo
          hotelId: path.hotelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/trackItems'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Track It item
      effect: destructive
      questions:
      - Can I delete a Track It record that was entered by mistake?
      - What ID identifies the Track It item to remove?
      instructions:
      - text: Delete Track It item {trackItId} at hotel {hotelId}.
        slots:
          trackItId: query.trackItId
          hotelId: path.hotelId
      - text: Remove the Track It record {trackItId}.
        slots:
          trackItId: query.trackItId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hotels/{hotelId}/trackItems/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Track It items with posted criteria
      effect: read
      questions:
      - Is there a POST search for Track It items when I have many filters?
      - Can I search held items by guest name in a request body?
      instructions:
      - text: Search Track It items at {hotelId} for guest surname {surname} via POST.
        slots:
          hotelId: path.hotelId
          surname: requestBody.surname
      - text: Run a Track It search in the request body for reservation {reservationId}.
        slots:
          reservationId: requestBody.reservationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/customerManagement/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the customer management service health
      effect: read
      questions:
      - Is the customer management service up?
      - Can I ping the Track It customer management API?
      instructions:
      - text: Ping the customer management service.
      - text: Check customer management API health for hotel {hotelid}.
        slots:
          hotelid: header.x-hotelid
      method: generated
      generated: '2026-10-01'