Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST RFP Requirements API

8 actions 8 updates phrasing extends openapi/cvent-rfp-requirements-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 8

$.info

$.paths['/rfps/{rfpId}/agenda-items'].get

$.paths['/rfps/{rfpId}/agenda-items/schedules'].get

$.paths['/rfps/{rfpId}/attachments'].get

$.paths['/rfps/{rfpId}/custom-fields/answers'].get

$.paths['/rfps/{rfpId}/guest-rooms'].get

$.paths['/rfps/{rfpId}/internal-documents'].get

$.paths['/rfps/{rfpId}/questions'].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 RFP Requirements API
  version: 1.0.0
extends: openapi/cvent-rfp-requirements-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: 7
- target: $.paths['/rfps/{rfpId}/agenda-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an RFP's agenda items
      effect: read
      questions:
      - What meetings and functions are requested in an RFP's agenda?
      - Can I filter the agenda items on an RFP?
      instructions:
      - text: List agenda items for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show RFP {rfpId}'s agenda items matching {filter}.
        slots:
          rfpId: path.rfpId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/agenda-items/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List schedules for an RFP's agenda items
      effect: read
      questions:
      - When are the agenda items on an RFP scheduled to happen?
      - Can I see the day-by-day schedule for an RFP's agenda?
      instructions:
      - text: List agenda item schedules for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show when each agenda item on RFP {rfpId} is scheduled.
        slots:
          rfpId: path.rfpId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an RFP's attachments
      effect: read
      questions:
      - What files were attached to an RFP sent to venues?
      - Can I filter the attachments on an RFP?
      instructions:
      - text: List attachments on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show RFP {rfpId}'s attachments matching {filter}.
        slots:
          rfpId: path.rfpId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/custom-fields/answers'].get
  update:
    x-apievangelist-phrasing:
      intent: List an RFP's custom field answers
      effect: read
      questions:
      - What answers were given to custom fields on an RFP?
      - Can I expand related details when listing an RFP's custom field answers?
      instructions:
      - text: List custom field answers for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show RFP {rfpId}'s custom field answers, expanding {expand}.
        slots:
          rfpId: path.rfpId
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/guest-rooms'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an RFP's guest room requirements
      effect: read
      questions:
      - How many guest rooms does an RFP request?
      - What are the sleeping room requirements on a particular RFP?
      instructions:
      - text: Get guest room requirements for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show the room block requested in RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/internal-documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an RFP's internal documents
      effect: read
      questions:
      - Which internal-only documents are stored on an RFP?
      - Can I filter the internal documents attached to an RFP?
      instructions:
      - text: List internal documents on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show RFP {rfpId}'s internal documents matching {filter}.
        slots:
          rfpId: path.rfpId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an RFP's questions
      effect: read
      questions:
      - What standard and custom questions are asked in an RFP?
      - Does listing RFP questions include the suppliers' answers?
      instructions:
      - text: List the questions on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show the standard and custom questions asked in RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      method: generated
      generated: '2026-09-26'