Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Event Features API

5 actions 5 updates phrasing extends openapi/cvent-registration-event-features-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['/events/{id}/features'].get

$.paths['/events/{id}/features/{type}'].put

$.paths['/events/{id}/features/{type}/launch'].post

$.paths['/events/{id}/weblinks'].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 Event Features API
  version: 1.0.0
extends: openapi/cvent-registration-event-features-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['/events/{id}/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List features available for an event
      effect: read
      questions:
      - Which features are enabled or available on my event?
      - Can I list event features in a specific locale?
      instructions:
      - text: List features for event {id}.
        slots:
          id: path.id
      - text: List event {id} features in locale {locale}.
        slots:
          id: path.id
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/features/{type}'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an event feature
      effect: write
      questions:
      - How do I turn a feature on or off for an event?
      - Can I set a feature's tier and configuration when enabling it?
      instructions:
      - text: 'Set feature {type} on event {id} enabled: {enabled}.'
        slots:
          type: path.type
          id: path.id
          enabled: requestBody.enabled
      - text: Enable feature {type} for event {id} at tier {enabledTier}.
        slots:
          type: path.type
          id: path.id
          enabledTier: requestBody.enabledTier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/features/{type}/launch'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch an event feature to its audience
      effect: write
      questions:
      - How do I make an event feature live for attendees?
      - Can I clear test data when launching a feature?
      instructions:
      - text: Launch feature {type} on event {id}.
        slots:
          type: path.type
          id: path.id
      - text: 'Launch feature {type} for event {id} and delete test data: {deleteTestData}.'
        slots:
          type: path.type
          id: path.id
          deleteTestData: requestBody.deleteTestData
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/weblinks'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's weblinks
      effect: read
      questions:
      - What are the registration and website links for my event?
      - Can I get an event's weblinks for a particular locale?
      instructions:
      - text: List weblinks for event {id}.
        slots:
          id: path.id
      - text: List event {id} weblinks in locale {locale}.
        slots:
          id: path.id
          locale: query.locale
      method: generated
      generated: '2026-09-26'