API Evangelist conversational phrasing for Schema Manager Object Definition API

# 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 Object Definition API
  version: 1.0.0
extends: openapi/conga-object-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: 8
- target: $.paths['/api/schema/v1/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List object names
      effect: read
      questions:
      - Which objects exist in the schema?
      - Can I find objects whose names start with certain letters?
      instructions:
      - text: List all object names.
      - text: List objects starting with {prefix}.
        slots:
          prefix: query.startsWithFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new object
      effect: write
      questions:
      - How do I create a new custom object?
      - Can I define fields and picklists when creating an object?
      instructions:
      - text: Define a new object {name} labeled {label}.
        slots:
          name: requestBody.Name
          label: requestBody.DisplayName
      - text: Create object {name} with fields {fields}.
        slots:
          name: requestBody.Name
          fields: requestBody.FieldMetadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/customschema/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a custom schema
      effect: write
      questions:
      - Can I import a custom schema from a file?
      - How do I load object definitions in bulk?
      instructions:
      - text: Import custom schema from {file}.
        slots:
          file: requestBody.file
      - text: Load the custom schema file {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{lookupObjectName}/lookup-criteria/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate lookup criteria
      effect: read
      questions:
      - Is my lookup filter criteria valid for an object?
      - Can I test lookup criteria before saving a field?
      instructions:
      - text: Validate lookup criteria against object {object}.
        slots:
          object: path.lookupObjectName
      - text: Check lookup filter criteria on {object}.
        slots:
          object: path.lookupObjectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a translated object definition
      effect: read
      questions:
      - Can I see an object's schema translated into another locale?
      - What does an object definition look like in French?
      instructions:
      - text: Get the schema of {object} translated to {locale}.
        slots:
          object: path.objectName
          locale: query.locale
      - text: Show the translated definition of object {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object definition
      effect: write
      questions:
      - How do I rename an object's display label?
      - Can I turn on the recycle bin for an object?
      instructions:
      - text: Update object {object} with display name {label}.
        slots:
          object: path.objectName
          label: requestBody.DisplayName
      - text: Enable field tracking {tracking} on object {object}.
        slots:
          tracking: requestBody.IsTrackingEnabled
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/deprecate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Deprecate an object
      effect: write
      questions:
      - Can I mark an object as deprecated?
      - How do I phase out an old object?
      instructions:
      - text: Deprecate object {object}.
        slots:
          object: path.objectName
      - text: Mark object {object} as deprecated.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/v1/objects/{objectName}/shared/{isShared}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an object's shared status
      effect: write
      questions:
      - Can I share an object across apps?
      - How do I stop sharing an object?
      instructions:
      - text: Set object {object} shared status to {shared}.
        slots:
          object: path.objectName
          shared: path.isShared
      - text: Mark {object} as shared {shared}.
        slots:
          object: path.objectName
          shared: path.isShared
      method: generated
      generated: '2026-10-01'