Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Schema Manager Complex Field Definition API

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

$.info
$.paths['/api/schema/v1/objects/{objectName}/complex-field/{complexFieldMetadataName}'].put
$.paths['/api/schema/v1/objects/{objectName}/complex-field/{complexFieldMetadataName}'].post
$.paths['/api/schema/v1/objects/{objectName}/complex-fields'].post
$.paths['/api/schema/v1/objects/{objectName}/complex-fields/{complexFieldMetadataName}'].post

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 Complex Field Definition API
  version: 1.0.0
extends: openapi/conga-complex-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: 4
- target: $.paths['/api/schema/v1/objects/{objectName}/complex-field/{complexFieldMetadataName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a complex field definition
      effect: write
      questions:
      - How do I change an existing complex field definition on an object?
      - Can I modify one complex field that already exists under a metadata name?
      instructions:
      - text: Update complex field {complexFieldMetadataName} on object {objectName}.
        slots:
          complexFieldMetadataName: path.complexFieldMetadataName
          objectName: path.objectName
      - text: Replace the definition of existing complex field {complexFieldMetadataName} on {objectName} with {Field}.
        slots:
          complexFieldMetadataName: path.complexFieldMetadataName
          objectName: path.objectName
          Field: requestBody.Field
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/complex-field/{complexFieldMetadataName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create one complex field
      effect: write
      questions:
      - How do I add a single new complex field under existing complex field metadata?
      - Can I create just one complex field on an object's schema?
      instructions:
      - text: Create a single complex field under {complexFieldMetadataName} on {objectName}.
        slots:
          complexFieldMetadataName: path.complexFieldMetadataName
          objectName: path.objectName
      - text: Add field {Field} as a new complex field to {objectName}'s {complexFieldMetadataName}.
        slots:
          Field: requestBody.Field
          objectName: path.objectName
          complexFieldMetadataName: path.complexFieldMetadataName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/complex-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create complex field metadata
      effect: write
      questions:
      - How do I define new complex field metadata for an object?
      - What do I send to register a new complex field metadata name with its fields?
      instructions:
      - text: Create complex field metadata named {Name} on object {objectName}.
        slots:
          Name: requestBody.Name
          objectName: path.objectName
      - text: Define new complex field metadata for {objectName} with fields {Fields}.
        slots:
          objectName: path.objectName
          Fields: requestBody.Fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/complex-fields/{complexFieldMetadataName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several complex fields at once
      effect: write
      questions:
      - Can I create multiple complex fields under the same metadata in one request?
      - How do I bulk-add complex fields to an existing metadata definition?
      instructions:
      - text: Create multiple complex fields under {complexFieldMetadataName} on {objectName}.
        slots:
          complexFieldMetadataName: path.complexFieldMetadataName
          objectName: path.objectName
      - text: Bulk-add complex fields {Fields} to metadata {complexFieldMetadataName} of {objectName}.
        slots:
          Fields: requestBody.Fields
          complexFieldMetadataName: path.complexFieldMetadataName
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'