Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Compliance API

5 actions 5 updates phrasing extends openapi/cvent-registration-compliance-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 5

$.info
$.paths['/logs/communications/configuration'].get
$.paths['/logs/communications/configuration'].put
$.paths['/logs/communications/messages'].get
$.paths['/logs/communications/messages/filter'].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 Cvent REST Compliance API
  version: 1.0.0
extends: openapi/cvent-registration-compliance-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: 4
- target: $.paths['/logs/communications/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the communication log configuration
      effect: read
      questions:
      - Which communication types is my account recording in the compliance log?
      - Is chat or session Q&A logging turned on for my account?
      instructions:
      - text: Show my communication compliance configuration.
      - text: Tell me which message types the communication log is capturing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logs/communications/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Choose which communications get logged
      effect: write
      questions:
      - How do I turn on logging of chats or emails for compliance?
      - Can I pick exactly which message types go into the communication log?
      instructions:
      - text: Set the logged communication types to {enabledMessageTypes}.
        slots:
          enabledMessageTypes: requestBody.enabledMessageTypes
      - text: Record only {enabledMessageTypes} in the communication compliance log.
        slots:
          enabledMessageTypes: requestBody.enabledMessageTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logs/communications/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List logged communication messages
      effect: read
      questions:
      - What emails, chats and session Q&A messages has my account logged between two dates?
      - Do I have to pass a filter to read the communication log?
      instructions:
      - text: List communication log messages from {after} to {before}.
        slots:
          after: query.after
          before: query.before
      - text: List logged messages matching query filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logs/communications/messages/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the communication log with a body filter
      effect: read
      questions:
      - Can I send a long filter in the request body to search the communication log?
      - Is there a POST search for logged chats and emails?
      instructions:
      - text: Search the communication log with body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search logged messages between {after} and {before} using body filter {filter}.
        slots:
          after: query.after
          before: query.before
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'