Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager RecordType Definition API

3 actions 3 updates phrasing extends openapi/conga-recordtype-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 3

$.info

$.paths['/api/schema/v1/objects/{objectName}/recordtype-entries'].post

$.paths['/api/schema/v1/objects/{objectName}/recordtype-entries/bulk'].put

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 RecordType Definition API
  version: 1.0.0
extends: openapi/conga-recordtype-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: 2
- target: $.paths['/api/schema/v1/objects/{objectName}/recordtype-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a record type picklist value
      effect: write
      questions:
      - Can I add a new record type value to an object in Conga?
      - Can I set the display text and order of a new record type entry?
      instructions:
      - text: Add record type value {Value} to object {objectName}.
        slots:
          Value: requestBody.Value
          objectName: path.objectName
      - text: Create record type entry {Value} on {objectName} shown as {DisplayText} at position {Sequence}.
        slots:
          Value: requestBody.Value
          objectName: path.objectName
          DisplayText: requestBody.DisplayText
          Sequence: requestBody.Sequence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/recordtype-entries/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update record type picklist values in bulk
      effect: write
      questions:
      - Is there a way to update all the record type values on an object at once?
      - Can I bulk edit the record type picklist entries for an object?
      instructions:
      - text: Update the record type entries on object {objectName} in bulk.
        slots:
          objectName: path.objectName
      - text: Replace several record type picklist values for {objectName} with this list.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'