Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Organization API

6 actions 6 updates phrasing extends openapi/conga-organization-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/organization/currency'].get

$.paths['/api/user-management/v1/organization/info'].get

$.paths['/api/user-management/v1/organization/info'].patch

$.paths['/api/user-management/v1/organization/locale'].get

$.paths['/api/user-management/v1/organization/timezone'].get

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 User Management Organization API
  version: 1.0.0
extends: openapi/conga-organization-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/organization/currency'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization currency
      effect: read
      questions:
      - What currency is my organization set to?
      - Which default currency does our org use?
      instructions:
      - text: Show the organization currency.
      - text: Get our default currency type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/organization/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization information
      effect: read
      questions:
      - What details are stored about my organization?
      - Is guest user access enabled for our org?
      instructions:
      - text: Show the organization information.
      - text: Get our organization profile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/organization/info'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update organization information
      effect: write
      questions:
      - How do I change my organization's time zone or currency?
      - Can I turn on guest users for the organization?
      instructions:
      - text: Set the organization time zone to {tz}.
        slots:
          tz: requestBody.TimezoneId
      - text: Change the organization display name to {name} and currency to {currency}.
        slots:
          name: requestBody.OrganizationDisplayName
          currency: requestBody.Currency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/organization/locale'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization locale
      effect: read
      questions:
      - Which locale does my organization use?
      - What number and date format applies to our org?
      instructions:
      - text: Show the organization locale.
      - text: Get our locale setting.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/organization/timezone'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization time zone
      effect: read
      questions:
      - What time zone is my organization in?
      - Which time zone do org dates use?
      instructions:
      - text: Show the organization time zone.
      - text: Get our time zone setting.
      method: generated
      generated: '2026-10-01'