Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Dependent Picklist Definition API

5 actions 5 updates phrasing extends openapi/conga-dependent-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 5

$.info

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].get

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].put

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].post

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].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 Schema Manager Dependent Picklist Definition API
  version: 1.0.0
extends: openapi/conga-dependent-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: 4
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field's dependent picklist mapping
      effect: read
      questions:
      - Which controlling field drives the values of a dependent picklist in Conga?
      - What picklist entries depend on each controlling value for a field?
      instructions:
      - text: Show the dependent picklist mapping for field {fieldName} on object {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      - text: Fetch the controlling-to-dependent entries for {objectName}.{fieldName}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field's dependent picklist mapping
      effect: write
      questions:
      - Can I change which dependent values show for a controlling picklist value?
      - How do I edit an existing dependent picklist mapping?
      instructions:
      - text: Update the dependent picklist on {objectName} field {fieldName} with entries {ControllingAndDependentPicklistEntries}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
          ControllingAndDependentPicklistEntries: requestBody.ControllingAndDependentPicklistEntries
      - text: Change the controlling field of the existing dependent picklist {objectName}.{fieldName} to {ControllingFieldName}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
          ControllingFieldName: requestBody.ControllingFieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dependent picklist mapping
      effect: write
      questions:
      - How do I make one picklist's options depend on another field's value?
      - What do I need to define a new dependent picklist on an object?
      instructions:
      - text: Create a new dependent picklist for field {fieldName} on {objectName}, controlled by {ControllingFieldName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
          ControllingFieldName: requestBody.ControllingFieldName
      - text: Set up dependent picklist {Name} on {objectName}.{fieldName} for the first time.
        slots:
          Name: requestBody.Name
          objectName: path.objectName
          fieldName: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a field's dependent picklist mapping
      effect: destructive
      questions:
      - Can I remove the dependency so a picklist no longer depends on another field?
      - Which call deletes dependent picklist metadata for a field?
      instructions:
      - text: Delete the dependent picklist on field {fieldName} of object {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      - text: Remove the picklist dependency from {objectName}.{fieldName}.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
      method: generated
      generated: '2026-10-01'