Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST RFP Suppliers API

3 actions 3 updates phrasing extends openapi/cvent-registration-rfp-suppliers-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 3

$.info
$.paths['/rfps/{rfpId}/recipients/history'].get
$.paths['/rfps/{rfpId}/suppliers'].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 RFP Suppliers API
  version: 1.0.0
extends: openapi/cvent-registration-rfp-suppliers-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: 2
- target: $.paths['/rfps/{rfpId}/recipients/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List who was copied on an RFP
      effect: read
      questions:
      - Who has been copied as a recipient on an RFP over time?
      - Can I filter the recipient history log of an RFP?
      instructions:
      - text: List the recipient history for RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: List RFP {rfpId} recipient log entries matching {filter}.
        slots:
          rfpId: path.rfpId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}/suppliers'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppliers on an RFP
      effect: read
      questions:
      - Which venues and hotels were sent a given RFP?
      - Can I expand extra supplier details when listing an RFP's suppliers?
      instructions:
      - text: List the suppliers on RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: List RFP {rfpId} suppliers, expanding {expand}.
        slots:
          rfpId: path.rfpId
          expand: query.expand
      method: generated
      generated: '2026-09-26'