Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Meeting Request API

9 actions 9 updates phrasing extends openapi/cvent-meeting-request-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 9

$.info
$.paths['/events/{id}/meeting-requests'].get
$.paths['/meeting-request-forms'].get
$.paths['/meeting-request-forms/{id}'].get
$.paths['/meeting-request-forms/{id}/requests'].get
$.paths['/meeting-request-forms/{id}/requests'].put
$.paths['/meeting-request-forms/{id}/requests'].post
$.paths['/meeting-request-forms/{id}/requests/{requestId}'].get
$.paths['/meeting-requests/{requestId}/documents'].get

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 Meeting Request API
  version: 1.0.0
extends: openapi/cvent-meeting-request-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: 8
- target: $.paths['/events/{id}/meeting-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the meeting request behind an event
      effect: read
      questions:
      - Which meeting request was this event created from?
      - Can I see the original meeting request connected to an event?
      instructions:
      - text: Get the meeting request linked to event {id}.
        slots:
          id: path.id
      - text: Show the originating meeting request for event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List meeting request forms
      effect: read
      questions:
      - What meeting request forms do we have set up?
      - Can I filter our meeting request forms?
      instructions:
      - text: List meeting request forms matching {filter}.
        slots:
          filter: query.filter
      - text: Show the first {limit} meeting request forms.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting request form
      effect: read
      questions:
      - What questions and settings does a particular meeting request form have?
      - How do I fetch one meeting request form?
      instructions:
      - text: Get meeting request form {id}.
        slots:
          id: path.id
      - text: Show the setup of meeting request form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms/{id}/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List meeting requests submitted on a form
      effect: read
      questions:
      - Which meeting requests have been submitted through a given form?
      - Can I see meeting requests submitted after a date?
      instructions:
      - text: List meeting requests submitted on form {id}.
        slots:
          id: path.id
      - text: Show requests on form {id} submitted after {after}.
        slots:
          id: path.id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms/{id}/requests'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update meeting requests on a form
      effect: write
      questions:
      - How do I add answers to several existing meeting requests at once?
      - Can I update meeting requests while skipping required question checks?
      instructions:
      - text: Bulk update the existing meeting requests on form {id}.
        slots:
          id: path.id
      - text: 'Update meeting requests on form {id} with required question validation skipped: {skipRequiredQuestionValidation}.'
        slots:
          id: path.id
          skipRequiredQuestionValidation: query.skipRequiredQuestionValidation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms/{id}/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create meeting requests on a form
      effect: write
      questions:
      - How do I submit new meeting requests through an active form via the API?
      - Can I create several meeting requests at once, including room and budget answers?
      instructions:
      - text: Create new meeting requests on active form {id}.
        slots:
          id: path.id
      - text: 'Submit a batch of meeting requests to form {id}, skipping required checks: {skipRequiredQuestionValidation}.'
        slots:
          id: path.id
          skipRequiredQuestionValidation: query.skipRequiredQuestionValidation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-request-forms/{id}/requests/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single meeting request
      effect: read
      questions:
      - What did someone ask for in a specific meeting request?
      - How do I read the answers on one submitted meeting request?
      instructions:
      - text: Get meeting request {requestId} on form {id}.
        slots:
          requestId: path.requestId
          id: path.id
      - text: Show the answers in request {requestId} from form {id}.
        slots:
          requestId: path.requestId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meeting-requests/{requestId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents attached to a meeting request
      effect: read
      questions:
      - What attachments came with a meeting request?
      - Can I get download links for a meeting request's documents?
      instructions:
      - text: List documents on meeting request {requestId}.
        slots:
          requestId: path.requestId
      - text: 'Show meeting request {requestId} attachments with reference links: {includeReferenceLink}.'
        slots:
          requestId: path.requestId
          includeReferenceLink: query.includeReferenceLink
      method: generated
      generated: '2026-09-26'