Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Guest User API

6 actions 6 updates phrasing extends openapi/conga-guest-user-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/user-management/v1/user/guest'].post
$.paths['/api/user-management/v1/user/guest/storefront'].patch
$.paths['/api/user-management/v1/user/guest/{userId}'].put
$.paths['/api/user-management/v1/user/guest/{userId}'].delete
$.paths['/api/user-management/v1/user/guest/{userId}/restore'].put

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 User Management Guest User API
  version: 1.0.0
extends: openapi/conga-guest-user-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/user-management/v1/user/guest'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a guest user
      effect: write
      questions:
      - How do I create a guest user for a storefront?
      - What profile details can a guest user have?
      instructions:
      - text: Create guest user {first} {last} with email {email}.
        slots:
          first: requestBody.FirstName
          last: requestBody.LastName
          email: requestBody.Email
      - text: Add a guest user {email} with locale {locale}.
        slots:
          email: requestBody.Email
          locale: requestBody.Locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/guest/storefront'].patch
  update:
    x-apievangelist-phrasing:
      intent: Register a storefront for a guest user
      effect: write
      questions:
      - How do I register a storefront URL for guest access?
      - Can I mark a storefront as headless commerce?
      instructions:
      - text: Register storefront {url} of type {type}.
        slots:
          url: requestBody.StorefrontUrl
          type: requestBody.StorefrontType
      - text: Link guest user {user} to storefront {url}.
        slots:
          user: requestBody.GuestUserId
          url: requestBody.StorefrontUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/guest/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a guest user
      effect: write
      questions:
      - How do I change a guest user's email or name?
      - Can I update a guest user's time zone?
      instructions:
      - text: Update guest user {user} email to {email}.
        slots:
          user: path.userId
          email: requestBody.Email
      - text: Set time zone {tz} on guest user {user}.
        slots:
          tz: requestBody.Timezone
          user: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/guest/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a guest user
      effect: destructive
      questions:
      - Can I deactivate a guest user?
      - What happens to a guest user when deactivated?
      instructions:
      - text: Deactivate guest user {user}.
        slots:
          user: path.userId
      - text: Turn off guest account {user}.
        slots:
          user: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/guest/{userId}/restore'].put
  update:
    x-apievangelist-phrasing:
      intent: Restore a deactivated guest user
      effect: write
      questions:
      - Can I bring back a guest user I deactivated?
      - How do I reactivate a guest account?
      instructions:
      - text: Restore guest user {user}.
        slots:
          user: path.userId
      - text: Reactivate deactivated guest account {user}.
        slots:
          user: path.userId
      method: generated
      generated: '2026-10-01'