Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Discounts API

7 actions 7 updates phrasing extends openapi/cvent-discounts-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 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

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 Discounts API
  version: 1.0.0
extends: openapi/cvent-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 event discount list include account-level codes too?
      instructions:
      - text: List discounts for event {id}.
        slots:
          id: path.id
      - text: List event {id}'s discounts matching {filter}, sorted by {sort}.
        slots:
          id: path.id
          filter: query.filter
          sort: query.sort
      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:
      - How do I set up a new discount code for my event?
      - Can I add a promo code to one specific event?
      instructions:
      - text: Create a new discount in event {id}.
        slots:
          id: path.id
      - text: Add a discount code to event {id}.
        slots:
          id: 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 in my event have discounts attached?
      - Can I filter the discounted agenda items for an event?
      instructions:
      - text: List discounted agenda items in event {id}.
        slots:
          id: path.id
      - text: Show event {id}'s agenda items with discounts matching {filter}.
        slots:
          id: 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:
      - How do I change an existing discount code in my event?
      - Do fields I leave out reset to defaults when I update a discount?
      instructions:
      - text: Update discount {discountId} in event {id}.
        slots:
          discountId: path.discountId
          id: path.id
      - text: Replace the settings of discount {discountId} for event {id}.
        slots:
          discountId: path.discountId
          id: 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:
      - How do I make a discount apply to a specific session or admission item?
      - Can I link an agenda item to an event discount?
      instructions:
      - text: Link agenda item {agendaItemId} to discount {discountId} in event {id}.
        slots:
          agendaItemId: path.agendaItemId
          discountId: path.discountId
          id: path.id
      - text: Apply discount {discountId} to agenda item {agendaItemId} at event {id}.
        slots:
          discountId: path.discountId
          agendaItemId: path.agendaItemId
          id: 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:
      - How do I remove a discount from one session without deleting the discount?
      - Can I unlink an agenda item from an event discount?
      instructions:
      - text: Unlink agenda item {agendaItemId} from discount {discountId} in event {id}.
        slots:
          agendaItemId: path.agendaItemId
          discountId: path.discountId
          id: path.id
      - text: Stop discount {discountId} applying to agenda item {agendaItemId} at event {id}.
        slots:
          discountId: path.discountId
          agendaItemId: path.agendaItemId
          id: path.id
      method: generated
      generated: '2026-09-26'