Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST RFP Management API

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

$.info
$.paths['/rfps/lead-sources/{leadSourceId}'].get
$.paths['/rfps/lead-sources/{leadSourceId}/sections/{leadSourceSectionId}'].get
$.paths['/rfps/{rfpId}'].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 Management API
  version: 1.0.0
extends: openapi/cvent-registration-rfp-management-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: 3
- target: $.paths['/rfps/lead-sources/{leadSourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get where an RFP came from
      effect: read
      questions:
      - Which software or website did an RFP originate from?
      - What does an RFP lead source record tell me?
      instructions:
      - text: Get RFP lead source {leadSourceId}.
        slots:
          leadSourceId: path.leadSourceId
      - text: Show the origin details for lead source {leadSourceId}.
        slots:
          leadSourceId: path.leadSourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/lead-sources/{leadSourceId}/sections/{leadSourceSectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the specific channel within an RFP lead source
      effect: read
      questions:
      - Which form, domain or integration within a lead source did an RFP come through?
      - Can I attribute an RFP more granularly than its lead source?
      instructions:
      - text: Get section {leadSourceSectionId} of RFP lead source {leadSourceId}.
        slots:
          leadSourceSectionId: path.leadSourceSectionId
          leadSourceId: path.leadSourceId
      - text: Show which channel {leadSourceSectionId} under lead source {leadSourceId} refers to.
        slots:
          leadSourceSectionId: path.leadSourceSectionId
          leadSourceId: path.leadSourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rfps/{rfpId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an RFP's details
      effect: read
      questions:
      - How do I pull up the basic details of an RFP?
      - Can I expand related data when fetching an RFP?
      instructions:
      - text: Get RFP {rfpId}.
        slots:
          rfpId: path.rfpId
      - text: Get RFP {rfpId} expanded with {expand}.
        slots:
          rfpId: path.rfpId
          expand: query.expand
      method: generated
      generated: '2026-09-26'