Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Authentication API

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

$.info
$.paths['/oauth2/authorize'].get
$.paths['/oauth2/token'].post
$.paths['/token-validation'].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 Authentication API
  version: 1.0.0
extends: openapi/cvent-authentication-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['/oauth2/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Start the OAuth2 authorization code flow
      effect: read
      questions:
      - How do I send a user to Cvent to authorize my app?
      - Can I use localhost as a redirect URI while developing the OAuth flow?
      instructions:
      - text: Build an authorization request for client {client_id} redirecting to {redirect_uri} with response type {response_type}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
          response_type: query.response_type
      - text: Request an authorization code for {client_id} with scopes {scope} and state {state}, returning to {redirect_uri}.
        slots:
          client_id: query.client_id
          scope: query.scope
          state: query.state
          redirect_uri: query.redirect_uri
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get or refresh an access token
      effect: write
      questions:
      - How do I exchange an authorization code for an access token?
      - When does the token endpoint return a refresh token?
      instructions:
      - text: Get an access token for client {client_id} using grant type {grant_type}.
        slots:
          client_id: requestBody.client_id
          grant_type: requestBody.grant_type
      - text: Refresh the access token for {client_id} with refresh token {refresh_token} and grant type {grant_type}.
        slots:
          client_id: requestBody.client_id
          refresh_token: requestBody.refresh_token
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/token-validation'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that an access token is valid
      effect: read
      questions:
      - Is my current access token still valid?
      - How can I verify a bearer token before making calls?
      instructions:
      - text: Validate my current access token.
      - text: Check whether the token I am using is still accepted.
      method: generated
      generated: '2026-09-26'