Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Picklist Definition API

8 actions 8 updates phrasing extends openapi/conga-picklist-definition-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 8

$.info
$.paths['/api/schema/v1/objects/{objectName}/picklists'].post
$.paths['/api/schema/v1/objects/{objectName}/picklists/rename'].patch
$.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}'].put
$.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries'].post
$.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/bulk'].put
$.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/bulk'].post
$.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/{picklistEntryValue}'].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 Schema Manager Picklist Definition API
  version: 1.0.0
extends: openapi/conga-picklist-definition-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: 7
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a picklist
      effect: write
      questions:
      - How do I add a new picklist to an object?
      - Can a picklist accept values that are not configured?
      instructions:
      - text: Create picklist {name} on object {object}.
        slots:
          name: requestBody.Name
          object: path.objectName
      - text: Add picklist {name} to {object} with entries {entries}.
        slots:
          name: requestBody.Name
          object: path.objectName
          entries: requestBody.PicklistEntries
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/rename'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a picklist
      effect: write
      questions:
      - Can I rename an existing picklist?
      - How do I change a picklist's name?
      instructions:
      - text: Rename picklist {old} to {new} on {object}.
        slots:
          old: requestBody.OldPicklistName
          new: requestBody.NewPicklistName
          object: path.objectName
      - text: Change the picklist name {old} on object {object}.
        slots:
          old: requestBody.OldPicklistName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a picklist
      effect: write
      questions:
      - Can I deprecate a picklist?
      - How do I allow unconfigured values in a picklist?
      instructions:
      - text: Update picklist {picklist} on {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      - text: Deprecate picklist {picklist} of {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a picklist entry
      effect: write
      questions:
      - How do I add one value to a picklist?
      - Can I set the display order of a new picklist value?
      instructions:
      - text: Add value {value} to picklist {picklist} on {object}.
        slots:
          value: requestBody.Value
          picklist: path.picklistName
          object: path.objectName
      - text: Add entry {value} shown as {text} to {picklist} of {object}.
        slots:
          value: requestBody.Value
          text: requestBody.DisplayText
          picklist: path.picklistName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update picklist entries in bulk
      effect: write
      questions:
      - Can I edit many picklist values at once?
      - How do I bulk-update entries by value?
      instructions:
      - text: Bulk update entries of picklist {picklist} on {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      - text: Edit several values in {picklist} of {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add picklist entries in bulk
      effect: write
      questions:
      - Can I add many values to a picklist in one call?
      - How do I bulk-create picklist entries?
      instructions:
      - text: Bulk add entries to picklist {picklist} on {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      - text: Create several new values in {picklist} of {object}.
        slots:
          picklist: path.picklistName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/{picklistEntryValue}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one picklist entry
      effect: write
      questions:
      - How do I change the label of one picklist value?
      - Can I deprecate a single picklist value?
      instructions:
      - text: Update entry {value} in picklist {picklist} on {object}.
        slots:
          value: path.picklistEntryValue
          picklist: path.picklistName
          object: path.objectName
      - text: Relabel value {value} of {picklist} on {object} as {text}.
        slots:
          value: path.picklistEntryValue
          picklist: path.picklistName
          object: path.objectName
          text: requestBody.DisplayText
      method: generated
      generated: '2026-10-01'