Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for File Store CDN Store API

5 actions 5 updates phrasing extends openapi/conga-cdn-store-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 5

$.info
$.paths['/api/cdnstore/v1/files'].delete
$.paths['/api/cdnstore/v1/files/bulk'].delete
$.paths['/api/cdnstore/v1/files/{fileFullPath}'].get
$.paths['/api/cdnstore/v1/files/{fileFullPath}'].post

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 File Store CDN Store API
  version: 1.0.0
extends: openapi/conga-cdn-store-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: 4
- target: $.paths['/api/cdnstore/v1/files'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one file from the CDN store
      effect: destructive
      questions:
      - How do I delete a single file from the CDN store by name and path?
      - What happens if the file I try to delete from the CDN doesn't exist?
      instructions:
      - text: Delete file {FileName} at path {FilePath} from the CDN store.
        slots:
          FileName: requestBody.FileName
          FilePath: requestBody.FilePath
      - text: Remove the CDN file named {FileName}.
        slots:
          FileName: requestBody.FileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cdnstore/v1/files/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete multiple files from the CDN store
      effect: destructive
      questions:
      - Can I delete several CDN files under the same folder in one request?
      - How do I bulk-remove files from a CDN store path?
      instructions:
      - text: Delete files {FileNames} under {FilePath} in the CDN store.
        slots:
          FileNames: requestBody.FileNames
          FilePath: requestBody.FilePath
      - text: Bulk-remove these CDN files from folder {FilePath}.
        slots:
          FilePath: requestBody.FilePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cdnstore/v1/files/{fileFullPath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file from the CDN store
      effect: read
      questions:
      - How do I fetch a file's contents and details from the CDN store?
      - Can I read back a file I uploaded to the CDN by its full path?
      instructions:
      - text: Get the CDN file at {fileFullPath}.
        slots:
          fileFullPath: path.fileFullPath
      - text: Download {fileFullPath} from the CDN store with its details.
        slots:
          fileFullPath: path.fileFullPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cdnstore/v1/files/{fileFullPath}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to the CDN store
      effect: write
      questions:
      - How do I upload a file to the Conga CDN store?
      - What's the maximum file size I can upload to the CDN?
      instructions:
      - text: Upload this file to the CDN store at {fileFullPath}.
        slots:
          fileFullPath: path.fileFullPath
      - text: Put a file of up to 100 MB at CDN path {fileFullPath}.
        slots:
          fileFullPath: path.fileFullPath
      method: generated
      generated: '2026-10-01'