Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Front Desk Configuration Commission Config API

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

$.info
$.paths['/commissionCodes'].get
$.paths['/commissionCodes'].put
$.paths['/commissionCodes'].post
$.paths['/commissionCodes'].delete
$.paths['/configBankAccounts'].get
$.paths['/configBankAccounts'].put
$.paths['/configBankAccounts'].post
$.paths['/configBankAccounts'].delete
$.paths['/hotels/{hotelId}/commissionCode/{commissionCode}'].get
$.paths['/services/commissionConfig/status'].get
$.paths['/stopProcessingReasons'].get
$.paths['/stopProcessingReasons'].put
$.paths['/stopProcessingReasons'].post
$.paths['/stopProcessingReasons'].delete
$.paths['/upsert/configBankAccounts'].put

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 Front Desk Configuration Commission Config API
  version: 1.0.0
extends: openapi/oracle-hospitality-commissionconfig-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: 15
- target: $.paths['/commissionCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List travel agent commission codes for hotels
      effect: read
      questions:
      - Which commission codes are configured for my hotels?
      - Can I check the setup of specific commission codes across several properties?
      instructions:
      - text: List commission codes for hotels {hotelIds}.
        slots:
          hotelIds: query.hotelIds
      - text: Show the configuration of commission codes {commissionCodes} at {hotelIds}.
        slots:
          commissionCodes: query.commissionCodes
          hotelIds: query.hotelIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commissionCodes'].put
  update:
    x-apievangelist-phrasing:
      intent: Change existing commission codes
      effect: write
      questions:
      - How do I change the percentage or rules on an existing commission code?
      - Can I edit several commission codes in one request?
      instructions:
      - text: Update existing commission codes with {commissionCodes}.
        slots:
          commissionCodes: requestBody.commissionCodes
      - text: Edit the settings on the commission codes I already have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commissionCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new commission codes
      effect: write
      questions:
      - How do I set up a new commission code for travel agents?
      - Can I add several new commission codes at once?
      instructions:
      - text: Create commission codes {commissionCodes}.
        slots:
          commissionCodes: requestBody.commissionCodes
      - text: Add a brand-new commission code configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commissionCodes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove commission codes from hotels
      effect: destructive
      questions:
      - Can I delete a commission code we no longer pay out on?
      - What do I need to remove commission codes from specific hotels?
      instructions:
      - text: Delete commission codes {commissionCodes} at hotels {hotelIds}.
        slots:
          commissionCodes: query.commissionCodes
          hotelIds: query.hotelIds
      - text: Remove commission code {commissionCodes} from {hotelIds}.
        slots:
          commissionCodes: query.commissionCodes
          hotelIds: query.hotelIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configBankAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List bank accounts configured for commission payments
      effect: read
      questions:
      - Which bank accounts are set up to pay commissions from?
      - Can I search commission bank accounts by bank code with a wildcard?
      instructions:
      - text: List configured bank accounts for hotels {hotels}.
        slots:
          hotels: query.hotels
      - text: Find bank accounts with bank code {bankCodes} at {hotels}.
        slots:
          bankCodes: query.bankCodes
          hotels: query.hotels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configBankAccounts'].put
  update:
    x-apievangelist-phrasing:
      intent: Change existing commission bank accounts
      effect: write
      questions:
      - How do I update the details of a commission bank account that already exists?
      - Can I make an existing bank account the default for its currency?
      instructions:
      - text: Update existing bank accounts with {bankAccounts}.
        slots:
          bankAccounts: requestBody.bankAccounts
      - text: Change bank account {bankAccounts} and set it as the default for its currency.
        slots:
          bankAccounts: requestBody.bankAccounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configBankAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new commission bank accounts
      effect: write
      questions:
      - How do I add a new bank account for paying travel agent commissions?
      - Can a newly created bank account be set as the hotel default?
      instructions:
      - text: Create bank account {bankAccounts} for commission payments.
        slots:
          bankAccounts: requestBody.bankAccounts
      - text: Add a new commission bank account and make it the default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configBankAccounts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a commission bank account
      effect: destructive
      questions:
      - Can I delete a bank account we closed from commission configuration?
      - What IDs are needed to remove a configured bank account?
      instructions:
      - text: Delete bank account {bankAccountID} at hotel {hotelId}.
        slots:
          bankAccountID: query.bankAccountID
          hotelId: query.hotelId
      - text: Remove commission bank account {bankAccountID} from {hotelId}.
        slots:
          bankAccountID: query.bankAccountID
          hotelId: query.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/commissionCode/{commissionCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one commission code at a hotel
      effect: read
      questions:
      - What are the details of a single commission code at my property?
      - How is one specific commission code configured?
      instructions:
      - text: Get commission code {commissionCode} at hotel {hotelId}.
        slots:
          commissionCode: path.commissionCode
          hotelId: path.hotelId
      - text: Show the setup of {commissionCode} for {hotelId}.
        slots:
          commissionCode: path.commissionCode
          hotelId: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/commissionConfig/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the commission config service health
      effect: read
      questions:
      - Is the commission configuration service responding?
      - Can I ping the commission config API to test connectivity?
      instructions:
      - text: Ping the commission config service.
      - text: Check commission config health for hotel {hotelid}.
        slots:
          hotelid: header.x-hotelid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stopProcessingReasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List reasons for stopping commission processing
      effect: read
      questions:
      - What stop processing reasons can I use to hold a commission payment?
      - Can I include inactive stop processing reasons in the list?
      instructions:
      - text: List stop processing reasons.
      - text: Find stop processing reason {codes}, including inactive ones.
        slots:
          codes: query.codes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stopProcessingReasons'].put
  update:
    x-apievangelist-phrasing:
      intent: Change existing stop processing reasons
      effect: write
      questions:
      - How do I edit the description of a stop processing reason?
      - Can I deactivate an existing stop processing reason?
      instructions:
      - text: Update stop processing reasons with {stopProcessingReasons}.
        slots:
          stopProcessingReasons: requestBody.stopProcessingReasons
      - text: Edit the existing stop processing reasons I specify.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stopProcessingReasons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new stop processing reasons
      effect: write
      questions:
      - How do I add a new reason for putting commissions on hold?
      - Can I create several stop processing reasons at once?
      instructions:
      - text: Create stop processing reasons {stopProcessingReasons}.
        slots:
          stopProcessingReasons: requestBody.stopProcessingReasons
      - text: Add a new stop processing reason for held commissions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stopProcessingReasons'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove stop processing reasons
      effect: destructive
      questions:
      - Can I delete a stop processing reason nobody uses anymore?
      - Which codes do I pass to remove stop processing reasons?
      instructions:
      - text: Delete stop processing reasons {codes}.
        slots:
          codes: query.codes
      - text: Remove stop processing reason code {codes}.
        slots:
          codes: query.codes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upsert/configBankAccounts'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update commission bank accounts
      effect: write
      questions:
      - Is there a single call that creates a bank account if missing or updates it if it exists?
      - Can I upsert commission bank accounts without checking whether they exist first?
      instructions:
      - text: Upsert bank accounts {bankAccounts}, creating any that don't exist.
        slots:
          bankAccounts: requestBody.bankAccounts
      - text: Create-or-update the commission bank accounts I provide.
      method: generated
      generated: '2026-09-26'