Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Compliance API

5 actions 5 updates phrasing extends openapi/cvent-compliance-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent 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-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 communication compliance settings
      effect: read
      questions:
      - Which communication types is my account recording for compliance?
      - How do I see the current communication log configuration?
      instructions:
      - text: Show my account's communication compliance configuration.
      - text: Tell me which message types are enabled in the communication log.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logs/communications/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Change which communications are logged
      effect: write
      questions:
      - How do I choose which message types get recorded in the communication log?
      - Can I turn on logging for chat and session Q&A?
      instructions:
      - text: Set the enabled communication log message types to {enabledMessageTypes}.
        slots:
          enabledMessageTypes: requestBody.enabledMessageTypes
      - text: Record only {enabledMessageTypes} in the compliance communication log.
        slots:
          enabledMessageTypes: requestBody.enabledMessageTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logs/communications/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List communication log messages
      effect: read
      questions:
      - How do I review emails, chats and session Q&A logged for compliance?
      - Can I pull communication log messages between two dates?
      instructions:
      - text: List communication log messages after {after} and before {before}.
        slots:
          after: query.after
          before: query.before
      - text: List logged communications matching the 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 communication logs with a body filter
      effect: read
      questions:
      - Can I post a long filter to search the compliance communication log?
      - How do I query logged chats and emails with a complex filter in the request body?
      instructions:
      - text: Search the communication log using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find logged messages matching posted filter {filter} after {after}.
        slots:
          filter: requestBody.filter
          after: query.after
      method: generated
      generated: '2026-09-26'