API Evangelist conversational phrasing for Schema Manager Object Metadata 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 Metadata API
  version: 1.0.0
extends: openapi/conga-object-metadata-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/metadata/v1/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List scoped object names
      effect: read
      questions:
      - Which objects are in scope for my metadata?
      - Can I filter scoped objects by a starting prefix?
      instructions:
      - text: List scoped object names.
      - text: Show scoped objects starting with {prefix}.
        slots:
          prefix: query.startsWithFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/customschema/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export the custom schema
      effect: read
      questions:
      - Can I export my custom schema definitions?
      - How do I back up custom object metadata?
      instructions:
      - text: Export the custom schema.
      - text: Download all custom object metadata.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's metadata
      effect: read
      questions:
      - What fields and settings does an object have?
      - Can I get an object's metadata in a given locale?
      instructions:
      - text: Get the metadata of object {object}.
        slots:
          object: path.objectName
      - text: Show {object} metadata in locale {locale}.
        slots:
          object: path.objectName
          locale: query.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}/dependencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's dependencies
      effect: read
      questions:
      - What depends on a given object?
      - Can I check dependencies before changing an object?
      instructions:
      - text: List dependencies of object {object}.
        slots:
          object: path.objectName
      - text: Show what relies on {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}/fields/{fieldName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get field metadata
      effect: read
      questions:
      - What type and settings does a field have?
      - Can I see one field's metadata?
      instructions:
      - text: Get metadata for field {field} on {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      - text: Show the definition of {object}.{field}.
        slots:
          object: path.objectName
          field: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}/fields/{fieldName}/dependency-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a field's dependencies
      effect: read
      questions:
      - Which other fields depend on a field?
      - Can I check field dependencies before deleting it?
      instructions:
      - text: List fields that depend on {field} of {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      - text: Show dependency fields for {object}.{field}.
        slots:
          object: path.objectName
          field: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dependent picklist definition
      effect: read
      questions:
      - How is a dependent picklist wired to its controlling field?
      - What values does a dependent picklist allow?
      instructions:
      - text: Get the dependent picklist definition for {field} on {object}.
        slots:
          field: path.fieldName
          object: path.objectName
      - text: Show dependent picklist values of {object}.{field}.
        slots:
          object: path.objectName
          field: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/v1/objects/{objectName}/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's references
      effect: read
      questions:
      - Which objects reference a given object?
      - Can I see all lookups pointing at an object?
      instructions:
      - text: List references to object {object}.
        slots:
          object: path.objectName
      - text: Show lookups that point at {object}.
        slots:
          object: path.objectName
      method: generated
      generated: '2026-10-01'