Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OPERA Cloud Service Data Value Mapping API

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

$.info
$.paths['/externalSystems/{extSystemCode}/hotels/{externalHotelId}/conversions'].get
$.paths['/externalSystems/{extSystemCode}/hotels/{operaHotelId}/convertedValues'].get
$.paths['/externalSystems/{extSystemCode}/hotels/{operaHotelId}/defaultValues'].get
$.paths['/externalSystems/{externalSystem}/conversionCodes'].get
$.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].get
$.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].put
$.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].post
$.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].delete
$.paths['/services/datavaluemapping/defaultValueCache'].delete
$.paths['/services/datavaluemapping/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 Service Data Value Mapping API
  version: 1.0.0
extends: openapi/oracle-hospitality-datavaluemapping-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: 10
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{externalHotelId}/conversions'].get
  update:
    x-apievangelist-phrasing:
      intent: Convert an external hotel ID to an OPERA code
      effect: read
      questions:
      - What OPERA hotel code corresponds to an external system's hotel ID?
      - Can I translate a partner's hotel identifier into the OPERA hotel code?
      instructions:
      - text: Convert external hotel {external_hotel} from system {system} to its OPERA hotel code.
        slots:
          external_hotel: path.externalHotelId
          system: path.extSystemCode
      - text: Look up the OPERA code for hotel {external_hotel} in external system {system}.
        slots:
          external_hotel: path.externalHotelId
          system: path.extSystemCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{operaHotelId}/convertedValues'].get
  update:
    x-apievangelist-phrasing:
      intent: Convert values between OPERA and an external system
      effect: read
      questions:
      - What does an external system's code translate to in OPERA for a hotel?
      - Can I convert a single value using a specific conversion code?
      instructions:
      - text: Convert {value} with conversion code {conversion} for hotel {hotel} and system {system}.
        slots:
          value: query.valueToBeConverted
          conversion: query.conversionCode
          hotel: path.operaHotelId
          system: path.extSystemCode
      - text: Get the converted values for hotel {hotel} in external system {system}.
        slots:
          hotel: path.operaHotelId
          system: path.extSystemCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{extSystemCode}/hotels/{operaHotelId}/defaultValues'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default mapping values for an external system
      effect: read
      questions:
      - What default values apply when an external system sends no mapped value?
      - Can I see a hotel's default data value mapping for one interface?
      instructions:
      - text: Get the default values for hotel {hotel} in external system {system}.
        slots:
          hotel: path.operaHotelId
          system: path.extSystemCode
      - text: Show the mapping defaults external system {system} uses at hotel {hotel}.
        slots:
          system: path.extSystemCode
          hotel: path.operaHotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{externalSystem}/conversionCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversion codes for an external system
      effect: read
      questions:
      - Which data value mapping conversion codes exist for an external system?
      - Can I list only the conversion codes that are configured for a hotel?
      instructions:
      - text: List the conversion codes for external system {system}.
        slots:
          system: path.externalSystem
      - text: Show configured conversion codes for system {system} at hotel {hotel} in group {group}.
        slots:
          system: path.externalSystem
          hotel: query.hotelId
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List mappings for a conversion code
      effect: read
      questions:
      - What value mappings are set up under one conversion code?
      - Can I search a conversion code's mappings by text or limit them to global scope?
      instructions:
      - text: List the mappings for conversion code {conversion} in external system {system}.
        slots:
          conversion: path.conversionCode
          system: path.externalSystem
      - text: Search mappings under {conversion} for system {system} matching {text}.
        slots:
          conversion: path.conversionCode
          system: path.externalSystem
          text: query.searchText
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update conversion code mappings
      effect: write
      questions:
      - How can I change an existing value mapping under a conversion code?
      - Can I edit data value mapping records that already exist for an interface?
      instructions:
      - text: Update the mappings for conversion code {conversion} in system {system} to {mappings}.
        slots:
          conversion: path.conversionCode
          system: path.externalSystem
          mappings: requestBody.conversionCodeMappings
      - text: Change existing {conversion} mappings for external system {system}.
        slots:
          conversion: path.conversionCode
          system: path.externalSystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create conversion code mappings
      effect: write
      questions:
      - How do I add a new value mapping under a conversion code?
      - Can I map a new external code to an OPERA value?
      instructions:
      - text: Create mappings {mappings} for conversion code {conversion} in system {system}.
        slots:
          mappings: requestBody.conversionCodeMappings
          conversion: path.conversionCode
          system: path.externalSystem
      - text: Add a new {conversion} value mapping for external system {system}.
        slots:
          conversion: path.conversionCode
          system: path.externalSystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/externalSystems/{externalSystem}/conversionCodes/{conversionCode}/dataValueMappings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete conversion code mappings
      effect: destructive
      questions:
      - Can I delete specific value mappings by their mapping IDs?
      - What is needed to remove mappings from a conversion code?
      instructions:
      - text: Delete mappings {mapping_ids} from conversion code {conversion} in system {system}.
        slots:
          mapping_ids: query.mappingIds
          conversion: path.conversionCode
          system: path.externalSystem
      - text: Remove mapping {mapping_ids} under {conversion} for external system {system}.
        slots:
          mapping_ids: query.mappingIds
          conversion: path.conversionCode
          system: path.externalSystem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/datavaluemapping/defaultValueCache'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the default value cache
      effect: destructive
      questions:
      - How do I clear cached default mapping values after changing them?
      - Can I flush the data value mapping default value cache?
      instructions:
      - text: Clear the default value cache.
      - text: Flush the data value mapping default cache for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/datavaluemapping/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the data value mapping service status
      effect: read
      questions:
      - Is the data value mapping service up?
      - What is the quickest health check for the DVM API?
      instructions:
      - text: Ping the data value mapping service.
      - text: Check data value mapping service status for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'