Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Discounts API

7 actions 7 updates phrasing extends openapi/cvent-event-cloud-discounts-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/events/{id}/discounts'].get

$.paths['/events/{id}/discounts'].post

$.paths['/events/{id}/discounts/agenda-items'].get

$.paths['/events/{id}/discounts/{discountId}'].put

$.paths['/events/{id}/discounts/{discountId}/agenda-items/{agendaItemId}'].put

$.paths['/events/{id}/discounts/{discountId}/agenda-items/{agendaItemId}'].delete

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 Discounts API
  version: 1.0.0
extends: openapi/cvent-event-cloud-discounts-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: 6
- target: $.paths['/events/{id}/discounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's discounts
      effect: read
      questions:
      - What discount codes are being used in my event?
      - Does the discount list include account-level codes as well as event ones?
      instructions:
      - text: List discounts for event {event}.
        slots:
          event: path.id
      - text: List discounts in event {event} matching {filter}.
        slots:
          event: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/discounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a discount in an event
      effect: write
      questions:
      - Can I create a new discount code for an event?
      - How do I add a promo discount to registration?
      instructions:
      - text: Create a discount in event {event}.
        slots:
          event: path.id
      - text: Add a new discount code to event {event}.
        slots:
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/discounts/agenda-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List agenda items tied to discounts
      effect: read
      questions:
      - Which sessions or admission items have a discount attached?
      - Can I see what agenda items each discount applies to?
      instructions:
      - text: List discounted agenda items in event {event}.
        slots:
          event: path.id
      - text: List agenda items linked to discounts in event {event} matching {filter}.
        slots:
          event: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/discounts/{discountId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event discount
      effect: write
      questions:
      - Can I change an existing discount's settings?
      - What happens to fields I omit when I update a discount?
      instructions:
      - text: Update discount {discountId} in event {event}.
        slots:
          discountId: path.discountId
          event: path.id
      - text: Replace the settings of discount {discountId} for event {event}.
        slots:
          discountId: path.discountId
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/discounts/{discountId}/agenda-items/{agendaItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply a discount to an agenda item
      effect: write
      questions:
      - Can I make a discount apply to a specific session or admission item?
      - How do I link an agenda item to a discount?
      instructions:
      - text: Link agenda item {agendaItemId} to discount {discountId} in event {event}.
        slots:
          agendaItemId: path.agendaItemId
          discountId: path.discountId
          event: path.id
      - text: Apply discount {discountId} to agenda item {agendaItemId} for event {event}.
        slots:
          discountId: path.discountId
          agendaItemId: path.agendaItemId
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/discounts/{discountId}/agenda-items/{agendaItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop a discount applying to an agenda item
      effect: destructive
      questions:
      - Can I remove a discount from one agenda item?
      - How do I unlink a session from a discount code?
      instructions:
      - text: Unlink agenda item {agendaItemId} from discount {discountId} in event {event}.
        slots:
          agendaItemId: path.agendaItemId
          discountId: path.discountId
          event: path.id
      - text: Stop discount {discountId} applying to agenda item {agendaItemId} at event {event}.
        slots:
          discountId: path.discountId
          agendaItemId: path.agendaItemId
          event: path.id
      method: generated
      generated: '2026-09-26'