Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign In App Reports API

7 actions 7 updates phrasing extends openapi/conga-inappreports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/cs-inappreports/reports'].get
$.paths['/v1/cs-inappreports/reports'].delete
$.paths['/v1/cs-inappreports/reports/summaries'].get
$.paths['/v1/cs-inappreports/reports/{fileName}'].get
$.paths['/v1/cs-inappreports/reports/{fileName}'].delete
$.paths['/v1/cs-inappreports/zip/reports'].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 Conga Sign In App Reports API
  version: 1.0.0
extends: openapi/conga-inappreports-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: 6
- target: $.paths['/v1/cs-inappreports/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List report files by date and type
      effect: read
      questions:
      - How do I get in-app report files for a date range?
      - Can I filter generated reports by report type?
      instructions:
      - text: List reports from {fromDate} to {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Get {reportType} reports generated since {fromDate}.
        slots:
          reportType: query.reportType
          fromDate: query.fromDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-inappreports/reports'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several report CSV files
      effect: destructive
      questions:
      - How do I delete a set of generated report CSVs?
      - Can I clean up multiple in-app report files at once?
      instructions:
      - text: Delete the report files {fileName}.
        slots:
          fileName: query.fileName
      - text: 'Remove these in-app report CSVs in bulk: {fileName}.'
        slots:
          fileName: query.fileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-inappreports/reports/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get report summaries by date and type
      effect: read
      questions:
      - Can I see summaries of reports rather than the full files?
      - What report summaries exist for last month?
      instructions:
      - text: Get report summaries from {fromDate} to {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Summarize {reportType} reports for the period starting {fromDate}.
        slots:
          reportType: query.reportType
          fromDate: query.fromDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-inappreports/reports/{fileName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one report CSV
      effect: read
      questions:
      - How do I download a specific report CSV by file name?
      - Can I fetch a single in-app report file?
      instructions:
      - text: Download report file {fileName}.
        slots:
          fileName: path.fileName
      - text: Get the CSV report named {fileName}.
        slots:
          fileName: path.fileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-inappreports/reports/{fileName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one report CSV
      effect: destructive
      questions:
      - How do I delete a single report file by its name?
      - Can I remove just one generated CSV report?
      instructions:
      - text: Delete report file {fileName}.
        slots:
          fileName: path.fileName
      - text: Remove the single CSV report {fileName}.
        slots:
          fileName: path.fileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-inappreports/zip/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Download report CSVs as a zip
      effect: read
      questions:
      - Can I download several report CSVs bundled in a zip?
      - How do I get my reports as one zip archive?
      instructions:
      - text: Download reports {fileName} as a zip.
        slots:
          fileName: query.fileName
      - text: Zip up the report CSVs {fileName} for download.
        slots:
          fileName: query.fileName
      method: generated
      generated: '2026-10-01'