# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Virtual Report Suites API
  version: 1.0.0
extends: openapi/adobe-analytics-virtual-report-suites-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: 7
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites'].get
  update:
    x-apievangelist-phrasing:
      intent: List virtual report suites
      effect: read
      questions:
      - What virtual report suites exist in my company?
      - Can I find virtual report suites that use a particular segment?
      instructions:
      - text: List virtual report suites in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
      - text: List virtual report suites built on segments {segmentIds}.
        slots:
          segmentIds: query.segmentIds
      - text: List virtual report suites whose ID contains {idContains}.
        slots:
          idContains: query.idContains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a virtual report suite
      effect: write
      questions:
      - How do I create a virtual report suite filtered by segments from a parent report suite?
      - What's required to create a virtual report suite?
      instructions:
      - text: Create virtual report suite {name} from parent {parentRsid} with segments {segmentList} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
          parentRsid: requestBody.parentRsid
          segmentList: requestBody.segmentList
      - text: Make a virtual report suite {name} on {parentRsid} applying {segmentList} in timezone {timezone}.
        slots:
          name: requestBody.name
          parentRsid: requestBody.parentRsid
          segmentList: requestBody.segmentList
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual report suite
      effect: read
      questions:
      - How do I see the segments and parent of one virtual report suite?
      - Can I look up a virtual report suite by its ID?
      instructions:
      - text: Get virtual report suite {id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          id: path.id
      - text: Show virtual report suite {id} with {expansion} expanded.
        slots:
          id: path.id
          expansion: query.expansion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a virtual report suite
      effect: write
      questions:
      - Can I change the segments applied to an existing virtual report suite?
      - How do I rename a virtual report suite?
      instructions:
      - text: Rename existing virtual report suite {id} in company {globalCompanyId} to {name}.
        slots:
          globalCompanyId: path.globalCompanyId
          id: path.id
          name: requestBody.name
      - text: Change the segments on virtual report suite {id} to {segmentList}.
        slots:
          id: path.id
          segmentList: requestBody.segmentList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a virtual report suite
      effect: destructive
      questions:
      - How do I delete or disable a virtual report suite?
      - Does removing a virtual report suite affect its parent?
      instructions:
      - text: Delete virtual report suite {id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          id: path.id
      - text: Disable virtual report suite {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a virtual report suite definition
      effect: read
      questions:
      - Can I check a virtual report suite definition is valid before creating it?
      - Will my segment list and parent RSID pass virtual report suite validation?
      instructions:
      - text: Validate a virtual report suite on parent {parentRsid} with segments {segmentList} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          parentRsid: requestBody.parentRsid
          segmentList: requestBody.segmentList
      - text: Check whether virtual report suite {name} on {parentRsid} is valid without saving it.
        slots:
          name: requestBody.name
          parentRsid: requestBody.parentRsid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/reportsuites/virtualreportsuites/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search virtual report suites with a request body
      effect: read
      questions:
      - Can I search virtual report suites by sending the criteria in a POST body?
      - How do I search many virtual report suites by ID list through the search endpoint?
      instructions:
      - text: Search virtual report suites in company {globalCompanyId} posting IDs {filterByIds}.
        slots:
          globalCompanyId: path.globalCompanyId
          filterByIds: requestBody.filterByIds
      - text: Run a POST search for virtual report suites using segments {segmentIds} in the body.
        slots:
          segmentIds: requestBody.segmentIds
      method: generated
      generated: '2026-10-01'