API Evangelist conversational phrasing for OPERA Cloud Master Data Management Report 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 Master Data Management Report API
  version: 1.0.0
extends: openapi/oracle-hospitality-report-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: 12
- target: $.paths['/allReportGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List all report groups
      effect: read
      questions:
      - What report groups exist in OPERA Cloud for organizing reports?
      - Can I list report groups for a specific module or hotel?
      instructions:
      - text: List all report groups.
      - text: Show report groups for module {module} at hotel {hotel}.
        slots:
          module: query.moduleName
          hotel: query.HotelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/allReports'].get
  update:
    x-apievangelist-phrasing:
      intent: List all reports for an integration
      effect: read
      questions:
      - Is there an integration-oriented endpoint that returns every report in OPERA Cloud?
      - Can an integration pull the full report catalog, including multi-property-only reports?
      instructions:
      - text: For our integration, list all reports available at hotel {hotel}.
        slots:
          hotel: query.hotel
      - text: Pull the integration report catalog filtered to group {group}.
        slots:
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/genericReports'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing generic reports
      effect: write
      questions:
      - How do I change the definition of a generic report that already exists?
      - Can I edit several generic reports in one update call?
      instructions:
      - text: Update the existing generic reports {reports}.
        slots:
          reports: requestBody.reports
      - text: Change the settings on our current generic reports without creating new ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/genericReports'].post
  update:
    x-apievangelist-phrasing:
      intent: Create generic reports
      effect: write
      questions:
      - How do I create a new generic report in OPERA Cloud?
      - Can I add several new generic reports in a single request?
      instructions:
      - text: Create generic reports {reports}.
        slots:
          reports: requestBody.reports
      - text: Add a brand-new generic report definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/genericReports'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete generic reports
      effect: destructive
      questions:
      - How do I delete a generic report I no longer need?
      - Can I remove generic reports by hotel and report ID?
      instructions:
      - text: Delete generic report {report} at hotel {hotel}.
        slots:
          report: query.id
          hotel: query.hotelId
      - text: Remove generic report {report}.
        slots:
          report: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reportParameters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the parameters a report accepts
      effect: read
      questions:
      - What input parameters does a particular report take before I run it?
      - Can I look up a report's parameter list by its ID?
      instructions:
      - text: Get the parameters for report {report}.
        slots:
          report: query.id
      - text: Show which inputs report {report} expects.
        slots:
          report: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reportTextConfiguration/copy'].put
  update:
    x-apievangelist-phrasing:
      intent: Copy report text configuration between properties
      effect: write
      questions:
      - Can I copy report text configuration from one property to another?
      - How do I reuse one hotel's report text setup at a sister property?
      instructions:
      - text: Copy report text configuration using {copy_reports}.
        slots:
          copy_reports: requestBody.copyReports
      - text: Replicate our report text configuration codes to the other property.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Search reports by name, group or hotel
      effect: read
      questions:
      - How do I find a report by part of its name or description?
      - Can I list only reports that can be scheduled?
      - Which reports belong to a given report group at my hotel?
      instructions:
      - text: Find reports whose name contains {name}.
        slots:
          name: query.name
      - text: List schedulable reports in group {group} at hotel {hotel}.
        slots:
          group: query.group
          hotel: query.hotel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/reports/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the reports service status
      effect: read
      questions:
      - Is the OPERA Cloud reports configuration service up?
      - How do I health-check the report service?
      instructions:
      - text: Ping the reports configuration service.
      - text: Check report service availability for hotel {hotel}.
        slots:
          hotel: header.x-hotelid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upsert/managerReports/statistics'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update manager report statistics
      effect: write
      questions:
      - How do I set the statistics that appear on the manager report?
      - Can I upsert manager report statistics for a hotel and module?
      instructions:
      - text: Upsert manager report statistics {statistics} for hotel {hotel}.
        slots:
          statistics: requestBody.managerReportStatistics
          hotel: requestBody.hotelId
      - text: Update the manager report statistics for module {module}.
        slots:
          module: requestBody.moduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upsert/reports/textConfigurationMessages'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update report text messages
      effect: write
      questions:
      - How do I change the text messages printed on reports?
      - Can I create or update report text configuration messages in one call?
      instructions:
      - text: Upsert report text configuration messages {messages}.
        slots:
          messages: requestBody.reportTextConfigurationMessages
      - text: Set the custom message text that prints on our reports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/upsertGenericReports'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update generic reports
      effect: write
      questions:
      - Can I upsert generic reports so missing ones are created and existing ones changed?
      - Is there a single call to sync our generic report definitions whether or not they exist yet?
      instructions:
      - text: Upsert generic reports {reports}.
        slots:
          reports: requestBody.reports
      - text: Sync our generic report definitions, creating any that are missing.
      method: generated
      generated: '2026-09-26'