Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Field Definition API

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

$.info

$.paths['/api/schema/v1/objects/formula-functions'].get

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

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

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}'].delete

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/deprecate'].patch

$.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/expression/validate'].post

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 Field Definition API
  version: 1.0.0
extends: openapi/conga-field-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: 6
- target: $.paths['/api/schema/v1/objects/formula-functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List formula functions
      effect: read
      questions:
      - Which functions can I use in formula fields?
      - What formula functions does the schema manager support?
      instructions:
      - text: List the available formula functions.
      - text: Show every function allowed in field formulas.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a field on an object
      effect: write
      questions:
      - How do I add a custom field to an object?
      - Can I create a lookup or formula field through the schema API?
      instructions:
      - text: Add field {field} of type {type} to object {object}.
        slots:
          field: requestBody.FieldName
          type: requestBody.DataType
          object: path.objectName
      - text: Create a lookup field {field} on {object} pointing to {target}.
        slots:
          field: requestBody.FieldName
          object: path.objectName
          target: requestBody.LookupObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a field definition
      effect: write
      questions:
      - How do I change an existing field's display name or default?
      - Can I make an existing field required?
      instructions:
      - text: Update field {field} on {object} with display name {label}.
        slots:
          field: path.fieldName
          object: path.objectName
          label: requestBody.DisplayName
      - text: Set the default value of {object}.{field} to {value}.
        slots:
          object: path.objectName
          field: path.fieldName
          value: requestBody.DefaultValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - Can I delete a custom field from an object?
      - What happens to data when a custom field is removed?
      instructions:
      - text: Delete custom field {field} from object {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      - text: Remove field {field} on {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/deprecate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Deprecate a field
      effect: write
      questions:
      - Can I mark a field as deprecated instead of deleting it?
      - How do I phase out an old field on an object?
      instructions:
      - text: Deprecate field {field} on object {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      - text: Mark {object}.{field} as deprecated.
        slots:
          object: path.objectName
          field: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/fields/{fieldName}/expression/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a formula field expression
      effect: read
      questions:
      - Is my formula expression valid before I save it?
      - Can I check a formula for a specific return data type?
      instructions:
      - text: Validate expression {expr} for field {field} on {object}.
        slots:
          expr: requestBody.Expression
          field: path.fieldName
          object: path.objectName
      - text: Check formula {expr} returns {type} for {object}.{field}.
        slots:
          expr: requestBody.Expression
          type: requestBody.DataType
          object: path.objectName
          field: path.fieldName
      method: generated
      generated: '2026-10-01'