API Evangelist conversational phrasing for OPERA Cloud Configuration Export API

# 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 Configuration Export API
  version: 1.0.0
extends: openapi/oracle-hospitality-export-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: 22
- target: $.paths['/availableExports'].get
  update:
    x-apievangelist-phrasing:
      intent: List available data exports
      effect: read
      questions:
      - Which data exports are set up and available for my hotels?
      - Can I include each export's columns, destination setup and generate configuration in the listing?
      instructions:
      - text: List the exports available for hotels {hotels}.
        slots:
          hotels: query.hotelIds
      - text: Show available exports in file group {file_group}, including inactive ones.
        slots:
          file_group: query.fileGroup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/columnsAndFunctions'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns and functions usable in exports
      effect: read
      questions:
      - What database columns and functions can I use when building an export?
      - Can I see the pre and post procedures available for an export data source?
      instructions:
      - text: Show export columns and functions for data source {data_source}.
        slots:
          data_source: query.dataSource
      - text: List columns available to export file {export_file}.
        slots:
          export_file: query.exportFileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportMappingCodes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update export mapping codes
      effect: write
      questions:
      - How do I change the codes that an export mapping translates values into?
      - Can I edit existing export mapping codes for one hotel?
      instructions:
      - text: Update export mapping codes {codes} for hotel {hotel}.
        slots:
          codes: requestBody.exportMappingCodes
          hotel: requestBody.hotelId
      - text: Edit the existing export mapping codes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportMappingCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create export mapping codes
      effect: write
      questions:
      - How do I add new mapping codes for an export?
      - Can I define fresh export mapping codes for a property?
      instructions:
      - text: Create export mapping codes {codes} for hotel {hotel}.
        slots:
          codes: requestBody.exportMappingCodes
          hotel: requestBody.hotelId
      - text: Add new mapping codes to the export setup.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportMappingLinkedTypes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update export mapping linked codes
      effect: write
      questions:
      - How do I link OPERA codes to an export mapping type?
      - Can I change which codes are linked to an export mapping?
      instructions:
      - text: Link OPERA codes {linked} to their export mapping types at hotel {hotel}.
        slots:
          linked: requestBody.linkedCodes
          hotel: requestBody.hotelId
      - text: Relink codes to export mapping types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportMappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List export mappings across the chain
      effect: read
      questions:
      - What export mappings are configured at the chain level?
      - Can I see chain export mappings without naming a single property in the path?
      instructions:
      - text: List export mappings across the chain.
      - text: Show chain-level export mappings filtered to hotel {hotel}.
        slots:
          hotel: query.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportSchedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create export schedules
      effect: write
      questions:
      - How do I schedule an export to run automatically?
      - Can I set up a new recurring export job?
      instructions:
      - text: Create export schedule {schedule}.
        slots:
          schedule: requestBody.exportScheduleConfig
      - text: Schedule a new recurring export job.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportSchedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove export schedules by job name
      effect: destructive
      questions:
      - How do I stop and delete a scheduled export job?
      - Can I remove several export schedules by their job names?
      instructions:
      - text: Delete export schedules for jobs {jobs}.
        slots:
          jobs: query.jobNames
      - text: Remove the scheduled export job named {jobs}.
        slots:
          jobs: query.jobNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/exportSchedules/{exportFileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an export's schedule at chain level
      effect: write
      questions:
      - How do I change the chain-wide schedule of an export file?
      - Can I reschedule an export for the whole chain rather than one hotel?
      instructions:
      - text: Change the chain-level schedule for export file {export_file}.
        slots:
          export_file: path.exportFileId
      - text: Update chain export {export_file} to schedule {schedule}.
        slots:
          export_file: path.exportFileId
          schedule: requestBody.exportScheduleConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/configTypes/{configType}/exportMappingCodesToLink'].get
  update:
    x-apievangelist-phrasing:
      intent: List codes available to link to an export mapping
      effect: read
      questions:
      - Which OPERA codes of a configuration type can I still link to an export mapping?
      - Can I search linkable codes by code or description?
      instructions:
      - text: List {config_type} codes available to link at hotel {hotel}.
        slots:
          config_type: path.configType
          hotel: path.hotelId
      - text: Find linkable {config_type} codes matching {code} at hotel {hotel}.
        slots:
          config_type: path.configType
          code: query.code
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportActivityLog'].get
  update:
    x-apievangelist-phrasing:
      intent: View the export activity log
      effect: read
      questions:
      - What export activity happened at a property over a date range?
      - Can I filter the export activity log by activity type or user?
      instructions:
      - text: Show {activity_type} export activity at hotel {hotel} from {from} to {to}.
        slots:
          activity_type: query.activityType
          hotel: path.hotelId
          from: query.fromDate
          to: query.toDate
      - text: Search the export log at hotel {hotel} for {text} between {from} and {to}, type {activity_type}.
        slots:
          hotel: path.hotelId
          text: query.searchText
          from: query.fromDate
          to: query.toDate
          activity_type: query.activityType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappingId/{exportMappingId}/exportMappings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an export mapping
      effect: destructive
      questions:
      - How do I remove an entire export mapping from a property?
      - Can I delete an export mapping by its ID?
      instructions:
      - text: Delete export mapping {mapping_id} at hotel {hotel}.
        slots:
          mapping_id: path.exportMappingId
          hotel: path.hotelId
      - text: Remove the whole export mapping {mapping_id} from hotel {hotel}.
        slots:
          mapping_id: path.exportMappingId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappingTypes/{exportMappingTypeId}/exportMappingCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get codes for an export mapping type
      effect: read
      questions:
      - What mapping codes belong to a given export mapping type?
      - Which translated values does an export mapping type use at my hotel?
      instructions:
      - text: Show mapping codes for export mapping type {type_id} at hotel {hotel}.
        slots:
          type_id: path.exportMappingTypeId
          hotel: path.hotelId
      - text: List the codes defined under mapping type {type_id} for hotel {hotel}.
        slots:
          type_id: path.exportMappingTypeId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a hotel's export mappings
      effect: read
      questions:
      - What export mappings are set up for a specific hotel?
      - Can I fetch export mapping configs for one property?
      instructions:
      - text: List export mappings for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Show export mapping configs {configs} at hotel {hotel}.
        slots:
          configs: query.exportMappingConfigs
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a hotel's export mappings
      effect: write
      questions:
      - How do I change an existing export mapping at a property?
      - Can I edit the export mapping definition for one hotel?
      instructions:
      - text: Update export mappings for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Change hotel {hotel}'s export mapping to {mapping}.
        slots:
          hotel: path.hotelId
          mapping: requestBody.exportMapping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an export mapping for a hotel
      effect: write
      questions:
      - How do I set up a new export mapping at a property?
      - Can I define a fresh mapping for how values appear in an export?
      instructions:
      - text: Create an export mapping at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Add export mapping {mapping} for hotel {hotel}.
        slots:
          mapping: requestBody.exportMapping
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappings/linkedCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List codes already linked to export mappings
      effect: read
      questions:
      - Which codes are already linked to an export mapping at my hotel?
      - Can I filter linked codes by configuration type?
      instructions:
      - text: Show export mapping linked codes at hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: List linked codes of type {config_type} at hotel {hotel}.
        slots:
          config_type: query.configType
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportMappings/{exportMappingId}/mappingTypes/{mappingTypeCode}/exportMappingCodes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a mapping type's codes from an export mapping
      effect: destructive
      questions:
      - How do I delete the codes of one mapping type inside an export mapping?
      - Can I remove mapping codes without deleting the whole export mapping?
      instructions:
      - text: Delete {type_code} codes from export mapping {mapping_id} at hotel {hotel}.
        slots:
          type_code: path.mappingTypeCode
          mapping_id: path.exportMappingId
          hotel: path.hotelId
      - text: Remove mapping type {type_code} codes on mapping {mapping_id}, hotel {hotel}.
        slots:
          type_code: path.mappingTypeCode
          mapping_id: path.exportMappingId
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportSchedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a hotel's export schedules
      effect: read
      questions:
      - Which exports are scheduled to run at a property, and how often?
      - Can I filter export schedules by frequency or export name?
      instructions:
      - text: List export schedules for hotel {hotel}.
        slots:
          hotel: path.hotelId
      - text: Show {frequency} export schedules at hotel {hotel}.
        slots:
          frequency: query.frequency
          hotel: path.hotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/exportSchedules/{exportFileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an export's schedule at one hotel
      effect: write
      questions:
      - How do I change when an export runs at a single property?
      - Can I reschedule one hotel's export file?
      instructions:
      - text: Change the schedule of export file {export_file} at hotel {hotel}.
        slots:
          export_file: path.exportFileId
          hotel: path.hotelId
      - text: Set hotel {hotel}'s export {export_file} to schedule {schedule}.
        slots:
          hotel: path.hotelId
          export_file: path.exportFileId
          schedule: requestBody.exportScheduleConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/export/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the export service status
      effect: read
      questions:
      - Is the data export service up?
      - How can I health-check the export service?
      instructions:
      - text: Ping the export service.
      - text: Check export service availability for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{exportFileId}/generatedExports'].get
  update:
    x-apievangelist-phrasing:
      intent: List files generated by an export
      effect: read
      questions:
      - Which files has a given export already produced?
      - Can I page through the generated output of an export file?
      instructions:
      - text: List generated exports for export file {export_file}.
        slots:
          export_file: path.exportFileId
      - text: Show generated export data {data_id} for export file {export_file}.
        slots:
          data_id: query.exportDataId
          export_file: path.exportFileId
      method: generated
      generated: '2026-09-26'