Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST RFP Requirements API

8 actions 8 updates phrasing extends openapi/cvent-registration-rfp-requirements-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 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-registration-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 meeting and function agenda items did the planner request in an RFP?
      - Can I filter the agenda items on an RFP?
      instructions:
      - text: List the agenda items on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: List RFP {rfpId} 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 requested agenda items in an RFP scheduled to happen?
      - Where do I see the day-by-day schedule of agenda items on an RFP?
      instructions:
      - text: List the agenda item schedules for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show dates and times for each agenda item in RFP {rfpId}.
        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 did the planner attach to an RFP for suppliers?
      - Can I filter the attachments on an RFP?
      instructions:
      - text: List the attachments on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: List RFP {rfpId} 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: List 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 hotel guest rooms does an RFP ask for?
      - Where can I see the sleeping room requirements for an RFP?
      instructions:
      - text: Get the 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 an RFP's internal documents?
      instructions:
      - text: List the internal documents on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: List RFP {rfpId} 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 does an RFP ask suppliers?
      - Does the RFP questions list include the answers?
      instructions:
      - text: List the questions on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Show the standard and custom questions suppliers must answer for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      method: generated
      generated: '2026-09-26'