Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Users API

8 actions 8 updates phrasing extends openapi/cvent-registration-users-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['/account-user-groups'].get

$.paths['/account-user-groups'].post

$.paths['/account-user-groups/{userGroupId}'].get

$.paths['/account-user-groups/{userGroupId}'].put

$.paths['/account-user-groups/{userGroupId}'].delete

$.paths['/account-user-groups/{userGroupId}/users/{userId}'].post

$.paths['/account-user-groups/{userGroupId}/users/{userId}'].delete

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 Users API
  version: 1.0.0
extends: openapi/cvent-registration-users-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['/account-user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List account user groups
      effect: read
      questions:
      - What user groups exist in my Cvent account?
      - Can I filter the list of account user groups?
      instructions:
      - text: List account user groups.
      - text: List user groups matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account user group
      effect: write
      questions:
      - How do I create a new user group for my team?
      - What fields are required to set up a user group?
      instructions:
      - text: Create a user group named {name}.
        slots:
          name: requestBody.name
      - text: Create user group {name} with ID {id} described as {description}.
        slots:
          name: requestBody.name
          id: requestBody.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account user group
      effect: read
      questions:
      - Can I look up one user group by its ID?
      - What name and description does a given user group have?
      instructions:
      - text: Get user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Show the details of account user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a user group
      effect: write
      questions:
      - How do I rename an existing user group?
      - Can I change a user group's description?
      instructions:
      - text: Rename user group {userGroupId} to {name}.
        slots:
          userGroupId: path.userGroupId
          name: requestBody.name
      - text: Update group {userGroupId}'s description to {description}.
        slots:
          userGroupId: path.userGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account user group
      effect: destructive
      questions:
      - We no longer need a user group; can I delete it?
      - Can I permanently remove an account user group?
      instructions:
      - text: Delete user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Permanently remove account user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a user group
      effect: write
      questions:
      - How do I put a user into a user group?
      - Can I give someone a group's access by adding them to it?
      instructions:
      - text: Add user {userId} to group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Make {userId} a member of user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-user-groups/{userGroupId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a user group
      effect: destructive
      questions:
      - Can I take someone out of a user group?
      - Can I remove a user's membership in a group without deleting the group?
      instructions:
      - text: Remove user {userId} from group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      - text: Revoke {userId}'s membership in user group {userGroupId}.
        slots:
          userId: path.userId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'