Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST File API

3 actions 3 updates phrasing extends openapi/cvent-registration-file-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/files'].post

$.paths['/files/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST File API
  version: 1.0.0
extends: openapi/cvent-registration-file-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: 2
- target: $.paths['/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to attach to records
      effect: write
      questions:
      - How do I upload an image or document so I can attach it to an exhibitor or payment?
      - What's the size limit for uploaded files, and do unattached files expire?
      instructions:
      - text: Upload {file} and give me its file ID.
        slots:
          file: requestBody.file
      - text: Upload the image {file} so I can use it as a banner.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/files/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get where an uploaded file lives
      effect: read
      questions:
      - Where is an uploaded file stored?
      - Can I get the location URL for a file ID?
      instructions:
      - text: Get the location of file {id}.
        slots:
          id: path.id
      - text: Show the upload location URL for file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'